Skip to content

Commit c6e20ca

Browse files
committed
updated README
1 parent 6a68fa0 commit c6e20ca

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Prettier Eslint Webpack Plugin
22

3-
Webpack plugin for [prettier-eslint](https://github.com/kentcdodds/prettier-eslint) which ESLint's settings is set to [JavaScript Standard Style](http://standardjs.com/)
3+
Webpack 2.* plugin for [prettier-eslint](https://github.com/kentcdodds/prettier-eslint) which ESLint's settings is set to [JavaScript Standard Style](http://standardjs.com/)
44

55
## Install
66
```
@@ -12,8 +12,10 @@ yarn add prettier-eslint-webpack-plugin
1212

1313
| *key* | *type* | *description* | *default* |
1414
|------------|-----------------|----------------------------------------------|-----------------|
15-
| encoding | ?String | Encoding to use when reading / writing files | 'utf-8' |
16-
| extensions | ?Array | Only process these file extensions | ['.js', '.jsx'] |
15+
| encoding | string | Encoding to use when reading / writing files | 'utf-8' |
16+
| extensions | array | Only process these file extensions | ['.js', '.jsx'] |
17+
18+
Furthermore the entire [prettier-eslint](https://github.com/kentcdodds/prettier-eslint#options) API is exposed in the exact same way.
1719

1820
### Example
1921

@@ -34,7 +36,11 @@ module.exports = {
3436
new PrettierEslintPlugin({
3537
encoding: 'utf-16',
3638
extensions: '.jsf00',
37-
eslintConfig: eslintConfig
39+
eslintConfig: eslintConfig,
40+
logLevel: 'trace',
41+
prettierOptions: {
42+
singleQuote: false,
43+
}
3844
})
3945
...
4046
}
@@ -46,8 +52,7 @@ module.exports = {
4652
Welcome
4753

4854
## Roadmap:
49-
* Tests
50-
* Add support for Flow
55+
* Add Flow type support
5156

5257
### Inspiration
5358
* [prettier-eslint](https://github.com/kentcdodds/prettier-eslint)

0 commit comments

Comments
 (0)