@ririd/eslint-config 1.3.3 → 1.3.4
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/LICENSE +21 -21
- package/README.md +143 -143
- package/package.json +9 -9
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2023 Daydreamer-riri
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Daydreamer-riri
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,143 +1,143 @@
|
|
|
1
|
-
# @ririd/eslint-config
|
|
2
|
-
|
|
3
|
-
[](https://npmjs.com/package/@ririd/eslint-config)
|
|
4
|
-
|
|
5
|
-
Riri's ESLint config presets
|
|
6
|
-
|
|
7
|
-
> [!IMPORTANT]
|
|
8
|
-
> This project is heavily based on [antfu/eslint-config](https://github.com/antfu/eslint-config), with a certain degree of customization ~~and more rules regarding React~~.
|
|
9
|
-
>
|
|
10
|
-
> Since v1.0.0, this config is rewritten to the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new).
|
|
11
|
-
|
|
12
|
-
## Usage
|
|
13
|
-
|
|
14
|
-
### Install
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
pnpm i -D eslint @ririd/eslint-config
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
### Create config file
|
|
21
|
-
|
|
22
|
-
With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
|
|
23
|
-
|
|
24
|
-
```js
|
|
25
|
-
// eslint.config.js
|
|
26
|
-
import ririd from '@ririd/eslint-config'
|
|
27
|
-
|
|
28
|
-
export default ririd()
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
With CJS:
|
|
32
|
-
|
|
33
|
-
```js
|
|
34
|
-
// eslint.config.js
|
|
35
|
-
const ririd = require('@ririd/eslint-config').default
|
|
36
|
-
|
|
37
|
-
module.exports = ririd()
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
> Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
|
|
41
|
-
|
|
42
|
-
## VS Code support (auto fix)
|
|
43
|
-
|
|
44
|
-
Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
45
|
-
|
|
46
|
-
Add the following settings to your `.vscode/settings.json`:
|
|
47
|
-
|
|
48
|
-
```jsonc
|
|
49
|
-
{
|
|
50
|
-
// Enable the ESlint flat config support
|
|
51
|
-
"eslint.experimental.useFlatConfig": true,
|
|
52
|
-
|
|
53
|
-
// Disable the default formatter, use eslint instead
|
|
54
|
-
"prettier.enable": false,
|
|
55
|
-
"editor.formatOnSave": false,
|
|
56
|
-
|
|
57
|
-
// Auto fix
|
|
58
|
-
"editor.codeActionsOnSave": {
|
|
59
|
-
"source.fixAll.eslint": "explicit",
|
|
60
|
-
"source.organizeImports": "never"
|
|
61
|
-
},
|
|
62
|
-
|
|
63
|
-
// Silent the stylistic rules in you IDE, but still auto fix them
|
|
64
|
-
"eslint.rules.customizations": [
|
|
65
|
-
{ "rule": "style/*", "severity": "off" },
|
|
66
|
-
{ "rule": "format/*", "severity": "off" },
|
|
67
|
-
{ "rule": "*-indent", "severity": "off" },
|
|
68
|
-
{ "rule": "*-spacing", "severity": "off" },
|
|
69
|
-
{ "rule": "*-spaces", "severity": "off" },
|
|
70
|
-
{ "rule": "*-order", "severity": "off" },
|
|
71
|
-
{ "rule": "*-dangle", "severity": "off" },
|
|
72
|
-
{ "rule": "*-newline", "severity": "off" },
|
|
73
|
-
{ "rule": "*quotes", "severity": "off" },
|
|
74
|
-
{ "rule": "*semi", "severity": "off" }
|
|
75
|
-
],
|
|
76
|
-
|
|
77
|
-
// Enable eslint for all supported languages
|
|
78
|
-
"eslint.validate": [
|
|
79
|
-
"javascript",
|
|
80
|
-
"javascriptreact",
|
|
81
|
-
"typescript",
|
|
82
|
-
"typescriptreact",
|
|
83
|
-
"vue",
|
|
84
|
-
"html",
|
|
85
|
-
"markdown",
|
|
86
|
-
"json",
|
|
87
|
-
"jsonc",
|
|
88
|
-
"yaml",
|
|
89
|
-
"toml"
|
|
90
|
-
]
|
|
91
|
-
}
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
## Customization
|
|
95
|
-
|
|
96
|
-
Normally you only need to import the `ririd` preset:
|
|
97
|
-
|
|
98
|
-
```js
|
|
99
|
-
// eslint.config.js
|
|
100
|
-
import ririd from '@ririd/eslint-config'
|
|
101
|
-
|
|
102
|
-
export default ririd()
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
Or you can configure each integration individually, for example:
|
|
106
|
-
|
|
107
|
-
```js
|
|
108
|
-
// eslint.config.js
|
|
109
|
-
import ririd from '@ririd/eslint-config'
|
|
110
|
-
|
|
111
|
-
export default ririd({
|
|
112
|
-
// Enable stylistic formatting rules
|
|
113
|
-
// stylistic: true,
|
|
114
|
-
|
|
115
|
-
// Or customize the stylistic rules
|
|
116
|
-
stylistic: {
|
|
117
|
-
indent: 2, // 4, or 'tab'
|
|
118
|
-
quotes: 'single', // or 'double'
|
|
119
|
-
},
|
|
120
|
-
|
|
121
|
-
typescript: true,
|
|
122
|
-
vue: true,
|
|
123
|
-
|
|
124
|
-
// Disable jsonc and yaml support
|
|
125
|
-
jsonc: false,
|
|
126
|
-
yaml: false,
|
|
127
|
-
|
|
128
|
-
// enable nextjs-plugin
|
|
129
|
-
next: true,
|
|
130
|
-
|
|
131
|
-
// `.eslintignore` is no longer supported in Flat config, use `ignores` instead
|
|
132
|
-
ignores: [
|
|
133
|
-
'./fixtures',
|
|
134
|
-
// ...globs
|
|
135
|
-
]
|
|
136
|
-
})
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
For more advanced usage, see [@antfu/eslint-config](https://github.com/antfu/eslint-config?tab=readme-ov-file#antfueslint-config).
|
|
140
|
-
|
|
141
|
-
## License
|
|
142
|
-
|
|
143
|
-
[MIT](./LICENSE) License © 2023-PRESENT [Riri](https://github.com/daydreamer-riri)
|
|
1
|
+
# @ririd/eslint-config
|
|
2
|
+
|
|
3
|
+
[](https://npmjs.com/package/@ririd/eslint-config)
|
|
4
|
+
|
|
5
|
+
Riri's ESLint config presets
|
|
6
|
+
|
|
7
|
+
> [!IMPORTANT]
|
|
8
|
+
> This project is heavily based on [antfu/eslint-config](https://github.com/antfu/eslint-config), with a certain degree of customization ~~and more rules regarding React~~.
|
|
9
|
+
>
|
|
10
|
+
> Since v1.0.0, this config is rewritten to the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new).
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
### Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
pnpm i -D eslint @ririd/eslint-config
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Create config file
|
|
21
|
+
|
|
22
|
+
With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
// eslint.config.js
|
|
26
|
+
import ririd from '@ririd/eslint-config'
|
|
27
|
+
|
|
28
|
+
export default ririd()
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
With CJS:
|
|
32
|
+
|
|
33
|
+
```js
|
|
34
|
+
// eslint.config.js
|
|
35
|
+
const ririd = require('@ririd/eslint-config').default
|
|
36
|
+
|
|
37
|
+
module.exports = ririd()
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
> Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
|
|
41
|
+
|
|
42
|
+
## VS Code support (auto fix)
|
|
43
|
+
|
|
44
|
+
Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
45
|
+
|
|
46
|
+
Add the following settings to your `.vscode/settings.json`:
|
|
47
|
+
|
|
48
|
+
```jsonc
|
|
49
|
+
{
|
|
50
|
+
// Enable the ESlint flat config support
|
|
51
|
+
"eslint.experimental.useFlatConfig": true,
|
|
52
|
+
|
|
53
|
+
// Disable the default formatter, use eslint instead
|
|
54
|
+
"prettier.enable": false,
|
|
55
|
+
"editor.formatOnSave": false,
|
|
56
|
+
|
|
57
|
+
// Auto fix
|
|
58
|
+
"editor.codeActionsOnSave": {
|
|
59
|
+
"source.fixAll.eslint": "explicit",
|
|
60
|
+
"source.organizeImports": "never"
|
|
61
|
+
},
|
|
62
|
+
|
|
63
|
+
// Silent the stylistic rules in you IDE, but still auto fix them
|
|
64
|
+
"eslint.rules.customizations": [
|
|
65
|
+
{ "rule": "style/*", "severity": "off" },
|
|
66
|
+
{ "rule": "format/*", "severity": "off" },
|
|
67
|
+
{ "rule": "*-indent", "severity": "off" },
|
|
68
|
+
{ "rule": "*-spacing", "severity": "off" },
|
|
69
|
+
{ "rule": "*-spaces", "severity": "off" },
|
|
70
|
+
{ "rule": "*-order", "severity": "off" },
|
|
71
|
+
{ "rule": "*-dangle", "severity": "off" },
|
|
72
|
+
{ "rule": "*-newline", "severity": "off" },
|
|
73
|
+
{ "rule": "*quotes", "severity": "off" },
|
|
74
|
+
{ "rule": "*semi", "severity": "off" }
|
|
75
|
+
],
|
|
76
|
+
|
|
77
|
+
// Enable eslint for all supported languages
|
|
78
|
+
"eslint.validate": [
|
|
79
|
+
"javascript",
|
|
80
|
+
"javascriptreact",
|
|
81
|
+
"typescript",
|
|
82
|
+
"typescriptreact",
|
|
83
|
+
"vue",
|
|
84
|
+
"html",
|
|
85
|
+
"markdown",
|
|
86
|
+
"json",
|
|
87
|
+
"jsonc",
|
|
88
|
+
"yaml",
|
|
89
|
+
"toml"
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Customization
|
|
95
|
+
|
|
96
|
+
Normally you only need to import the `ririd` preset:
|
|
97
|
+
|
|
98
|
+
```js
|
|
99
|
+
// eslint.config.js
|
|
100
|
+
import ririd from '@ririd/eslint-config'
|
|
101
|
+
|
|
102
|
+
export default ririd()
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Or you can configure each integration individually, for example:
|
|
106
|
+
|
|
107
|
+
```js
|
|
108
|
+
// eslint.config.js
|
|
109
|
+
import ririd from '@ririd/eslint-config'
|
|
110
|
+
|
|
111
|
+
export default ririd({
|
|
112
|
+
// Enable stylistic formatting rules
|
|
113
|
+
// stylistic: true,
|
|
114
|
+
|
|
115
|
+
// Or customize the stylistic rules
|
|
116
|
+
stylistic: {
|
|
117
|
+
indent: 2, // 4, or 'tab'
|
|
118
|
+
quotes: 'single', // or 'double'
|
|
119
|
+
},
|
|
120
|
+
|
|
121
|
+
typescript: true,
|
|
122
|
+
vue: true,
|
|
123
|
+
|
|
124
|
+
// Disable jsonc and yaml support
|
|
125
|
+
jsonc: false,
|
|
126
|
+
yaml: false,
|
|
127
|
+
|
|
128
|
+
// enable nextjs-plugin
|
|
129
|
+
next: true,
|
|
130
|
+
|
|
131
|
+
// `.eslintignore` is no longer supported in Flat config, use `ignores` instead
|
|
132
|
+
ignores: [
|
|
133
|
+
'./fixtures',
|
|
134
|
+
// ...globs
|
|
135
|
+
]
|
|
136
|
+
})
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
For more advanced usage, see [@antfu/eslint-config](https://github.com/antfu/eslint-config?tab=readme-ov-file#antfueslint-config).
|
|
140
|
+
|
|
141
|
+
## License
|
|
142
|
+
|
|
143
|
+
[MIT](./LICENSE) License © 2023-PRESENT [Riri](https://github.com/daydreamer-riri)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ririd/eslint-config",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.3.
|
|
4
|
+
"version": "1.3.4",
|
|
5
5
|
"author": "Daydreamer Riri <Daydreamerriri@outloot.com> (https://github.com/Daydreamer-riri/)",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"homepage": "https://github.com/daydreamer-riri/eslint-config",
|
|
@@ -24,23 +24,23 @@
|
|
|
24
24
|
"eslint": ">=8.0.0"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@antfu/eslint-config": "^2.
|
|
28
|
-
"@eslint-react/eslint-plugin": "^1.
|
|
29
|
-
"@next/eslint-plugin-next": "^14.2.
|
|
27
|
+
"@antfu/eslint-config": "^2.24.1",
|
|
28
|
+
"@eslint-react/eslint-plugin": "^1.8.0",
|
|
29
|
+
"@next/eslint-plugin-next": "^14.2.5",
|
|
30
30
|
"eslint-plugin-format": "^0.1.2",
|
|
31
|
-
"eslint-plugin-react-hooks": "
|
|
32
|
-
"eslint-plugin-react-refresh": "^0.4.
|
|
31
|
+
"eslint-plugin-react-hooks": "5.1.0-rc-06d0b89e-20240801",
|
|
32
|
+
"eslint-plugin-react-refresh": "^0.4.9"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
|
-
"@types/eslint": "^
|
|
35
|
+
"@types/eslint": "^9.6.0",
|
|
36
36
|
"@types/node": "20.10.4",
|
|
37
37
|
"bumpp": "^9.4.0",
|
|
38
|
-
"eslint": "^9.
|
|
38
|
+
"eslint": "^9.8.0",
|
|
39
39
|
"rimraf": "^5.0.5",
|
|
40
40
|
"tsup": "^8.1.0",
|
|
41
41
|
"typescript": "^5.5.2",
|
|
42
42
|
"vitest": "^1.5.2",
|
|
43
|
-
"@ririd/eslint-config": "1.3.
|
|
43
|
+
"@ririd/eslint-config": "1.3.4"
|
|
44
44
|
},
|
|
45
45
|
"scripts": {
|
|
46
46
|
"build": "tsup src/index.ts --format esm,cjs --clean --dts",
|