1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/**
* @fileoverview An ESLint plugin for linting ESLint plugins
* @author Teddy Katz
*/
'use strict';
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
const fs = require('fs');
const path = require('path');
const packageMetadata = require('../package');
const PLUGIN_NAME = packageMetadata.name.replace(/^eslint-plugin-/, '');
const PLUGIN_VERSION = packageMetadata.version;
const configFilters = {
all: () => true,
recommended: rule => rule.meta.docs.recommended,
rules: rule => rule.meta.docs.category === 'Rules',
tests: rule => rule.meta.docs.category === 'Tests',
'rules-recommended': rule => configFilters.recommended(rule) && configFilters.rules(rule),
'tests-recommended': rule => configFilters.recommended(rule) && configFilters.tests(rule),
};
// ------------------------------------------------------------------------------
// Plugin Definition
// ------------------------------------------------------------------------------
/**
* Loads a given rule from the filesystem and generates its documentation URL
* @param {string} ruleName The name of the rule
* @returns {Rule} The ESLint rule to export
*/
function loadRule (ruleName) {
const rule = require(path.join(__dirname, 'rules', ruleName));
rule.meta.docs.url =
`https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v${PLUGIN_VERSION}/docs/rules/${ruleName}.md`;
return rule;
}
// import all rules in lib/rules
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]: loadRule(ruleName) }), {});
module.exports.rules = allRules;
module.exports.configs = Object.keys(configFilters).reduce((configs, configName) => {
return Object.assign(configs, {
[configName]: {
rules: Object.keys(allRules)
.filter(ruleName => configFilters[configName](allRules[ruleName]))
.reduce((rules, ruleName) => Object.assign(rules, { [`${PLUGIN_NAME}/${ruleName}`]: 'error' }), {}),
},
});
}, {});
|
