@shakuroinc/eslint-config-react 6.0.0 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,32 @@
|
|
|
1
1
|
# @shakuroinc/eslint-config-react
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[Shakuro](https://shakuro.com/) eslint and prettier extensible basic config.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### Install package:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
`yarn add -D @shakuroinc/eslint-config-react`
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
### Install package dependencies:
|
|
12
12
|
|
|
13
|
-
-
|
|
13
|
+
`npx install-peerdeps @shakuroinc/eslint-config-react -d -Y`
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
> if you using yarn workspaces `npx install-peerdeps @shakuroinc/eslint-config-react -d -Y --extra-args "--ignore-workspace-root-check"`
|
|
16
|
+
|
|
17
|
+
### Configure `eslint`:
|
|
18
|
+
|
|
19
|
+
```js
|
|
20
|
+
// .eslintrc.js
|
|
21
|
+
module.exports = {
|
|
22
|
+
extends: ['@shakuroinc/eslint-config-react'],
|
|
23
|
+
// extend config if needed
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Configure prettier:
|
|
28
|
+
|
|
29
|
+
```js
|
|
30
|
+
// .prettierrc.js
|
|
31
|
+
module.exports = { ...require('@shakuroinc/eslint-config-react/prettier.config') };
|
|
32
|
+
```
|