Skip to content

Commit

Permalink
docs: backslash line breaks
Browse files Browse the repository at this point in the history
  • Loading branch information
NotWoods committed Dec 23, 2019
1 parent a695579 commit de21ad9
Show file tree
Hide file tree
Showing 19 changed files with 77 additions and 77 deletions.
4 changes: 2 additions & 2 deletions packages/alias/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

### `customResolver`

Type: `Function | Object`<br>
Type: `Function | Object`\
Default: `null`

Instructs the plugin to use an alternative resolving algorithm, rather than the Rollup's resolver. Please refer to the [Rollup documentation](https://rollupjs.org/guide/en/#hooks) for more information about the `resolveId` hook. For a detailed example, see: [Custom Resolvers](#custom-resolvers).

### `entries`

Type: `Object | Array[Object]`<br>
Type: `Object | Array[Object]`\
Default: `null`

Specifies an `Object`, or an `Array` of `Object`, which defines aliases used to replace values in `import` or `require` statements. With either format, the order of the entries is important, in that the first defined rules are applied first. This option also supports [Regular Expression Alias](#regular-expression-aliases) matching.
Expand Down
4 changes: 2 additions & 2 deletions packages/auto-install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

### `pkgFile`

Type: `String`<br>
Type: `String`\
Default: `'{cwd}/package.json'`

Specifies the location on disk of the target `package.json` file. If the file doesn't exist, it will be created by the plugin, as package managers need to populate the `dependencies` property.

### `manager`

Type: `String`<br>
Type: `String`\
Default: `see below`

Specifies the package manager to use; `npm` or `yarn`. If not specified, the plugin will default to `yarn` if `yarn.lock` exists, or `npm` otherwise.
Expand Down
6 changes: 3 additions & 3 deletions packages/buble/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,21 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

### `transforms`

Type: `Object`
Type: `Object`\
Default: `{ modules: false }`

Specifies additional [transform options](https://buble.surge.sh/guide/) for the Bublé compiler

### `exclude`

Type: `String` | `Array[...String]`
Type: `String` | `Array[...String]`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.

### `include`

Type: `String` | `Array(String)`
Type: `String` | `Array(String)`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.
Expand Down
14 changes: 7 additions & 7 deletions packages/commonjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,42 +46,42 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

### `exclude`

Type: `String` | `Array[...String]`
Type: `String` | `Array[...String]`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default non-CommonJS modules are ignored.

### `include`

Type: `String` | `Array(String)` \
Type: `String` | `Array(String)`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default CommonJS modules are targeted.

### `extensions`

Type: `Array(String)` \
Type: `Array(String)`\
Default: `['.js']`

Search for extensions other than .js in the order specified.

### `ignoreGlobal`

Type: `Boolean` \
Type: `Boolean`\
Default: `false`

If true, uses of `global` won't be dealt with by this plugin.

### `sourceMap`

Type: `Boolean` \
Type: `Boolean`\
Default: `true`

If false, skips source map generation for CommonJS modules.

### `namedExports`

Type: `Object` \
Type: `Object`\
Default: `null`

Explicitly specify unresolvable named exports.
Expand Down Expand Up @@ -122,7 +122,7 @@ commonjs({

### `ignore`

Type: `Array(String | (String) => Boolean)` \
Type: `Array(String | (String) => Boolean)`\
Default: `[]`

Sometimes you have to leave require statements unconverted. Pass an array containing the IDs or an `id => boolean` function. Only use this option if you know what you're doing!
Expand Down
2 changes: 1 addition & 1 deletion packages/dsv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ console.log(fruit);

### `processRow`

Type: `Function`<br>
Type: `Function`\
Default: `null`

Specifies a function which processes each row in the parsed array. The function can either manipulate the passed `row`, or return an entirely new row object.
Expand Down
12 changes: 6 additions & 6 deletions packages/html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Once run successfully, an HTML file should be written to the bundle output desti

### `attributes`

Type: `Object`<br>
Type: `Object`\
Default: `{ html: { lang: 'en' }, link: null, script: null }`

Specifies additional attributes for `html`, `link`, and `script` elements. For each property, provide an object with key-value pairs that represent an HTML element attribute name and value. By default, the `html` element is rendered with an attribute of `lang="en"`.
Expand All @@ -59,21 +59,21 @@ _Note: If using the `es` / `esm` output format, `{ type: 'module'}` is automatic

### `fileName`

Type: `String`<br>
Type: `String`\
Default: `'index.html'`

Specifies the name of the HTML to emit.

### `publicPath`

Type: `String`<br>
Type: `String`\
Default: `''`

Specifies a path to prepend to all bundle assets (files) in the HTML output.

### `template`

Type: `Function`<br>
Type: `Function`\
Default: `internal function`
Returns: `String`

Expand Down Expand Up @@ -109,7 +109,7 @@ Where `${links}` represents all `<link ..` tags for CSS and `${scripts}` represe

### `title`

Type: `String`<br>
Type: `String`\
Default: `'Rollup Bundle'`

Specifies the HTML document title.
Expand All @@ -118,7 +118,7 @@ Specifies the HTML document title.

### `makeHtmlAttributes(attributes)`

Parameters: `attributes`, Type: `Object`<br>
Parameters: `attributes`, Type: `Object`\
Returns: `String`

Consumes an object with key-value pairs that represent an HTML element attribute name and value. The function returns all pairs as a space-separated string of valid HTML element attributes. e.g.
Expand Down
6 changes: 3 additions & 3 deletions packages/image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Once the bundle is executed, the `console.log` will display the Base64 encoded r

### `dom`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

If `true`, instructs the plugin to generate an ES Module which exports a DOM `Image` which can be used with a browser's DOM. Otherwise, the plugin generates an ES Module which exports a `default const` containing the Base64 representation of the image.
Expand All @@ -72,14 +72,14 @@ document.body.appendChild(logo);

### `exclude`

Type: `String` | `Array[...String]`<br>
Type: `String` | `Array[...String]`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.

### `include`

Type: `String` | `Array(String)`<br>
Type: `String` | `Array(String)`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.
Expand Down
4 changes: 2 additions & 2 deletions packages/inject/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ In addition to the properties and values specified for injecting, users may also

### `exclude`

Type: `String` | `Array[...String]`
Type: `String` | `Array[...String]`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.

### `include`

Type: `String` | `Array(String)`
Type: `String` | `Array(String)`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.
Expand Down
12 changes: 6 additions & 6 deletions packages/json/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,42 +54,42 @@ console.log(`running version ${pkg.version}`);

### `compact`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

If `true`, instructs the plugin to ignore `indent` and generates the smallest code.

### `exclude`

Type: `String` | `Array[...String]`<br>
Type: `String` | `Array[...String]`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.

### `include`

Type: `String` | `Array(String)`<br>
Type: `String` | `Array(String)`\
Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.

### `indent`

Type: `String`<br>
Type: `String`\
Default: `'\t'`

Specifies the indentation for the generated default export.

### `namedExports`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `true`

If `true`, instructs the plugin to generate a named export for every property of the JSON object.

### `preferConst`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

If `true`, instructs the plugin to declare properties as variables, using either `var` or `const`. This pertains to tree-shaking.
Expand Down
2 changes: 1 addition & 1 deletion packages/legacy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

## Options

Type: `Object`<br>
Type: `Object`\
Default: `null`

Specifies an `Object` which defines exports used when importing corresponding scripts. The `Object` allows specifying script paths as a key, and the corresponding value as the `export`s for that script. For example:
Expand Down
2 changes: 1 addition & 1 deletion packages/multi-entry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Using all three files above as entry points will yield a bundle with exports for

### `exports`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `true`

If `true`, instructs the plugin to export named exports to the bundle from all entries. If `false`, the plugin will not export any entry exports to the bundle. This can be useful when wanting to combine code from multiple entry files, but not necessarily to export each entry file's exports.
Expand Down
24 changes: 12 additions & 12 deletions packages/node-resolve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,80 +46,80 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma

### `mainFields`

Type: `Array[String]`<br>
Type: `Array[String]`\
Default: `['module', 'main']`

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

### `module`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `true`

DEPRECATED: use "mainFields" instead
Use "module" field for ES6 module if possible

### `jsnext`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

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

### `main`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `true`

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

### `browser`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

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

### `extensions`

Type: `Array[String]`<br>
Type: `Array[String]`\
Default: `['.mjs', '.js', '.json', '.node']`

Resolve extensions other than .js in the order specified.

### `preferBuiltins`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `true`

Whether to prefer built-in modules (e.g. `fs`, `path`) or local ones with the same names

### `jail`

Type: `String`<br>
Type: `String`\
Default: `'/'`

Lock the module search in this path (like a chroot). Modules defined outside this path will be marked as external.

### `only`

Type: `Array[String|RegExp]`<br>
Type: `Array[String|RegExp]`\
Default: `null`

Example: `only: ['some_module', /^@some_scope\/.*$/]`

### `modulesOnly`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `false`

If true, inspect resolved files to check that they are ES2015 modules.

### `dedupe`

Type: `Array[String]`<br>
Type: `Array[String]`\
Default: `[]`

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.
Expand All @@ -130,7 +130,7 @@ dedupe: [ 'react', 'react-dom' ]

### `customResolveOptions`

Type: `Boolean`<br>
Type: `Boolean`\
Default: `null`

Any additional options that should be passed through to node-resolve.
Expand Down
Loading

0 comments on commit de21ad9

Please sign in to comment.