@rollup/plugin-node-resolve 7.0.0 → 7.1.3

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @rollup/plugin-node-resolve ChangeLog
 
+## v7.1.3
+
+_2020-04-12_
+
+### Bugfixes
+
+- fix: resolve symlinked entry point properly (#291)
+
+## v7.1.2
+
+_2020-04-12_
+
+### Updates
+
+- docs: fix url (#289)
+
+## 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_

package/README.md

@@ -44,118 +44,106 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma
 
 ## Options
 
-### `mainFields`
+### `browser`
 
-Type: `Array[...String]`<br>
-Default: `['module', 'main']`<br>
-Valid values: `['browser', 'jsnext', 'module', 'main']`
+Type: `Boolean`<br>
+Default: `false`
 
-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.
+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`
 
-DEPRECATED: use "mainFields" instead
+Type: `Object`<br>
+Default: `null`
 
-Use `pkg.module` field for ES6 module if possible. This option takes precedence over both "jsnext" and "main" in the list if such are present.
+An `Object` that specifies additional options that should be passed through to [`resolve`](https://www.npmjs.com/package/resolve).
 
-### `jsnext`
+```
+customResolveOptions: {
+  moduleDirectory: 'js_modules'
+}
+```
 
-DEPRECATED: use "mainFields" instead
+### `dedupe`
 
-Use `pkg['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. This option takes precedence over "main" in the list if such is present.
+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.
 
-DEPRECATED: use "mainFields" instead
+```js
+dedupe: ['my-package', '@namespace/my-package'];
+```
 
-Use `pkg.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:
 
-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`.
+```js
+import 'my-package/foo.js';
+import '@namespace/my-package/bar.js';
+```
 
 ### `extensions`
 
 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.
-
-### `only`
+Locks the module search within specified path (e.g. chroot). Modules defined outside this path will be marked as external.
 
-Type: `Array[...String|RegExp]`<br>
-Default: `null`
-
-Example: `only: ['some_module', /^@some_scope\/.*$/]`
-
-### `modulesOnly`
+### `mainFields`
 
-Type: `Boolean`<br>
-Default: `false`
+Type: `Array[...String]`<br>
+Default: `['module', 'main']`<br>
+Valid values: `['browser', 'jsnext', 'module', 'main']`
 
-If true, inspect resolved files to check that they are ES2015 modules.
+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.
 
-### `dedupe`
+### `only`
 
-Type: `Array[...String]`<br>
-Default: `[]`
+DEPRECATED: use "resolveOnly" instead
 
-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.
+### `preferBuiltins`
 
-```
-dedupe: [ 'my-package', '@namespace/my-package' ]
-```
+Type: `Boolean`<br>
+Default: `true`
 
-This will deduplicate bare imports such as:
+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.
 
-```js
-import 'my-package';
-import '@namespace/my-package';
-```
+### `modulesOnly`
 
-And it will deduplicate deep imports such as:
+Type: `Boolean`<br>
+Default: `false`
 
-```js
-import 'my-package/foo.js';
-import '@namespace/my-package/bar.js';
-```
+If `true`, inspect resolved files to assert that they are ES2015 modules.
 
-### `customResolveOptions`
+### `resolveOnly`
 
-Type: `Boolean`<br>
+Type: `Array[...String|RegExp]`<br>
 Default: `null`
 
-Any additional options that should be passed through to node-resolve.
+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._
 
-```
-customResolveOptions: {
-  moduleDirectory: 'js_modules'
-}
-```
+Example: `resolveOnly: ['batman', /^@batcave\/.*$/]`
 
 ### `rootDir`
 
 Type: `String`<br>
 Default: `process.cwd()`
 
-Root directory to resolve modules from. Used when resolving entrypoint imports, and when resolving deduplicated modules. Useful when executing rollup in a package of a monorepository.
+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.
 
 ```
 // Set the root directory to be the parent folder
@@ -164,7 +152,7 @@ rootDir: path.join(process.cwd(), '..')
 
 ## 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/plugins/packages/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/tree/master/packages/commonjs):
 
 ```js
 // rollup.config.js
@@ -184,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: