Skip to content

Commit 1a44ca7

Browse files
committed
docs: move eslint.config.js before .eslintrc
1 parent 7a99d8a commit 1a44ca7

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,6 @@ pnpm add -D @susisu/eslint-plugin-safe-typescript
2626
2. Add `@susisu/eslint-plugin-safe-typescript` to plugins
2727
3. (Optional) Add `parserOptions.project` if you enable rules that use type information.
2828

29-
`.eslintrc`:
30-
31-
``` json
32-
{
33-
"parser": "@typescript-eslint/parser", // (1)
34-
"parserOptions": {
35-
"project": true // (3)
36-
},
37-
"plugins": ["@susisu/safe-typescript"], // (2)
38-
"rules": {
39-
"@susisu/safe-typescript/no-object-assign": "error"
40-
}
41-
}
42-
```
43-
4429
`eslint.config.js`:
4530

4631
``` js
@@ -65,20 +50,27 @@ export default [
6550
];
6651
```
6752

68-
## Recommended configuration
69-
70-
This plugin also provides a configuration set for the recommended rules (see [Rules](#rules) for which rules are recommended).
71-
72-
Since some rules in the recommended configuration require type information, `parserOptions.project` must be set in your config.
73-
74-
`eslintrc`
53+
`.eslintrc`:
7554

7655
``` json
7756
{
78-
"extends": ["plugin:@susisu/safe-typescript/recommended"]
57+
"parser": "@typescript-eslint/parser", // (1)
58+
"parserOptions": {
59+
"project": true // (3)
60+
},
61+
"plugins": ["@susisu/safe-typescript"], // (2)
62+
"rules": {
63+
"@susisu/safe-typescript/no-object-assign": "error"
64+
}
7965
}
8066
```
8167

68+
## Recommended configuration
69+
70+
This plugin also provides a configuration set for the recommended rules (see [Rules](#rules) for which rules are recommended).
71+
72+
Since some rules in the recommended configuration require type information, `parserOptions.project` must be set in your config.
73+
8274
`eslint.config.js`
8375

8476
``` js
@@ -93,6 +85,14 @@ export default [
9385
];
9486
```
9587

88+
`eslintrc`
89+
90+
``` json
91+
{
92+
"extends": ["plugin:@susisu/safe-typescript/recommended"]
93+
}
94+
```
95+
9696
## Rules
9797

9898
✅ = recommended, 🔧 = fixable, 💭 = requires type information

0 commit comments

Comments
 (0)