Skip to content

Commit 7b9ec01

Browse files
New: Add a 'recommended' config
1 parent 06a6e5a commit 7b9ec01

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

Diff for: README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,19 @@ Then configure the rules you want to use under the rules section.
4141
}
4242
```
4343

44+
Additionally, you can enable all recommended rules from this plugin:
45+
46+
```json
47+
{
48+
"extends": [
49+
"plugin:eslint-plugin/recommended"
50+
]
51+
}
52+
```
53+
4454
## Supported Rules
4555

56+
✔️ indicates that a rule is recommended.
4657
🛠 indicates that a rule is fixable.
4758

48-
* 🛠 [no-deprecated-report-api](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-report-api.md): Prohibits the deprecated `context.report(node, message)` API
59+
* ✔️ 🛠 [no-deprecated-report-api](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-report-api.md): Prohibits the deprecated `context.report(node, message)` API

Diff for: lib/index.js

+12-1
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,26 @@
1111

1212
const fs = require('fs');
1313
const path = require('path');
14+
const PLUGIN_NAME = require('../package').name.replace(/^eslint-plugin-/, '');
1415

1516
// ------------------------------------------------------------------------------
1617
// Plugin Definition
1718
// ------------------------------------------------------------------------------
1819

1920

2021
// import all rules in lib/rules
21-
module.exports.rules = fs
22+
const allRules = fs
2223
.readdirSync(`${__dirname}/rules`)
2324
.filter(fileName => fileName.endsWith('.js') && /^[^._]/.test(fileName))
2425
.map(fileName => fileName.replace(/\.js$/, ''))
2526
.reduce((rules, ruleName) => Object.assign(rules, { [ruleName]: require(path.join(__dirname, 'rules', ruleName)) }), {});
27+
28+
module.exports.rules = allRules;
29+
30+
module.exports.configs = {
31+
recommended: {
32+
rules: Object.keys(allRules)
33+
.filter(ruleName => allRules[ruleName].meta.docs.recommended)
34+
.reduce((rules, ruleName) => Object.assign(rules, { [`${PLUGIN_NAME}/${ruleName}`]: 2 }), {}),
35+
},
36+
};

Diff for: lib/rules/no-deprecated-report-api.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module.exports = {
1616
docs: {
1717
description: 'disallow use of the deprecated context.report() API',
1818
category: 'Rules',
19-
recommended: false,
19+
recommended: true,
2020
},
2121
fixable: 'code', // or "code" or "whitespace"
2222
schema: [],

0 commit comments

Comments
 (0)