Skip to content

Commit

Permalink
docs(eslint): fix paths in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robinloeffel committed Nov 29, 2020
1 parent 159876d commit 5638e1f
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions packages/eslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@ yarn add @rollup/plugin-eslint --dev
import eslint from '@rollup/plugin-eslint';

export default {
input: 'main.js',

This comment has been minimized.

Copy link
@shellscape

shellscape Nov 29, 2020

Collaborator

🚨🚨🚨 Never commit directly to master. Contribs and maintainers must always go through PRs.

This comment has been minimized.

Copy link
@robinloeffel

robinloeffel Nov 29, 2020

Author Member

Didn't know that, sorry! Will do so in the future!

This comment has been minimized.

Copy link
@robinloeffel

This comment has been minimized.

Copy link
@robinloeffel

robinloeffel Nov 29, 2020

Author Member

Should I revert my changes on master?

This comment has been minimized.

Copy link
@shellscape

shellscape Nov 29, 2020

Collaborator

Probably not needed, but I'll take a look later today when I'm back in front of my laptop. There was a CI failure so I'm curious what happened.

This comment has been minimized.

Copy link
@robinloeffel

robinloeffel Nov 29, 2020

Author Member

I suppose the error happens because I haven't adapted the tests yet.

This comment has been minimized.

Copy link
@tjenkinson

tjenkinson Nov 29, 2020

Member

You could set it up as a protected branch with one required review to protect against this :)

This comment has been minimized.

Copy link
@robinloeffel

robinloeffel Nov 29, 2020

Author Member

@tjenkinson Good idea! I actually thought of the same thing!

This comment has been minimized.

Copy link
@shellscape

shellscape Nov 29, 2020

Collaborator

I'm aware of the settings. Thus far we haven't needed them.

input: 'src',
plugins: [
eslint({
/* your options */
/* options */
}),
],
output: {
/* ... */
},
};
```

Expand Down Expand Up @@ -60,23 +63,23 @@ Controls what type of files ESLint should look at. The default of `null` is equa

Type: `boolean`<br>
Default: `false`<br>
Utilized by: [The plugin itself](https://github.com/robinloeffel/rollup-plugin-eslint/blob/master/src/index.js#L34)
Utilized by: [The plugin itself](src/index.ts#l40)

Controls whether or not to throw an error and exit the process when ESLint reports any warnings.

### `throwOnError`

Type: `boolean`<br>
Default: `false`<br>
Utilized by: [The plugin itself](https://github.com/robinloeffel/rollup-plugin-eslint/blob/master/src/index.js#L38)
Utilized by: [The plugin itself](src/index.ts#l46)

Controls whether or not to throw an error and exit the process when ESLint reports any errors.

### `formatter`

Type: `string`<br>
Default: `'stylish'`<br>
Utilized by: [The plugin itself](https://github.com/robinloeffel/rollup-plugin-eslint/blob/master/src/index.js#L38)
Utilized by: [The plugin itself](src/index.ts#l32)

The name of a (built-in) formatter or the path to a custom formatter.

Expand Down

0 comments on commit 5638e1f

Please sign in to comment.