Skip to content

Commit e3b27e2

Browse files
aladdin-addaladdin-add
authored
feat: re-export flat configs "flat/*" (#453)
* feat: re-export flat configs "flat/*" long-time plan: v6: no action v7: rename 'flat/*' => '*'; eslintrc config '*' => 'legacy/*'? v8~: remove eslintrc supports
1 parent f4d8cb1 commit e3b27e2

11 files changed

+100
-58
lines changed

‎.eslint-doc-generatorrc.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ module.exports = {
1111
'rules-recommended',
1212
'tests',
1313
'tests-recommended',
14+
'flat/recommended',
15+
'flat/all',
16+
'flat/all-type-checked',
17+
'flat/rules',
18+
'flat/rules-recommended',
19+
'flat/tests',
20+
'flat/tests-recommended',
1421
],
1522
postprocess: async (content, path) =>
1623
prettier.format(content, {

‎README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,6 @@ Here's an example ESLint configuration that:
4747

4848
```json
4949
{
50-
"parserOptions": {
51-
"sourceType": "script"
52-
},
5350
"extends": ["plugin:eslint-plugin/recommended"],
5451
"rules": {
5552
"eslint-plugin/require-meta-docs-description": "error"
@@ -60,11 +57,10 @@ Here's an example ESLint configuration that:
6057
### <a name='flat'></a>[`eslint.config.js`](https://eslint.org/docs/latest/use/configure/configuration-files-new) (requires eslint>=v8.23.0)
6158

6259
```js
63-
const eslintPluginRecommended = require('eslint-plugin-eslint-plugin/configs/recommended');
60+
const eslintPlugin = require('eslint-plugin-eslint-plugin');
6461
module.exports = [
65-
eslintPluginRecommended,
62+
eslintPlugin.configs['flat/recommended'],
6663
{
67-
languageOptions: { sourceType: 'commonjs' },
6864
rules: {
6965
'eslint-plugin/require-meta-docs-description': 'error',
7066
},
@@ -139,7 +135,16 @@ The list of recommended rules will only change in a major release of this plugin
139135

140136
### <a name='Presetusage'></a>Preset usage
141137

142-
Presets are enabled by adding a line to the `extends` list in your config file. For example, to enable the `recommended` preset, use:
138+
Both flat and eslintrc configs are supported. For example, to enable the `recommended` preset, use:
139+
140+
eslint.config.js
141+
142+
```js
143+
const eslintPlugin = require('eslint-plugin-eslint-plugin');
144+
module.exports = [eslintPlugin.configs['flat/recommended']];
145+
```
146+
147+
.eslintrc.json
143148

144149
```json
145150
{
@@ -149,6 +154,24 @@ Presets are enabled by adding a line to the `extends` list in your config file.
149154

150155
Or to apply linting only to the appropriate rule or test files:
151156

157+
eslint.config.js
158+
159+
```js
160+
const eslintPlugin = require('eslint-plugin-eslint-plugin');
161+
module.exports = [
162+
{
163+
files: ['lib/rules/*.{js,ts}'],
164+
...eslintPlugin.configs['flat/rules-recommended'],
165+
},
166+
{
167+
files: ['tests/lib/rules/*.{js,ts}'],
168+
...eslintPlugin.configs['flat/tests-recommended'],
169+
},
170+
];
171+
```
172+
173+
.eslintrc.js
174+
152175
```json
153176
{
154177
"overrides": [

‎configs/all-type-checked.js

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
/**
2+
* @deprecated use 'flat/all-type-checked' instead
3+
* @author 唯然<[email protected]>
4+
*/
5+
16
'use strict';
27

3-
const mod = require('../lib/index.js');
8+
const plugin = require('../lib/index.js');
49

5-
module.exports = {
6-
plugins: { 'eslint-plugin': mod },
7-
rules: mod.configs['all-type-checked'].rules,
8-
};
10+
module.exports = plugin.configs['flat/all-type-checked'];

‎configs/all.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `all` config for `eslint.config.js`
3+
* @deprecated use 'flat/all' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs.all.rules,
13-
};
11+
module.exports = plugin.configs['flat/all'];

‎configs/recommended.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `recommended` config for `eslint.config.js`
3+
* @deprecated use 'flat/recommended' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs.recommended.rules,
13-
};
11+
module.exports = plugin.configs['flat/recommended'];

‎configs/rules-recommended.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `rules-recommended` config for `eslint.config.js`
3+
* @deprecated use 'flat/rules-recommended' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs['rules-recommended'].rules,
13-
};
11+
module.exports = plugin.configs['flat/rules-recommended'];

‎configs/rules.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `rules` config for `eslint.config.js`
3+
* @deprecated use 'flat/rules' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs.rules.rules,
13-
};
11+
module.exports = plugin.configs['flat/rules'];

‎configs/tests-recommended.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `tests-recommended` config for `eslint.config.js`
3+
* @deprecated use 'flat/tests-recommended' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs['tests-recommended'].rules,
13-
};
11+
module.exports = plugin.configs['flat/tests-recommended'];

‎configs/tests.js

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
/**
22
* @fileoverview the `tests` config for `eslint.config.js`
3+
* @deprecated use 'flat/tests' instead
34
* @author 唯然<[email protected]>
45
*/
56

67
'use strict';
78

8-
const mod = require('../lib/index.js');
9+
const plugin = require('../lib/index.js');
910

10-
module.exports = {
11-
plugins: { 'eslint-plugin': mod },
12-
rules: mod.configs.tests.rules,
13-
};
11+
module.exports = plugin.configs['flat/tests'];

‎lib/index.js

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,19 @@ const allRules = Object.fromEntries(
4242
])
4343
);
4444

45-
module.exports.meta = {
46-
name: packageMetadata.name,
47-
version: packageMetadata.version,
45+
const plugin = {
46+
meta: {
47+
name: packageMetadata.name,
48+
version: packageMetadata.version,
49+
},
50+
rules: allRules,
51+
configs: {}, // assigned later
4852
};
4953

50-
module.exports.rules = allRules;
51-
52-
module.exports.configs = Object.keys(configFilters).reduce(
53-
(configs, configName) => {
54+
// eslintrc configs
55+
Object.assign(
56+
plugin.configs,
57+
Object.keys(configFilters).reduce((configs, configName) => {
5458
return Object.assign(configs, {
5559
[configName]: {
5660
plugins: ['eslint-plugin'],
@@ -61,6 +65,24 @@ module.exports.configs = Object.keys(configFilters).reduce(
6165
),
6266
},
6367
});
64-
},
65-
{}
68+
}, {})
69+
);
70+
71+
// flat configs
72+
Object.assign(
73+
plugin.configs,
74+
Object.keys(configFilters).reduce((configs, configName) => {
75+
return Object.assign(configs, {
76+
[`flat/${configName}`]: {
77+
plugins: { 'eslint-plugin': plugin },
78+
rules: Object.fromEntries(
79+
Object.keys(allRules)
80+
.filter((ruleName) => configFilters[configName](allRules[ruleName]))
81+
.map((ruleName) => [`${PLUGIN_NAME}/${ruleName}`, 'error'])
82+
),
83+
},
84+
});
85+
}, {})
6686
);
87+
88+
module.exports = plugin;

‎package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@
5353
"@commitlint/cli": "^17.1.2",
5454
"@commitlint/config-conventional": "^17.1.0",
5555
"@eslint/eslintrc": "^2.0.2",
56-
"@eslint/js": "^8.37.0",
56+
"@eslint/js": "^8.57.0",
5757
"@release-it/conventional-changelog": "^4.3.0",
58-
"@types/eslint": "^8.56.2",
58+
"@types/eslint": "^8.56.6",
5959
"@types/estree": "^1.0.5",
6060
"@typescript-eslint/parser": "^5.62.0",
6161
"@typescript-eslint/utils": "^5.62.0",
6262
"chai": "^4.3.6",
6363
"dirty-chai": "^2.0.1",
64-
"eslint": "^8.23.0",
64+
"eslint": "^8.57.0",
6565
"eslint-config-not-an-aardvark": "^2.1.0",
6666
"eslint-config-prettier": "^8.5.0",
6767
"eslint-doc-generator": "^1.7.0",
@@ -78,13 +78,13 @@
7878
"husky": "^8.0.1",
7979
"lodash": "^4.17.21",
8080
"markdownlint-cli": "^0.39.0",
81-
"mocha": "^10.0.0",
82-
"npm-package-json-lint": "^7.0.0",
83-
"npm-run-all2": "^5.0.0",
81+
"mocha": "^10.4.0",
82+
"npm-package-json-lint": "^7.1.0",
83+
"npm-run-all2": "^6.1.2",
8484
"nyc": "^15.1.0",
8585
"prettier": "^2.7.1",
8686
"release-it": "^14.14.3",
87-
"typescript": "^5.1.3"
87+
"typescript": "^5.4.3"
8888
},
8989
"peerDependencies": {
9090
"eslint": ">=7.0.0"

0 commit comments

Comments
 (0)