Skip to content

Commit aa56247

Browse files
petermetznot-an-aardvark
petermetz
authored and
not-an-aardvark
committed
Fix: avoid loading core rules dynamically from FS in Linter (#11278)
1 parent 04450bb commit aa56247

3 files changed

Lines changed: 299 additions & 2 deletions

File tree

‎Makefile.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -938,6 +938,17 @@ target.checkRuleFiles = function() {
938938
errors++;
939939
}
940940

941+
// check parity between rules index file and rules directory
942+
const builtInRulesIndexPath = "./lib/built-in-rules-index";
943+
const ruleIdsInIndex = require(builtInRulesIndexPath);
944+
const ruleEntryFromIndexIsMissing = !(basename in ruleIdsInIndex);
945+
946+
if (ruleEntryFromIndexIsMissing) {
947+
console.error(`Missing rule from index (${builtInRulesIndexPath}.js): ${basename}. If you just added a ` +
948+
"new rule then add an entry for it in this file.");
949+
errors++;
950+
}
951+
941952
// check for tests
942953
if (!test("-f", `tests/lib/rules/${basename}.js`)) {
943954
console.error("Missing tests for rule %s", basename);

‎lib/built-in-rules-index.js‎

Lines changed: 277 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,277 @@
1+
/**
2+
* @fileoverview Collects the built-in rules into a map structure so that they can be imported all at once and without
3+
* using the file-system directly.
4+
* @author Peter (Somogyvari) Metz
5+
*/
6+
7+
"use strict";
8+
9+
/* eslint sort-keys: ["error", "asc"] */
10+
11+
module.exports = {
12+
"accessor-pairs": require("./rules/accessor-pairs"),
13+
"array-bracket-newline": require("./rules/array-bracket-newline"),
14+
"array-bracket-spacing": require("./rules/array-bracket-spacing"),
15+
"array-callback-return": require("./rules/array-callback-return"),
16+
"array-element-newline": require("./rules/array-element-newline"),
17+
"arrow-body-style": require("./rules/arrow-body-style"),
18+
"arrow-parens": require("./rules/arrow-parens"),
19+
"arrow-spacing": require("./rules/arrow-spacing"),
20+
"block-scoped-var": require("./rules/block-scoped-var"),
21+
"block-spacing": require("./rules/block-spacing"),
22+
"brace-style": require("./rules/brace-style"),
23+
"callback-return": require("./rules/callback-return"),
24+
camelcase: require("./rules/camelcase"),
25+
"capitalized-comments": require("./rules/capitalized-comments"),
26+
"class-methods-use-this": require("./rules/class-methods-use-this"),
27+
"comma-dangle": require("./rules/comma-dangle"),
28+
"comma-spacing": require("./rules/comma-spacing"),
29+
"comma-style": require("./rules/comma-style"),
30+
complexity: require("./rules/complexity"),
31+
"computed-property-spacing": require("./rules/computed-property-spacing"),
32+
"consistent-return": require("./rules/consistent-return"),
33+
"consistent-this": require("./rules/consistent-this"),
34+
"constructor-super": require("./rules/constructor-super"),
35+
curly: require("./rules/curly"),
36+
"default-case": require("./rules/default-case"),
37+
"dot-location": require("./rules/dot-location"),
38+
"dot-notation": require("./rules/dot-notation"),
39+
"eol-last": require("./rules/eol-last"),
40+
eqeqeq: require("./rules/eqeqeq"),
41+
"for-direction": require("./rules/for-direction"),
42+
"func-call-spacing": require("./rules/func-call-spacing"),
43+
"func-name-matching": require("./rules/func-name-matching"),
44+
"func-names": require("./rules/func-names"),
45+
"func-style": require("./rules/func-style"),
46+
"function-paren-newline": require("./rules/function-paren-newline"),
47+
"generator-star-spacing": require("./rules/generator-star-spacing"),
48+
"getter-return": require("./rules/getter-return"),
49+
"global-require": require("./rules/global-require"),
50+
"guard-for-in": require("./rules/guard-for-in"),
51+
"handle-callback-err": require("./rules/handle-callback-err"),
52+
"id-blacklist": require("./rules/id-blacklist"),
53+
"id-length": require("./rules/id-length"),
54+
"id-match": require("./rules/id-match"),
55+
"implicit-arrow-linebreak": require("./rules/implicit-arrow-linebreak"),
56+
indent: require("./rules/indent"),
57+
"indent-legacy": require("./rules/indent-legacy"),
58+
"init-declarations": require("./rules/init-declarations"),
59+
"jsx-quotes": require("./rules/jsx-quotes"),
60+
"key-spacing": require("./rules/key-spacing"),
61+
"keyword-spacing": require("./rules/keyword-spacing"),
62+
"line-comment-position": require("./rules/line-comment-position"),
63+
"linebreak-style": require("./rules/linebreak-style"),
64+
"lines-around-comment": require("./rules/lines-around-comment"),
65+
"lines-around-directive": require("./rules/lines-around-directive"),
66+
"lines-between-class-members": require("./rules/lines-between-class-members"),
67+
"max-classes-per-file": require("./rules/max-classes-per-file"),
68+
"max-depth": require("./rules/max-depth"),
69+
"max-len": require("./rules/max-len"),
70+
"max-lines": require("./rules/max-lines"),
71+
"max-lines-per-function": require("./rules/max-lines-per-function"),
72+
"max-nested-callbacks": require("./rules/max-nested-callbacks"),
73+
"max-params": require("./rules/max-params"),
74+
"max-statements": require("./rules/max-statements"),
75+
"max-statements-per-line": require("./rules/max-statements-per-line"),
76+
"multiline-comment-style": require("./rules/multiline-comment-style"),
77+
"multiline-ternary": require("./rules/multiline-ternary"),
78+
"new-cap": require("./rules/new-cap"),
79+
"new-parens": require("./rules/new-parens"),
80+
"newline-after-var": require("./rules/newline-after-var"),
81+
"newline-before-return": require("./rules/newline-before-return"),
82+
"newline-per-chained-call": require("./rules/newline-per-chained-call"),
83+
"no-alert": require("./rules/no-alert"),
84+
"no-array-constructor": require("./rules/no-array-constructor"),
85+
"no-async-promise-executor": require("./rules/no-async-promise-executor"),
86+
"no-await-in-loop": require("./rules/no-await-in-loop"),
87+
"no-bitwise": require("./rules/no-bitwise"),
88+
"no-buffer-constructor": require("./rules/no-buffer-constructor"),
89+
"no-caller": require("./rules/no-caller"),
90+
"no-case-declarations": require("./rules/no-case-declarations"),
91+
"no-catch-shadow": require("./rules/no-catch-shadow"),
92+
"no-class-assign": require("./rules/no-class-assign"),
93+
"no-compare-neg-zero": require("./rules/no-compare-neg-zero"),
94+
"no-cond-assign": require("./rules/no-cond-assign"),
95+
"no-confusing-arrow": require("./rules/no-confusing-arrow"),
96+
"no-console": require("./rules/no-console"),
97+
"no-const-assign": require("./rules/no-const-assign"),
98+
"no-constant-condition": require("./rules/no-constant-condition"),
99+
"no-continue": require("./rules/no-continue"),
100+
"no-control-regex": require("./rules/no-control-regex"),
101+
"no-debugger": require("./rules/no-debugger"),
102+
"no-delete-var": require("./rules/no-delete-var"),
103+
"no-div-regex": require("./rules/no-div-regex"),
104+
"no-dupe-args": require("./rules/no-dupe-args"),
105+
"no-dupe-class-members": require("./rules/no-dupe-class-members"),
106+
"no-dupe-keys": require("./rules/no-dupe-keys"),
107+
"no-duplicate-case": require("./rules/no-duplicate-case"),
108+
"no-duplicate-imports": require("./rules/no-duplicate-imports"),
109+
"no-else-return": require("./rules/no-else-return"),
110+
"no-empty": require("./rules/no-empty"),
111+
"no-empty-character-class": require("./rules/no-empty-character-class"),
112+
"no-empty-function": require("./rules/no-empty-function"),
113+
"no-empty-pattern": require("./rules/no-empty-pattern"),
114+
"no-eq-null": require("./rules/no-eq-null"),
115+
"no-eval": require("./rules/no-eval"),
116+
"no-ex-assign": require("./rules/no-ex-assign"),
117+
"no-extend-native": require("./rules/no-extend-native"),
118+
"no-extra-bind": require("./rules/no-extra-bind"),
119+
"no-extra-boolean-cast": require("./rules/no-extra-boolean-cast"),
120+
"no-extra-label": require("./rules/no-extra-label"),
121+
"no-extra-parens": require("./rules/no-extra-parens"),
122+
"no-extra-semi": require("./rules/no-extra-semi"),
123+
"no-fallthrough": require("./rules/no-fallthrough"),
124+
"no-floating-decimal": require("./rules/no-floating-decimal"),
125+
"no-func-assign": require("./rules/no-func-assign"),
126+
"no-global-assign": require("./rules/no-global-assign"),
127+
"no-implicit-coercion": require("./rules/no-implicit-coercion"),
128+
"no-implicit-globals": require("./rules/no-implicit-globals"),
129+
"no-implied-eval": require("./rules/no-implied-eval"),
130+
"no-inline-comments": require("./rules/no-inline-comments"),
131+
"no-inner-declarations": require("./rules/no-inner-declarations"),
132+
"no-invalid-regexp": require("./rules/no-invalid-regexp"),
133+
"no-invalid-this": require("./rules/no-invalid-this"),
134+
"no-irregular-whitespace": require("./rules/no-irregular-whitespace"),
135+
"no-iterator": require("./rules/no-iterator"),
136+
"no-label-var": require("./rules/no-label-var"),
137+
"no-labels": require("./rules/no-labels"),
138+
"no-lone-blocks": require("./rules/no-lone-blocks"),
139+
"no-lonely-if": require("./rules/no-lonely-if"),
140+
"no-loop-func": require("./rules/no-loop-func"),
141+
"no-magic-numbers": require("./rules/no-magic-numbers"),
142+
"no-misleading-character-class": require("./rules/no-misleading-character-class"),
143+
"no-mixed-operators": require("./rules/no-mixed-operators"),
144+
"no-mixed-requires": require("./rules/no-mixed-requires"),
145+
"no-mixed-spaces-and-tabs": require("./rules/no-mixed-spaces-and-tabs"),
146+
"no-multi-assign": require("./rules/no-multi-assign"),
147+
"no-multi-spaces": require("./rules/no-multi-spaces"),
148+
"no-multi-str": require("./rules/no-multi-str"),
149+
"no-multiple-empty-lines": require("./rules/no-multiple-empty-lines"),
150+
"no-native-reassign": require("./rules/no-native-reassign"),
151+
"no-negated-condition": require("./rules/no-negated-condition"),
152+
"no-negated-in-lhs": require("./rules/no-negated-in-lhs"),
153+
"no-nested-ternary": require("./rules/no-nested-ternary"),
154+
"no-new": require("./rules/no-new"),
155+
"no-new-func": require("./rules/no-new-func"),
156+
"no-new-object": require("./rules/no-new-object"),
157+
"no-new-require": require("./rules/no-new-require"),
158+
"no-new-symbol": require("./rules/no-new-symbol"),
159+
"no-new-wrappers": require("./rules/no-new-wrappers"),
160+
"no-obj-calls": require("./rules/no-obj-calls"),
161+
"no-octal": require("./rules/no-octal"),
162+
"no-octal-escape": require("./rules/no-octal-escape"),
163+
"no-param-reassign": require("./rules/no-param-reassign"),
164+
"no-path-concat": require("./rules/no-path-concat"),
165+
"no-plusplus": require("./rules/no-plusplus"),
166+
"no-process-env": require("./rules/no-process-env"),
167+
"no-process-exit": require("./rules/no-process-exit"),
168+
"no-proto": require("./rules/no-proto"),
169+
"no-prototype-builtins": require("./rules/no-prototype-builtins"),
170+
"no-redeclare": require("./rules/no-redeclare"),
171+
"no-regex-spaces": require("./rules/no-regex-spaces"),
172+
"no-restricted-globals": require("./rules/no-restricted-globals"),
173+
"no-restricted-imports": require("./rules/no-restricted-imports"),
174+
"no-restricted-modules": require("./rules/no-restricted-modules"),
175+
"no-restricted-properties": require("./rules/no-restricted-properties"),
176+
"no-restricted-syntax": require("./rules/no-restricted-syntax"),
177+
"no-return-assign": require("./rules/no-return-assign"),
178+
"no-return-await": require("./rules/no-return-await"),
179+
"no-script-url": require("./rules/no-script-url"),
180+
"no-self-assign": require("./rules/no-self-assign"),
181+
"no-self-compare": require("./rules/no-self-compare"),
182+
"no-sequences": require("./rules/no-sequences"),
183+
"no-shadow": require("./rules/no-shadow"),
184+
"no-shadow-restricted-names": require("./rules/no-shadow-restricted-names"),
185+
"no-spaced-func": require("./rules/no-spaced-func"),
186+
"no-sparse-arrays": require("./rules/no-sparse-arrays"),
187+
"no-sync": require("./rules/no-sync"),
188+
"no-tabs": require("./rules/no-tabs"),
189+
"no-template-curly-in-string": require("./rules/no-template-curly-in-string"),
190+
"no-ternary": require("./rules/no-ternary"),
191+
"no-this-before-super": require("./rules/no-this-before-super"),
192+
"no-throw-literal": require("./rules/no-throw-literal"),
193+
"no-trailing-spaces": require("./rules/no-trailing-spaces"),
194+
"no-undef": require("./rules/no-undef"),
195+
"no-undef-init": require("./rules/no-undef-init"),
196+
"no-undefined": require("./rules/no-undefined"),
197+
"no-underscore-dangle": require("./rules/no-underscore-dangle"),
198+
"no-unexpected-multiline": require("./rules/no-unexpected-multiline"),
199+
"no-unmodified-loop-condition": require("./rules/no-unmodified-loop-condition"),
200+
"no-unneeded-ternary": require("./rules/no-unneeded-ternary"),
201+
"no-unreachable": require("./rules/no-unreachable"),
202+
"no-unsafe-finally": require("./rules/no-unsafe-finally"),
203+
"no-unsafe-negation": require("./rules/no-unsafe-negation"),
204+
"no-unused-expressions": require("./rules/no-unused-expressions"),
205+
"no-unused-labels": require("./rules/no-unused-labels"),
206+
"no-unused-vars": require("./rules/no-unused-vars"),
207+
"no-use-before-define": require("./rules/no-use-before-define"),
208+
"no-useless-call": require("./rules/no-useless-call"),
209+
"no-useless-catch": require("./rules/no-useless-catch"),
210+
"no-useless-computed-key": require("./rules/no-useless-computed-key"),
211+
"no-useless-concat": require("./rules/no-useless-concat"),
212+
"no-useless-constructor": require("./rules/no-useless-constructor"),
213+
"no-useless-escape": require("./rules/no-useless-escape"),
214+
"no-useless-rename": require("./rules/no-useless-rename"),
215+
"no-useless-return": require("./rules/no-useless-return"),
216+
"no-var": require("./rules/no-var"),
217+
"no-void": require("./rules/no-void"),
218+
"no-warning-comments": require("./rules/no-warning-comments"),
219+
"no-whitespace-before-property": require("./rules/no-whitespace-before-property"),
220+
"no-with": require("./rules/no-with"),
221+
"nonblock-statement-body-position": require("./rules/nonblock-statement-body-position"),
222+
"object-curly-newline": require("./rules/object-curly-newline"),
223+
"object-curly-spacing": require("./rules/object-curly-spacing"),
224+
"object-property-newline": require("./rules/object-property-newline"),
225+
"object-shorthand": require("./rules/object-shorthand"),
226+
"one-var": require("./rules/one-var"),
227+
"one-var-declaration-per-line": require("./rules/one-var-declaration-per-line"),
228+
"operator-assignment": require("./rules/operator-assignment"),
229+
"operator-linebreak": require("./rules/operator-linebreak"),
230+
"padded-blocks": require("./rules/padded-blocks"),
231+
"padding-line-between-statements": require("./rules/padding-line-between-statements"),
232+
"prefer-arrow-callback": require("./rules/prefer-arrow-callback"),
233+
"prefer-const": require("./rules/prefer-const"),
234+
"prefer-destructuring": require("./rules/prefer-destructuring"),
235+
"prefer-numeric-literals": require("./rules/prefer-numeric-literals"),
236+
"prefer-object-spread": require("./rules/prefer-object-spread"),
237+
"prefer-promise-reject-errors": require("./rules/prefer-promise-reject-errors"),
238+
"prefer-reflect": require("./rules/prefer-reflect"),
239+
"prefer-rest-params": require("./rules/prefer-rest-params"),
240+
"prefer-spread": require("./rules/prefer-spread"),
241+
"prefer-template": require("./rules/prefer-template"),
242+
"quote-props": require("./rules/quote-props"),
243+
quotes: require("./rules/quotes"),
244+
radix: require("./rules/radix"),
245+
"require-atomic-updates": require("./rules/require-atomic-updates"),
246+
"require-await": require("./rules/require-await"),
247+
"require-jsdoc": require("./rules/require-jsdoc"),
248+
"require-unicode-regexp": require("./rules/require-unicode-regexp"),
249+
"require-yield": require("./rules/require-yield"),
250+
"rest-spread-spacing": require("./rules/rest-spread-spacing"),
251+
semi: require("./rules/semi"),
252+
"semi-spacing": require("./rules/semi-spacing"),
253+
"semi-style": require("./rules/semi-style"),
254+
"sort-imports": require("./rules/sort-imports"),
255+
"sort-keys": require("./rules/sort-keys"),
256+
"sort-vars": require("./rules/sort-vars"),
257+
"space-before-blocks": require("./rules/space-before-blocks"),
258+
"space-before-function-paren": require("./rules/space-before-function-paren"),
259+
"space-in-parens": require("./rules/space-in-parens"),
260+
"space-infix-ops": require("./rules/space-infix-ops"),
261+
"space-unary-ops": require("./rules/space-unary-ops"),
262+
"spaced-comment": require("./rules/spaced-comment"),
263+
strict: require("./rules/strict"),
264+
"switch-colon-spacing": require("./rules/switch-colon-spacing"),
265+
"symbol-description": require("./rules/symbol-description"),
266+
"template-curly-spacing": require("./rules/template-curly-spacing"),
267+
"template-tag-spacing": require("./rules/template-tag-spacing"),
268+
"unicode-bom": require("./rules/unicode-bom"),
269+
"use-isnan": require("./rules/use-isnan"),
270+
"valid-jsdoc": require("./rules/valid-jsdoc"),
271+
"valid-typeof": require("./rules/valid-typeof"),
272+
"vars-on-top": require("./rules/vars-on-top"),
273+
"wrap-iife": require("./rules/wrap-iife"),
274+
"wrap-regex": require("./rules/wrap-regex"),
275+
"yield-star-spacing": require("./rules/yield-star-spacing"),
276+
yoda: require("./rules/yoda")
277+
};

‎lib/rules.js‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
const lodash = require("lodash");
1313
const loadRules = require("./load-rules");
1414
const ruleReplacements = require("../conf/replacements").rules;
15+
const builtInRules = require("./built-in-rules-index");
1516

1617
//------------------------------------------------------------------------------
1718
// Helpers
@@ -59,8 +60,7 @@ function normalizeRule(rule) {
5960
class Rules {
6061
constructor() {
6162
this._rules = Object.create(null);
62-
63-
this.load();
63+
this.defineAll(builtInRules);
6464
}
6565

6666
/**
@@ -82,6 +82,15 @@ class Rules {
8282
load(rulesDir, cwd) {
8383
const newRules = loadRules(rulesDir, cwd);
8484

85+
this.defineAll(newRules);
86+
}
87+
88+
/**
89+
* Pulls a Map of new rules to the defined ones of this instance.
90+
* @param {Object} newRules Expects to have an object here that maps the rule ID to the rule definition.
91+
* @returns {void}
92+
*/
93+
defineAll(newRules) {
8594
Object.keys(newRules).forEach(ruleId => {
8695
this.define(ruleId, newRules[ruleId]);
8796
});

0 commit comments

Comments
 (0)