update

node_modules/resolve/readme.markdown

@@ -1,18 +1,22 @@
-# resolve
+# resolve <sup>[![Version Badge][2]][1]</sup>
 
-implements the [node `require.resolve()`
-algorithm](https://nodejs.org/api/modules.html#modules_all_together)
-such that you can `require.resolve()` on behalf of a file asynchronously and
-synchronously
+implements the [node `require.resolve()` algorithm](https://nodejs.org/api/modules.html#modules_all_together) such that you can `require.resolve()` on behalf of a file asynchronously and synchronously
 
-[![build status](https://secure.travis-ci.org/browserify/resolve.png)](http://travis-ci.org/browserify/resolve)
+[![github actions][actions-image]][actions-url]
+[![coverage][codecov-image]][codecov-url]
+[![dependency status][5]][6]
+[![dev dependency status][7]][8]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][11]][1]
 
 # example
 
 asynchronously resolve:
 
 ```js
-var resolve = require('resolve');
+var resolve = require('resolve/async'); // or, require('resolve')
 resolve('tap', { basedir: __dirname }, function (err, res) {
     if (err) console.error(err);
     else console.log(res);
@@ -27,8 +31,8 @@ $ node example/async.js
 synchronously resolve:
 
 ```js
-var resolve = require('resolve');
-var res = resolve.sync('tap', { basedir: __dirname });
+var resolve = require('resolve/sync'); // or, `require('resolve').sync
+var res = resolve('tap', { basedir: __dirname });
 console.log(res);
 ```
 
@@ -41,8 +45,16 @@ $ node example/sync.js
 
 ```js
 var resolve = require('resolve');
+var async = require('resolve/async');
+var sync = require('resolve/sync');
 ```
 
+For both the synchronous and asynchronous methods, errors may have any of the following `err.code` values:
+
+- `MODULE_NOT_FOUND`: the given path string (`id`) could not be resolved to a module
+- `INVALID_BASEDIR`: the specified `opts.basedir` doesn't exist, or is not a directory
+- `INVALID_PACKAGE_MAIN`: a `package.json` was encountered with an invalid `main` property (eg. not a string)
+
 ## resolve(id, opts={}, cb)
 
 Asynchronously resolve the module path string `id` into `cb(err, res [, pkg])`, where `pkg` (if defined) is the data from `package.json`.
@@ -55,18 +67,25 @@ options are:
 
 * opts.extensions - array of file extensions to search in order
 
+* opts.includeCoreModules - set to `false` to exclude node core modules (e.g. `fs`) from the search
+
 * opts.readFile - how to read files asynchronously
 
 * opts.isFile - function to asynchronously test whether a file exists
 
-* opts.isDirectory - function to asynchronously test whether a directory exists
+* opts.isDirectory - function to asynchronously test whether a file exists and is a directory
 
 * opts.realpath - function to asynchronously resolve a potential symlink to its real path
 
+* `opts.readPackage(readFile, pkgfile, cb)` - function to asynchronously read and parse a package.json file
+  * readFile - the passed `opts.readFile` or `fs.readFile` if not specified
+  * pkgfile - path to package.json
+  * cb - callback
+
 * `opts.packageFilter(pkg, pkgfile, dir)` - transform the parsed package.json contents before looking at the "main" field
   * pkg - package data
   * pkgfile - path to package.json
-  * dir - directory for package.json
+  * dir - directory that contains package.json
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data
@@ -102,6 +121,7 @@ default `opts` values:
     paths: [],
     basedir: __dirname,
     extensions: ['.js'],
+    includeCoreModules: true,
     readFile: fs.readFile,
     isFile: function isFile(file, cb) {
         fs.stat(file, function (err, stat) {
@@ -122,12 +142,25 @@ default `opts` values:
         });
     },
     realpath: function realpath(file, cb) {
-       var realpath = typeof fs.realpath.native === 'function' ? fs.realpath.native : fs.realpath;
-       realpath(file, function (realPathErr, realPath) {
-           if (realPathErr && realPathErr.code !== 'ENOENT') cb(realPathErr);
-           else cb(null, realPathErr ? file : realPath);
-       });
-   },
+        var realpath = typeof fs.realpath.native === 'function' ? fs.realpath.native : fs.realpath;
+        realpath(file, function (realPathErr, realPath) {
+            if (realPathErr && realPathErr.code !== 'ENOENT') cb(realPathErr);
+            else cb(null, realPathErr ? file : realPath);
+        });
+    },
+    readPackage: function defaultReadPackage(readFile, pkgfile, cb) {
+        readFile(pkgfile, function (readFileErr, body) {
+            if (readFileErr) cb(readFileErr);
+            else {
+                try {
+                    var pkg = JSON.parse(body);
+                    cb(null, pkg);
+                } catch (jsonErr) {
+                    cb(null);
+                }
+            }
+        });
+    },
     moduleDirectory: 'node_modules',
     preserveSymlinks: true
 }
@@ -144,17 +177,23 @@ options are:
 
 * opts.extensions - array of file extensions to search in order
 
-* opts.readFile - how to read files synchronously
+* opts.includeCoreModules - set to `false` to exclude node core modules (e.g. `fs`) from the search
+
+* opts.readFileSync - how to read files synchronously
 
 * opts.isFile - function to synchronously test whether a file exists
 
-* opts.isDirectory - function to synchronously test whether a directory exists
+* opts.isDirectory - function to synchronously test whether a file exists and is a directory
 
 * opts.realpathSync - function to synchronously resolve a potential symlink to its real path
 
+* `opts.readPackageSync(readFileSync, pkgfile)` - function to synchronously read and parse a package.json file
+  * readFileSync - the passed `opts.readFileSync` or `fs.readFileSync` if not specified
+  * pkgfile - path to package.json
+
 * `opts.packageFilter(pkg, dir)` - transform the parsed package.json contents before looking at the "main" field
   * pkg - package data
-  * dir - directory for package.json (Note: the second argument will change to "pkgfile" in v2)
+  * dir - directory that contains package.json (Note: the second argument will change to "pkgfile" in v2)
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data
@@ -190,6 +229,7 @@ default `opts` values:
     paths: [],
     basedir: __dirname,
     extensions: ['.js'],
+    includeCoreModules: true,
     readFileSync: fs.readFileSync,
     isFile: function isFile(file) {
         try {
@@ -220,15 +260,18 @@ default `opts` values:
         }
         return file;
     },
+    readPackageSync: function defaultReadPackageSync(readFileSync, pkgfile) {
+        var body = readFileSync(pkgfile);
+        try {
+            var pkg = JSON.parse(body);
+            return pkg;
+        } catch (jsonErr) {}
+    },
     moduleDirectory: 'node_modules',
     preserveSymlinks: true
 }
 ```
 
-## resolve.isCore(pkg)
-
-Return whether a package is in core.
-
 # install
 
 With [npm](https://npmjs.org) do:
@@ -240,3 +283,19 @@ npm install resolve
 # license
 
 MIT
+
+[1]: https://npmjs.org/package/resolve
+[2]: https://versionbadg.es/browserify/resolve.svg
+[5]: https://david-dm.org/browserify/resolve.svg
+[6]: https://david-dm.org/browserify/resolve
+[7]: https://david-dm.org/browserify/resolve/dev-status.svg
+[8]: https://david-dm.org/browserify/resolve#info=devDependencies
+[11]: https://nodei.co/npm/resolve.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/resolve.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/resolve.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=resolve
+[codecov-image]: https://codecov.io/gh/browserify/resolve/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/browserify/resolve/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/browserify/resolve
+[actions-url]: https://github.com/browserify/resolve/actions