Skip to content

Commit

Permalink
New: Add a 'recommended' config
Browse files Browse the repository at this point in the history
  • Loading branch information
not-an-aardvark committed Dec 13, 2016
1 parent 06a6e5a commit 7b9ec01
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,19 @@ Then configure the rules you want to use under the rules section.
}
```

Additionally, you can enable all recommended rules from this plugin:

```json
{
"extends": [
"plugin:eslint-plugin/recommended"
]
}
```

## Supported Rules

✔️ indicates that a rule is recommended.
🛠 indicates that a rule is fixable.

* 🛠 [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
* ✔️ 🛠 [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
13 changes: 12 additions & 1 deletion lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,26 @@

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

// ------------------------------------------------------------------------------
// Plugin Definition
// ------------------------------------------------------------------------------


// import all rules in lib/rules
module.exports.rules = fs
const allRules = fs
.readdirSync(`${__dirname}/rules`)
.filter(fileName => fileName.endsWith('.js') && /^[^._]/.test(fileName))
.map(fileName => fileName.replace(/\.js$/, ''))
.reduce((rules, ruleName) => Object.assign(rules, { [ruleName]: require(path.join(__dirname, 'rules', ruleName)) }), {});

module.exports.rules = allRules;

module.exports.configs = {
recommended: {
rules: Object.keys(allRules)
.filter(ruleName => allRules[ruleName].meta.docs.recommended)
.reduce((rules, ruleName) => Object.assign(rules, { [`${PLUGIN_NAME}/${ruleName}`]: 2 }), {}),
},
};
2 changes: 1 addition & 1 deletion lib/rules/no-deprecated-report-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = {
docs: {
description: 'disallow use of the deprecated context.report() API',
category: 'Rules',
recommended: false,
recommended: true,
},
fixable: 'code', // or "code" or "whitespace"
schema: [],
Expand Down

0 comments on commit 7b9ec01

Please sign in to comment.