Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: <br> line breaks #107

Merged
merged 1 commit into from
Dec 25, 2019
Merged

docs: <br> line breaks #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/buble/README.md
View file
Open in desktop
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`<br>
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]`<br>
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)`<br>
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
View file
Open in desktop
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]`<br>
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)`<br>
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)`<br>
Default: `['.js']`

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

### `ignoreGlobal`

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

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

### `sourceMap`

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

If false, skips source map generation for CommonJS modules.

### `namedExports`

Type: `Object` \
Type: `Object`<br>
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)`<br>
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
4 changes: 2 additions & 2 deletions packages/inject/README.md
View file
Open in desktop
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]`<br>
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)`<br>
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
6 changes: 3 additions & 3 deletions packages/replace/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,21 @@ In addition to the properties and values specified for replacement, users may al

### `delimiters`

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

Specifies the boundaries around which strings will be replaced. By default, delimiters are [word boundaries](https://www.regular-expressions.info/wordboundaries.html). See [Word Boundaries](#word-boundaries) below for more information.

### `exclude`

Type: `String` | `Array[...String]`
Type: `String` | `Array[...String]`<br>
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)`<br>
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
10 changes: 5 additions & 5 deletions packages/typescript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,28 +67,28 @@ The following options are unique to `rollup-plugin-typescript`:

### `exclude`

Type: `String` | `Array[...String]`
Type: `String` | `Array[...String]`<br>
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)`<br>
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 `.ts` and `.tsx` files are targeted.

### `tsconfig`

Type: `String` | `Boolean`
Type: `String` | `Boolean`<br>
Default: `true`

When set to false, ignores any options specified in the config file. If set to a string that corresponds to a file path, the specified file will be used as config file.

### `typescript`

Type: `import('typescript')`
Type: `import('typescript')`<br>
Default: _peer dependency_

Overrides the TypeScript module used for transpilation.
Expand All @@ -101,7 +101,7 @@ typescript({

### `tslib`

Type: `import('tslib')`
Type: `import('tslib')`<br>
Default: _peer dependency_

Overrides the injected TypeScript helpers with a custom version
Expand Down