@rollup/plugin-node-resolve 6.0.0 → 7.1.1

package/CHANGELOG.md

@@ -1,10 +1,50 @@
-# @rollup/plugin-node-resolve Change Log
+# @rollup/plugin-node-resolve ChangeLog
+
+## v7.1.1
+
+_2020-02-03_
+
+### Bugfixes
+
+- fix: main fields regression (#196)
+
+## v7.1.0
+
+_2020-02-01_
+
+### Updates
+
+- refactor: clean codebase and fix external warnings (#155)
+
+## v7.0.0
+
+_2020-01-07_
+
+### Breaking Changes
+
+- feat: dedupe by package name (#99)
+
+## v6.1.0
+
+_2020-01-04_
+
+### Bugfixes
+
+- fix: allow deduplicating custom module dirs (#101)
+
+### Features
+
+- feat: add rootDir option (#98)
+
+### Updates
+
+- docs: improve doc related to mainFields (#138)
 
 ## 6.0.0
 
 _2019-11-25_
 
-- **Breaking:** Minimum compatible Rollup version is 1.2.0
+- **Breaking:** Minimum compatible Rollup version is 1.20.0
 - **Breaking:** Minimum supported Node version is 8.0.0
 - Published as @rollup/plugin-node-resolve
 

package/README.md

@@ -44,111 +44,120 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma
 
 ## Options
 
-### `mainFields`
+### `browser`
 
-Type: `Array[String]`<br>
-Default: `['module', 'main']`
+Type: `Boolean`<br>
+Default: `false`
 
-The fields to scan in a package.json to determine the entry point if this list contains "browser", overrides specified in "pkg.browser" will be used
+If `true`, instructs the plugin to use the `"browser"` property in `package.json` files to specify alternative files to load for bundling. This is useful when bundling for a browser environment. Alternatively, a value of `'browser'` can be added to the `mainFields` option. If `false`, any `"browser"` properties in package files will be ignored. This option takes precedence over `mainFields`.
 
-### `module`
+### `customResolveOptions`
 
 Type: `Boolean`<br>
-Default: `true`
+Default: `null`
 
-DEPRECATED: use "mainFields" instead
-Use "module" field for ES6 module if possible
+An `Object` that specifies additional options that should be passed through to `node-resolve`.
 
-### `jsnext`
+```
+customResolveOptions: {
+  moduleDirectory: 'js_modules'
+}
+```
 
-Type: `Boolean`<br>
-Default: `false`
+### `dedupe`
 
-DEPRECATED: use "mainFields" instead
-Use "jsnext:main" if possible, legacy field pointing to ES6 module in third-party libraries, deprecated in favor of "pkg.module", see: https://github.com/rollup/rollup/wiki/pkg.module
+Type: `Array[...String]`<br>
+Default: `[]`
 
-### `main`
+An `Array` of modules names, which instructs the plugin to force resolving for the specified modules to the root `node_modules`. Helps to prevent bundling the same package multiple times if package is imported from dependencies.
 
-Type: `Boolean`<br>
-Default: `true`
+```js
+dedupe: ['my-package', '@namespace/my-package'];
+```
 
-DEPRECATED: use "mainFields" instead
-Use "main" field or index.js, even if it's not an ES6 module (needs to be converted from CommonJS to ES6) – see https://github.com/rollup/rollup-plugin-commonjs
+This will deduplicate bare imports such as:
 
-### `browser`
+```js
+import 'my-package';
+import '@namespace/my-package';
+```
 
-Type: `Boolean`<br>
-Default: `false`
+And it will deduplicate deep imports such as:
 
-Some package.json files have a "browser" field which specifies alternative files to load for people bundling for the browser. If that's you, either use this option or add "browser" to the "mainFields" option, otherwise pkg.browser will be ignored
+```js
+import 'my-package/foo.js';
+import '@namespace/my-package/bar.js';
+```
 
 ### `extensions`
 
-Type: `Array[String]`<br>
+Type: `Array[...String]`<br>
 Default: `['.mjs', '.js', '.json', '.node']`
 
-Resolve extensions other than .js in the order specified.
-
-### `preferBuiltins`
-
-Type: `Boolean`<br>
-Default: `true`
-
-Whether to prefer built-in modules (e.g. `fs`, `path`) or local ones with the same names
+Specifies the extensions of files that the plugin will operate on.
 
 ### `jail`
 
 Type: `String`<br>
 Default: `'/'`
 
-Lock the module search in this path (like a chroot). Modules defined outside this path will be marked as external.
+Locks the module search within specified path (e.g. chroot). Modules defined outside this path will be marked as external.
+
+### `mainFields`
+
+Type: `Array[...String]`<br>
+Default: `['module', 'main']`<br>
+Valid values: `['browser', 'jsnext', 'module', 'main']`
+
+Specifies the properties to scan within a `package.json`, used to determine the bundle entry point. The order of property names is significant, as the first-found property is used as the resolved entry point. If the array contains `'browser'`, key/values specified in the `package.json` `browser` property will be used.
 
 ### `only`
 
-Type: `Array[String|RegExp]`<br>
-Default: `null`
+DEPRECATED: use "resolveOnly" instead
 
-Example: `only: ['some_module', /^@some_scope\/.*$/]`
+### `preferBuiltins`
+
+Type: `Boolean`<br>
+Default: `true`
+
+If `true`, the plugin will prefer built-in modules (e.g. `fs`, `path`). If `false`, the plugin will look for locally installed modules of the same name.
 
 ### `modulesOnly`
 
 Type: `Boolean`<br>
 Default: `false`
 
-If true, inspect resolved files to check that they are ES2015 modules.
+If `true`, inspect resolved files to assert that they are ES2015 modules.
 
-### `dedupe`
+### `resolveOnly`
 
-Type: `Array[String]`<br>
-Default: `[]`
+Type: `Array[...String|RegExp]`<br>
+Default: `null`
 
-Force resolving for these modules to root's node_modules that helps to prevent bundling the same package multiple times if package is imported from dependencies.
+An `Array` which instructs the plugin to limit module resolution to those whose names match patterns in the array. _Note: Modules not matching any patterns will be marked as external._
 
-```
-dedupe: [ 'react', 'react-dom' ]
-```
+Example: `resolveOnly: ['batman', /^@batcave\/.*$/]`
 
-### `customResolveOptions`
+### `rootDir`
 
-Type: `Boolean`<br>
-Default: `null`
+Type: `String`<br>
+Default: `process.cwd()`
 
-Any additional options that should be passed through to node-resolve.
+Specifies the root directory from which to resolve modules. Typically used when resolving entry-point imports, and when resolving deduplicated modules. Useful when executing rollup in a package of a mono-repository.
 
 ```
-customResolveOptions: {
-  moduleDirectory: 'js_modules'
-}
+// Set the root directory to be the parent folder
+rootDir: path.join(process.cwd(), '..')
 ```
 
-## Using with rollup-plugin-commonjs
+## Using with @rollup/plugin-commonjs
 
-Since most packages in your node_modules folder are probably legacy CommonJS rather than JavaScript modules, you may need to use [rollup-plugin-commonjs](https://github.com/rollup/rollup-plugin-commonjs):
+Since most packages in your node_modules folder are probably legacy CommonJS rather than JavaScript modules, you may need to use [@rollup/plugin-commonjs](https://github.com/rollup/plugins/packages/commonjs):
 
 ```js
 // rollup.config.js
 import resolve from '@rollup/plugin-node-resolve';
-import commonjs from 'rollup-plugin-commonjs';
+import commonjs from '@rollup/plugin-commonjs';
 
 export default {
   input: 'main.js',
@@ -163,7 +172,7 @@ export default {
 
 ## Resolving Built-Ins (like `fs`)
 
-This plugin won't resolve any builtins (e.g. `fs`). If you need to resolve builtins you can install local modules and set `preferBuiltins` to `false`, or install a plugin like [rollup-plugin-node-builtins](https://github.com/calvinmetcalf/rollup-plugin-node-builtins) which provides stubbed versions of these methods.
+This plugin won't resolve any builtins (e.g. `fs`). If you need to resolve builtins you can install local modules and set `preferBuiltins` to `false`, or install a plugin like [rollup-plugin-node-polyfills](https://github.com/ionic-team/rollup-plugin-node-polyfills) which provides stubbed versions of these methods.
 
 If you want to silence warnings about builtins, you can add the list of builtins to the `externals` option; like so: