eslint 9.22.0 → 9.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/README.md +48 -46
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +830 -810
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +638 -457
  21. package/lib/config/config-loader.js +726 -622
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +72 -72
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +756 -681
  30. package/lib/eslint/eslint.js +934 -912
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +577 -533
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2403 -2045
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +36 -36
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +404 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1308 -1046
  73. package/lib/rules/accessor-pairs.js +298 -263
  74. package/lib/rules/array-bracket-newline.js +250 -238
  75. package/lib/rules/array-bracket-spacing.js +263 -224
  76. package/lib/rules/array-callback-return.js +402 -356
  77. package/lib/rules/array-element-newline.js +358 -313
  78. package/lib/rules/arrow-body-style.js +400 -281
  79. package/lib/rules/arrow-parens.js +206 -173
  80. package/lib/rules/arrow-spacing.js +169 -163
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -176
  83. package/lib/rules/brace-style.js +262 -199
  84. package/lib/rules/callback-return.js +203 -190
  85. package/lib/rules/camelcase.js +403 -392
  86. package/lib/rules/capitalized-comments.js +253 -232
  87. package/lib/rules/class-methods-use-this.js +224 -172
  88. package/lib/rules/comma-dangle.js +379 -346
  89. package/lib/rules/comma-spacing.js +193 -195
  90. package/lib/rules/comma-style.js +375 -316
  91. package/lib/rules/complexity.js +173 -169
  92. package/lib/rules/computed-property-spacing.js +236 -211
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -147
  95. package/lib/rules/constructor-super.js +412 -404
  96. package/lib/rules/curly.js +407 -332
  97. package/lib/rules/default-case-last.js +38 -31
  98. package/lib/rules/default-case.js +89 -85
  99. package/lib/rules/default-param-last.js +69 -54
  100. package/lib/rules/dot-location.js +122 -110
  101. package/lib/rules/dot-notation.js +192 -156
  102. package/lib/rules/eol-last.js +122 -120
  103. package/lib/rules/eqeqeq.js +168 -155
  104. package/lib/rules/for-direction.js +146 -121
  105. package/lib/rules/func-call-spacing.js +261 -231
  106. package/lib/rules/func-name-matching.js +293 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +159 -127
  109. package/lib/rules/function-call-argument-newline.js +152 -129
  110. package/lib/rules/function-paren-newline.js +349 -291
  111. package/lib/rules/generator-star-spacing.js +229 -210
  112. package/lib/rules/getter-return.js +208 -172
  113. package/lib/rules/global-require.js +85 -74
  114. package/lib/rules/grouped-accessor-pairs.js +170 -150
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -103
  117. package/lib/rules/id-blacklist.js +182 -199
  118. package/lib/rules/id-denylist.js +168 -187
  119. package/lib/rules/id-length.js +197 -171
  120. package/lib/rules/id-match.js +344 -289
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -79
  122. package/lib/rules/indent-legacy.js +1344 -1118
  123. package/lib/rules/indent.js +2272 -1759
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +137 -107
  126. package/lib/rules/jsx-quotes.js +94 -82
  127. package/lib/rules/key-spacing.js +750 -633
  128. package/lib/rules/keyword-spacing.js +648 -605
  129. package/lib/rules/line-comment-position.js +142 -128
  130. package/lib/rules/linebreak-style.js +107 -106
  131. package/lib/rules/lines-around-comment.js +540 -448
  132. package/lib/rules/lines-around-directive.js +233 -203
  133. package/lib/rules/lines-between-class-members.js +305 -234
  134. package/lib/rules/logical-assignment-operators.js +582 -399
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -434
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +78 -76
  142. package/lib/rules/max-statements-per-line.js +205 -198
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +637 -479
  145. package/lib/rules/multiline-ternary.js +241 -176
  146. package/lib/rules/new-cap.js +233 -213
  147. package/lib/rules/new-parens.js +88 -79
  148. package/lib/rules/newline-after-var.js +287 -250
  149. package/lib/rules/newline-before-return.js +229 -222
  150. package/lib/rules/newline-per-chained-call.js +142 -127
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +125 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +69 -71
  155. package/lib/rules/no-bitwise.js +124 -100
  156. package/lib/rules/no-buffer-constructor.js +55 -47
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -57
  159. package/lib/rules/no-catch-shadow.js +76 -73
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -81
  164. package/lib/rules/no-console.js +202 -199
  165. package/lib/rules/no-const-assign.js +47 -41
  166. package/lib/rules/no-constant-binary-expression.js +500 -405
  167. package/lib/rules/no-constant-condition.js +158 -143
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -27
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -41
  174. package/lib/rules/no-dupe-args.js +68 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +179 -176
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +127 -128
  183. package/lib/rules/no-empty-pattern.js +63 -58
  184. package/lib/rules/no-empty-static-block.js +37 -35
  185. package/lib/rules/no-empty.js +98 -86
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +256 -250
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -159
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -348
  192. package/lib/rules/no-extra-label.js +150 -131
  193. package/lib/rules/no-extra-parens.js +1654 -1325
  194. package/lib/rules/no-extra-semi.js +146 -144
  195. package/lib/rules/no-fallthrough.js +199 -157
  196. package/lib/rules/no-floating-decimal.js +74 -66
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -73
  199. package/lib/rules/no-implicit-coercion.js +349 -293
  200. package/lib/rules/no-implicit-globals.js +158 -135
  201. package/lib/rules/no-implied-eval.js +140 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -95
  204. package/lib/rules/no-inner-declarations.js +115 -101
  205. package/lib/rules/no-invalid-regexp.js +222 -190
  206. package/lib/rules/no-invalid-this.js +123 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -252
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -62
  210. package/lib/rules/no-labels.js +138 -133
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +108 -77
  213. package/lib/rules/no-loop-func.js +238 -213
  214. package/lib/rules/no-loss-of-precision.js +218 -201
  215. package/lib/rules/no-magic-numbers.js +246 -218
  216. package/lib/rules/no-misleading-character-class.js +499 -446
  217. package/lib/rules/no-mixed-operators.js +188 -182
  218. package/lib/rules/no-mixed-requires.js +253 -240
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +134 -121
  220. package/lib/rules/no-multi-assign.js +46 -44
  221. package/lib/rules/no-multi-spaces.js +163 -143
  222. package/lib/rules/no-multi-str.js +42 -41
  223. package/lib/rules/no-multiple-empty-lines.js +196 -158
  224. package/lib/rules/no-native-reassign.js +90 -85
  225. package/lib/rules/no-negated-condition.js +79 -75
  226. package/lib/rules/no-negated-in-lhs.js +45 -43
  227. package/lib/rules/no-nested-ternary.js +33 -32
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -48
  231. package/lib/rules/no-new-require.js +48 -47
  232. package/lib/rules/no-new-symbol.js +52 -50
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +141 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +32 -32
  240. package/lib/rules/no-param-reassign.js +235 -217
  241. package/lib/rules/no-path-concat.js +66 -67
  242. package/lib/rules/no-plusplus.js +60 -61
  243. package/lib/rules/no-process-env.js +49 -48
  244. package/lib/rules/no-process-exit.js +54 -50
  245. package/lib/rules/no-promise-executor-return.js +214 -182
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -152
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -185
  251. package/lib/rules/no-restricted-globals.js +111 -112
  252. package/lib/rules/no-restricted-imports.js +657 -537
  253. package/lib/rules/no-restricted-modules.js +222 -202
  254. package/lib/rules/no-restricted-properties.js +181 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +55 -50
  257. package/lib/rules/no-return-await.js +148 -124
  258. package/lib/rules/no-script-url.js +52 -45
  259. package/lib/rules/no-self-assign.js +148 -146
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -116
  262. package/lib/rules/no-setter-return.js +185 -152
  263. package/lib/rules/no-shadow-restricted-names.js +61 -46
  264. package/lib/rules/no-shadow.js +342 -316
  265. package/lib/rules/no-spaced-func.js +82 -77
  266. package/lib/rules/no-sparse-arrays.js +54 -59
  267. package/lib/rules/no-sync.js +61 -60
  268. package/lib/rules/no-tabs.js +83 -72
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -29
  271. package/lib/rules/no-this-before-super.js +321 -319
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +199 -191
  274. package/lib/rules/no-undef-init.js +76 -61
  275. package/lib/rules/no-undef.js +51 -48
  276. package/lib/rules/no-undefined.js +73 -75
  277. package/lib/rules/no-underscore-dangle.js +370 -327
  278. package/lib/rules/no-unexpected-multiline.js +112 -102
  279. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  280. package/lib/rules/no-unneeded-ternary.js +212 -147
  281. package/lib/rules/no-unreachable-loop.js +145 -142
  282. package/lib/rules/no-unreachable.js +255 -248
  283. package/lib/rules/no-unsafe-finally.js +93 -85
  284. package/lib/rules/no-unsafe-negation.js +105 -83
  285. package/lib/rules/no-unsafe-optional-chaining.js +192 -178
  286. package/lib/rules/no-unused-expressions.js +178 -162
  287. package/lib/rules/no-unused-labels.js +139 -124
  288. package/lib/rules/no-unused-private-class-members.js +206 -182
  289. package/lib/rules/no-unused-vars.js +1669 -1449
  290. package/lib/rules/no-use-before-define.js +229 -231
  291. package/lib/rules/no-useless-assignment.js +590 -511
  292. package/lib/rules/no-useless-backreference.js +212 -193
  293. package/lib/rules/no-useless-call.js +58 -53
  294. package/lib/rules/no-useless-catch.js +40 -40
  295. package/lib/rules/no-useless-computed-key.js +144 -115
  296. package/lib/rules/no-useless-concat.js +65 -60
  297. package/lib/rules/no-useless-constructor.js +158 -111
  298. package/lib/rules/no-useless-escape.js +342 -291
  299. package/lib/rules/no-useless-rename.js +183 -156
  300. package/lib/rules/no-useless-return.js +344 -312
  301. package/lib/rules/no-var.js +233 -212
  302. package/lib/rules/no-void.js +50 -48
  303. package/lib/rules/no-warning-comments.js +191 -186
  304. package/lib/rules/no-whitespace-before-property.js +131 -115
  305. package/lib/rules/no-with.js +24 -26
  306. package/lib/rules/nonblock-statement-body-position.js +149 -130
  307. package/lib/rules/object-curly-newline.js +306 -265
  308. package/lib/rules/object-curly-spacing.js +360 -314
  309. package/lib/rules/object-property-newline.js +137 -106
  310. package/lib/rules/object-shorthand.js +607 -502
  311. package/lib/rules/one-var-declaration-per-line.js +104 -100
  312. package/lib/rules/one-var.js +653 -537
  313. package/lib/rules/operator-assignment.js +219 -161
  314. package/lib/rules/operator-linebreak.js +295 -251
  315. package/lib/rules/padded-blocks.js +346 -308
  316. package/lib/rules/padding-line-between-statements.js +443 -439
  317. package/lib/rules/prefer-arrow-callback.js +362 -313
  318. package/lib/rules/prefer-const.js +418 -377
  319. package/lib/rules/prefer-destructuring.js +301 -279
  320. package/lib/rules/prefer-exponentiation-operator.js +176 -133
  321. package/lib/rules/prefer-named-capture-group.js +153 -140
  322. package/lib/rules/prefer-numeric-literals.js +121 -113
  323. package/lib/rules/prefer-object-has-own.js +116 -82
  324. package/lib/rules/prefer-object-spread.js +213 -193
  325. package/lib/rules/prefer-promise-reject-errors.js +140 -122
  326. package/lib/rules/prefer-reflect.js +127 -107
  327. package/lib/rules/prefer-regex-literals.js +578 -466
  328. package/lib/rules/prefer-rest-params.js +79 -80
  329. package/lib/rules/prefer-spread.js +47 -44
  330. package/lib/rules/prefer-template.js +266 -195
  331. package/lib/rules/quote-props.js +373 -307
  332. package/lib/rules/quotes.js +374 -326
  333. package/lib/rules/radix.js +152 -136
  334. package/lib/rules/require-atomic-updates.js +316 -285
  335. package/lib/rules/require-await.js +144 -116
  336. package/lib/rules/require-unicode-regexp.js +282 -177
  337. package/lib/rules/require-yield.js +53 -54
  338. package/lib/rules/rest-spread-spacing.js +128 -116
  339. package/lib/rules/semi-spacing.js +281 -250
  340. package/lib/rules/semi-style.js +176 -134
  341. package/lib/rules/semi.js +456 -436
  342. package/lib/rules/sort-imports.js +306 -233
  343. package/lib/rules/sort-keys.js +219 -188
  344. package/lib/rules/sort-vars.js +127 -93
  345. package/lib/rules/space-before-blocks.js +199 -189
  346. package/lib/rules/space-before-function-paren.js +186 -166
  347. package/lib/rules/space-in-parens.js +359 -288
  348. package/lib/rules/space-infix-ops.js +237 -201
  349. package/lib/rules/space-unary-ops.js +356 -298
  350. package/lib/rules/spaced-comment.js +363 -319
  351. package/lib/rules/strict.js +265 -230
  352. package/lib/rules/switch-colon-spacing.js +130 -122
  353. package/lib/rules/symbol-description.js +45 -48
  354. package/lib/rules/template-curly-spacing.js +148 -142
  355. package/lib/rules/template-tag-spacing.js +98 -88
  356. package/lib/rules/unicode-bom.js +54 -56
  357. package/lib/rules/use-isnan.js +237 -206
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +153 -111
  370. package/lib/rules/vars-on-top.js +152 -145
  371. package/lib/rules/wrap-iife.js +204 -191
  372. package/lib/rules/wrap-regex.js +70 -58
  373. package/lib/rules/yield-star-spacing.js +145 -134
  374. package/lib/rules/yoda.js +283 -272
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/services/suppressions-service.js +289 -0
  378. package/lib/shared/ajv.js +14 -14
  379. package/lib/shared/assert.js +3 -4
  380. package/lib/shared/ast-utils.js +7 -6
  381. package/lib/shared/deep-merge-arrays.js +24 -22
  382. package/lib/shared/directives.js +3 -2
  383. package/lib/shared/flags.js +50 -17
  384. package/lib/shared/logging.js +24 -25
  385. package/lib/shared/option-utils.js +43 -36
  386. package/lib/shared/runtime-info.js +136 -127
  387. package/lib/shared/serialization.js +27 -27
  388. package/lib/shared/severity.js +22 -22
  389. package/lib/shared/stats.js +5 -5
  390. package/lib/shared/string-utils.js +16 -16
  391. package/lib/shared/text-table.js +28 -27
  392. package/lib/shared/traverser.js +153 -146
  393. package/lib/shared/types.js +4 -27
  394. package/lib/types/index.d.ts +2010 -1559
  395. package/lib/types/rules.d.ts +5253 -5140
  396. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  397. package/lib/unsupported-api.js +5 -5
  398. package/messages/all-files-ignored.js +3 -3
  399. package/messages/all-matched-files-ignored.js +3 -3
  400. package/messages/config-file-missing.js +2 -2
  401. package/messages/config-plugin-missing.js +3 -3
  402. package/messages/config-serialize-function.js +9 -7
  403. package/messages/eslintrc-incompat.js +13 -15
  404. package/messages/eslintrc-plugins.js +3 -4
  405. package/messages/extend-config-missing.js +3 -3
  406. package/messages/failed-to-read-json.js +3 -3
  407. package/messages/file-not-found.js +3 -3
  408. package/messages/invalid-rule-options.js +2 -2
  409. package/messages/invalid-rule-severity.js +2 -2
  410. package/messages/no-config-found.js +3 -3
  411. package/messages/plugin-conflict.js +8 -8
  412. package/messages/plugin-invalid.js +3 -3
  413. package/messages/plugin-missing.js +3 -3
  414. package/messages/print-config-with-directory-path.js +2 -2
  415. package/messages/shared.js +6 -1
  416. package/messages/whitespace-found.js +3 -3
  417. package/package.json +14 -20
@@ -13,14 +13,15 @@
13
13
  const path = require("node:path");
14
14
  const fs = require("node:fs");
15
15
  const { promisify } = require("node:util");
16
- const { CLIEngine, getCLIEngineInternalSlots } = require("../cli-engine/cli-engine");
16
+ const {
17
+ CLIEngine,
18
+ getCLIEngineInternalSlots,
19
+ } = require("../cli-engine/cli-engine");
17
20
  const BuiltinRules = require("../rules");
18
21
  const {
19
- Legacy: {
20
- ConfigOps: {
21
- getRuleSeverity
22
- }
23
- }
22
+ Legacy: {
23
+ ConfigOps: { getRuleSeverity },
24
+ },
24
25
  } = require("@eslint/eslintrc");
25
26
  const { version } = require("../../package.json");
26
27
 
@@ -34,7 +35,7 @@ const { version } = require("../../package.json");
34
35
  /** @typedef {import("../shared/types").LintMessage} LintMessage */
35
36
  /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
36
37
  /** @typedef {import("../shared/types").Plugin} Plugin */
37
- /** @typedef {import("../shared/types").Rule} Rule */
38
+ /** @typedef {import("../types").Rule.RuleModule} Rule */
38
39
  /** @typedef {import("../shared/types").LintResult} LintResult */
39
40
  /** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
40
41
 
@@ -103,7 +104,7 @@ const privateMembersMap = new WeakMap();
103
104
  * @returns {boolean} `true` if `value` is a non-empty string.
104
105
  */
105
106
  function isNonEmptyString(value) {
106
- return typeof value === "string" && value.trim() !== "";
107
+ return typeof value === "string" && value.trim() !== "";
107
108
  }
108
109
 
109
110
  /**
@@ -112,7 +113,9 @@ function isNonEmptyString(value) {
112
113
  * @returns {boolean} `true` if `value` is an array of non-empty strings.
113
114
  */
114
115
  function isArrayOfNonEmptyString(value) {
115
- return Array.isArray(value) && value.length && value.every(isNonEmptyString);
116
+ return (
117
+ Array.isArray(value) && value.length && value.every(isNonEmptyString)
118
+ );
116
119
  }
117
120
 
118
121
  /**
@@ -122,7 +125,7 @@ function isArrayOfNonEmptyString(value) {
122
125
  * strings.
123
126
  */
124
127
  function isEmptyArrayOrArrayOfNonEmptyString(value) {
125
- return Array.isArray(value) && value.every(isNonEmptyString);
128
+ return Array.isArray(value) && value.every(isNonEmptyString);
126
129
  }
127
130
 
128
131
  /**
@@ -131,7 +134,12 @@ function isEmptyArrayOrArrayOfNonEmptyString(value) {
131
134
  * @returns {boolean} `true` if `value` is valid fix type.
132
135
  */
133
136
  function isFixType(value) {
134
- return value === "directive" || value === "problem" || value === "suggestion" || value === "layout";
137
+ return (
138
+ value === "directive" ||
139
+ value === "problem" ||
140
+ value === "suggestion" ||
141
+ value === "layout"
142
+ );
135
143
  }
136
144
 
137
145
  /**
@@ -140,18 +148,18 @@ function isFixType(value) {
140
148
  * @returns {boolean} `true` if `value` is an array of fix types.
141
149
  */
142
150
  function isFixTypeArray(value) {
143
- return Array.isArray(value) && value.every(isFixType);
151
+ return Array.isArray(value) && value.every(isFixType);
144
152
  }
145
153
 
146
154
  /**
147
155
  * The error for invalid options.
148
156
  */
149
157
  class ESLintInvalidOptionsError extends Error {
150
- constructor(messages) {
151
- super(`Invalid Options:\n- ${messages.join("\n- ")}`);
152
- this.code = "ESLINT_INVALID_OPTIONS";
153
- Error.captureStackTrace(this, ESLintInvalidOptionsError);
154
- }
158
+ constructor(messages) {
159
+ super(`Invalid Options:\n- ${messages.join("\n- ")}`);
160
+ this.code = "ESLINT_INVALID_OPTIONS";
161
+ Error.captureStackTrace(this, ESLintInvalidOptionsError);
162
+ }
155
163
  }
156
164
 
157
165
  /**
@@ -161,182 +169,208 @@ class ESLintInvalidOptionsError extends Error {
161
169
  * @returns {LegacyESLintOptions} The normalized options.
162
170
  */
163
171
  function processOptions({
164
- allowInlineConfig = true, // ← we cannot use `overrideConfig.noInlineConfig` instead because `allowInlineConfig` has side-effect that suppress warnings that show inline configs are ignored.
165
- baseConfig = null,
166
- cache = false,
167
- cacheLocation = ".eslintcache",
168
- cacheStrategy = "metadata",
169
- cwd = process.cwd(),
170
- errorOnUnmatchedPattern = true,
171
- extensions = null, // ← should be null by default because if it's an array then it suppresses RFC20 feature.
172
- fix = false,
173
- fixTypes = null, // ← should be null by default because if it's an array then it suppresses rules that don't have the `meta.type` property.
174
- flags, /* eslint-disable-line no-unused-vars -- leaving for compatibility with ESLint#hasFlag */
175
- globInputPaths = true,
176
- ignore = true,
177
- ignorePath = null, // ← should be null by default because if it's a string then it may throw ENOENT.
178
- overrideConfig = null,
179
- overrideConfigFile = null,
180
- plugins = {},
181
- reportUnusedDisableDirectives = null, // ← should be null by default because if it's a string then it overrides the 'reportUnusedDisableDirectives' setting in config files. And we cannot use `overrideConfig.reportUnusedDisableDirectives` instead because we cannot configure the `error` severity with that.
182
- resolvePluginsRelativeTo = null, // ← should be null by default because if it's a string then it suppresses RFC47 feature.
183
- rulePaths = [],
184
- useEslintrc = true,
185
- passOnNoPatterns = false,
186
- ...unknownOptions
172
+ allowInlineConfig = true, // ← we cannot use `overrideConfig.noInlineConfig` instead because `allowInlineConfig` has side-effect that suppress warnings that show inline configs are ignored.
173
+ baseConfig = null,
174
+ cache = false,
175
+ cacheLocation = ".eslintcache",
176
+ cacheStrategy = "metadata",
177
+ cwd = process.cwd(),
178
+ errorOnUnmatchedPattern = true,
179
+ extensions = null, // ← should be null by default because if it's an array then it suppresses RFC20 feature.
180
+ fix = false,
181
+ fixTypes = null, // ← should be null by default because if it's an array then it suppresses rules that don't have the `meta.type` property.
182
+ flags /* eslint-disable-line no-unused-vars -- leaving for compatibility with ESLint#hasFlag */,
183
+ globInputPaths = true,
184
+ ignore = true,
185
+ ignorePath = null, // ← should be null by default because if it's a string then it may throw ENOENT.
186
+ overrideConfig = null,
187
+ overrideConfigFile = null,
188
+ plugins = {},
189
+ reportUnusedDisableDirectives = null, // ← should be null by default because if it's a string then it overrides the 'reportUnusedDisableDirectives' setting in config files. And we cannot use `overrideConfig.reportUnusedDisableDirectives` instead because we cannot configure the `error` severity with that.
190
+ resolvePluginsRelativeTo = null, // ← should be null by default because if it's a string then it suppresses RFC47 feature.
191
+ rulePaths = [],
192
+ useEslintrc = true,
193
+ passOnNoPatterns = false,
194
+ ...unknownOptions
187
195
  }) {
188
- const errors = [];
189
- const unknownOptionKeys = Object.keys(unknownOptions);
190
-
191
- if (unknownOptionKeys.length >= 1) {
192
- errors.push(`Unknown options: ${unknownOptionKeys.join(", ")}`);
193
- if (unknownOptionKeys.includes("cacheFile")) {
194
- errors.push("'cacheFile' has been removed. Please use the 'cacheLocation' option instead.");
195
- }
196
- if (unknownOptionKeys.includes("configFile")) {
197
- errors.push("'configFile' has been removed. Please use the 'overrideConfigFile' option instead.");
198
- }
199
- if (unknownOptionKeys.includes("envs")) {
200
- errors.push("'envs' has been removed. Please use the 'overrideConfig.env' option instead.");
201
- }
202
- if (unknownOptionKeys.includes("globals")) {
203
- errors.push("'globals' has been removed. Please use the 'overrideConfig.globals' option instead.");
204
- }
205
- if (unknownOptionKeys.includes("ignorePattern")) {
206
- errors.push("'ignorePattern' has been removed. Please use the 'overrideConfig.ignorePatterns' option instead.");
207
- }
208
- if (unknownOptionKeys.includes("parser")) {
209
- errors.push("'parser' has been removed. Please use the 'overrideConfig.parser' option instead.");
210
- }
211
- if (unknownOptionKeys.includes("parserOptions")) {
212
- errors.push("'parserOptions' has been removed. Please use the 'overrideConfig.parserOptions' option instead.");
213
- }
214
- if (unknownOptionKeys.includes("rules")) {
215
- errors.push("'rules' has been removed. Please use the 'overrideConfig.rules' option instead.");
216
- }
217
- }
218
- if (typeof allowInlineConfig !== "boolean") {
219
- errors.push("'allowInlineConfig' must be a boolean.");
220
- }
221
- if (typeof baseConfig !== "object") {
222
- errors.push("'baseConfig' must be an object or null.");
223
- }
224
- if (typeof cache !== "boolean") {
225
- errors.push("'cache' must be a boolean.");
226
- }
227
- if (!isNonEmptyString(cacheLocation)) {
228
- errors.push("'cacheLocation' must be a non-empty string.");
229
- }
230
- if (
231
- cacheStrategy !== "metadata" &&
232
- cacheStrategy !== "content"
233
- ) {
234
- errors.push("'cacheStrategy' must be any of \"metadata\", \"content\".");
235
- }
236
- if (!isNonEmptyString(cwd) || !path.isAbsolute(cwd)) {
237
- errors.push("'cwd' must be an absolute path.");
238
- }
239
- if (typeof errorOnUnmatchedPattern !== "boolean") {
240
- errors.push("'errorOnUnmatchedPattern' must be a boolean.");
241
- }
242
- if (!isEmptyArrayOrArrayOfNonEmptyString(extensions) && extensions !== null) {
243
- errors.push("'extensions' must be an array of non-empty strings or null.");
244
- }
245
- if (typeof fix !== "boolean" && typeof fix !== "function") {
246
- errors.push("'fix' must be a boolean or a function.");
247
- }
248
- if (fixTypes !== null && !isFixTypeArray(fixTypes)) {
249
- errors.push("'fixTypes' must be an array of any of \"directive\", \"problem\", \"suggestion\", and \"layout\".");
250
- }
251
- if (typeof globInputPaths !== "boolean") {
252
- errors.push("'globInputPaths' must be a boolean.");
253
- }
254
- if (typeof ignore !== "boolean") {
255
- errors.push("'ignore' must be a boolean.");
256
- }
257
- if (!isNonEmptyString(ignorePath) && ignorePath !== null) {
258
- errors.push("'ignorePath' must be a non-empty string or null.");
259
- }
260
- if (typeof overrideConfig !== "object") {
261
- errors.push("'overrideConfig' must be an object or null.");
262
- }
263
- if (!isNonEmptyString(overrideConfigFile) && overrideConfigFile !== null) {
264
- errors.push("'overrideConfigFile' must be a non-empty string or null.");
265
- }
266
- if (typeof plugins !== "object") {
267
- errors.push("'plugins' must be an object or null.");
268
- } else if (plugins !== null && Object.keys(plugins).includes("")) {
269
- errors.push("'plugins' must not include an empty string.");
270
- }
271
- if (Array.isArray(plugins)) {
272
- errors.push("'plugins' doesn't add plugins to configuration to load. Please use the 'overrideConfig.plugins' option instead.");
273
- }
274
- if (
275
- reportUnusedDisableDirectives !== "error" &&
276
- reportUnusedDisableDirectives !== "warn" &&
277
- reportUnusedDisableDirectives !== "off" &&
278
- reportUnusedDisableDirectives !== null
279
- ) {
280
- errors.push("'reportUnusedDisableDirectives' must be any of \"error\", \"warn\", \"off\", and null.");
281
- }
282
- if (
283
- !isNonEmptyString(resolvePluginsRelativeTo) &&
284
- resolvePluginsRelativeTo !== null
285
- ) {
286
- errors.push("'resolvePluginsRelativeTo' must be a non-empty string or null.");
287
- }
288
- if (!isEmptyArrayOrArrayOfNonEmptyString(rulePaths)) {
289
- errors.push("'rulePaths' must be an array of non-empty strings.");
290
- }
291
- if (typeof useEslintrc !== "boolean") {
292
- errors.push("'useEslintrc' must be a boolean.");
293
- }
294
- if (typeof passOnNoPatterns !== "boolean") {
295
- errors.push("'passOnNoPatterns' must be a boolean.");
296
- }
297
-
298
- if (errors.length > 0) {
299
- throw new ESLintInvalidOptionsError(errors);
300
- }
301
-
302
- return {
303
- allowInlineConfig,
304
- baseConfig,
305
- cache,
306
- cacheLocation,
307
- cacheStrategy,
308
- configFile: overrideConfigFile,
309
- cwd: path.normalize(cwd),
310
- errorOnUnmatchedPattern,
311
- extensions,
312
- fix,
313
- fixTypes,
314
- flags: [], // LegacyESLint does not support flags, so just ignore them.
315
- globInputPaths,
316
- ignore,
317
- ignorePath,
318
- reportUnusedDisableDirectives,
319
- resolvePluginsRelativeTo,
320
- rulePaths,
321
- useEslintrc,
322
- passOnNoPatterns
323
- };
196
+ const errors = [];
197
+ const unknownOptionKeys = Object.keys(unknownOptions);
198
+
199
+ if (unknownOptionKeys.length >= 1) {
200
+ errors.push(`Unknown options: ${unknownOptionKeys.join(", ")}`);
201
+ if (unknownOptionKeys.includes("cacheFile")) {
202
+ errors.push(
203
+ "'cacheFile' has been removed. Please use the 'cacheLocation' option instead.",
204
+ );
205
+ }
206
+ if (unknownOptionKeys.includes("configFile")) {
207
+ errors.push(
208
+ "'configFile' has been removed. Please use the 'overrideConfigFile' option instead.",
209
+ );
210
+ }
211
+ if (unknownOptionKeys.includes("envs")) {
212
+ errors.push(
213
+ "'envs' has been removed. Please use the 'overrideConfig.env' option instead.",
214
+ );
215
+ }
216
+ if (unknownOptionKeys.includes("globals")) {
217
+ errors.push(
218
+ "'globals' has been removed. Please use the 'overrideConfig.globals' option instead.",
219
+ );
220
+ }
221
+ if (unknownOptionKeys.includes("ignorePattern")) {
222
+ errors.push(
223
+ "'ignorePattern' has been removed. Please use the 'overrideConfig.ignorePatterns' option instead.",
224
+ );
225
+ }
226
+ if (unknownOptionKeys.includes("parser")) {
227
+ errors.push(
228
+ "'parser' has been removed. Please use the 'overrideConfig.parser' option instead.",
229
+ );
230
+ }
231
+ if (unknownOptionKeys.includes("parserOptions")) {
232
+ errors.push(
233
+ "'parserOptions' has been removed. Please use the 'overrideConfig.parserOptions' option instead.",
234
+ );
235
+ }
236
+ if (unknownOptionKeys.includes("rules")) {
237
+ errors.push(
238
+ "'rules' has been removed. Please use the 'overrideConfig.rules' option instead.",
239
+ );
240
+ }
241
+ }
242
+ if (typeof allowInlineConfig !== "boolean") {
243
+ errors.push("'allowInlineConfig' must be a boolean.");
244
+ }
245
+ if (typeof baseConfig !== "object") {
246
+ errors.push("'baseConfig' must be an object or null.");
247
+ }
248
+ if (typeof cache !== "boolean") {
249
+ errors.push("'cache' must be a boolean.");
250
+ }
251
+ if (!isNonEmptyString(cacheLocation)) {
252
+ errors.push("'cacheLocation' must be a non-empty string.");
253
+ }
254
+ if (cacheStrategy !== "metadata" && cacheStrategy !== "content") {
255
+ errors.push('\'cacheStrategy\' must be any of "metadata", "content".');
256
+ }
257
+ if (!isNonEmptyString(cwd) || !path.isAbsolute(cwd)) {
258
+ errors.push("'cwd' must be an absolute path.");
259
+ }
260
+ if (typeof errorOnUnmatchedPattern !== "boolean") {
261
+ errors.push("'errorOnUnmatchedPattern' must be a boolean.");
262
+ }
263
+ if (
264
+ !isEmptyArrayOrArrayOfNonEmptyString(extensions) &&
265
+ extensions !== null
266
+ ) {
267
+ errors.push(
268
+ "'extensions' must be an array of non-empty strings or null.",
269
+ );
270
+ }
271
+ if (typeof fix !== "boolean" && typeof fix !== "function") {
272
+ errors.push("'fix' must be a boolean or a function.");
273
+ }
274
+ if (fixTypes !== null && !isFixTypeArray(fixTypes)) {
275
+ errors.push(
276
+ '\'fixTypes\' must be an array of any of "directive", "problem", "suggestion", and "layout".',
277
+ );
278
+ }
279
+ if (typeof globInputPaths !== "boolean") {
280
+ errors.push("'globInputPaths' must be a boolean.");
281
+ }
282
+ if (typeof ignore !== "boolean") {
283
+ errors.push("'ignore' must be a boolean.");
284
+ }
285
+ if (!isNonEmptyString(ignorePath) && ignorePath !== null) {
286
+ errors.push("'ignorePath' must be a non-empty string or null.");
287
+ }
288
+ if (typeof overrideConfig !== "object") {
289
+ errors.push("'overrideConfig' must be an object or null.");
290
+ }
291
+ if (!isNonEmptyString(overrideConfigFile) && overrideConfigFile !== null) {
292
+ errors.push("'overrideConfigFile' must be a non-empty string or null.");
293
+ }
294
+ if (typeof plugins !== "object") {
295
+ errors.push("'plugins' must be an object or null.");
296
+ } else if (plugins !== null && Object.keys(plugins).includes("")) {
297
+ errors.push("'plugins' must not include an empty string.");
298
+ }
299
+ if (Array.isArray(plugins)) {
300
+ errors.push(
301
+ "'plugins' doesn't add plugins to configuration to load. Please use the 'overrideConfig.plugins' option instead.",
302
+ );
303
+ }
304
+ if (
305
+ reportUnusedDisableDirectives !== "error" &&
306
+ reportUnusedDisableDirectives !== "warn" &&
307
+ reportUnusedDisableDirectives !== "off" &&
308
+ reportUnusedDisableDirectives !== null
309
+ ) {
310
+ errors.push(
311
+ '\'reportUnusedDisableDirectives\' must be any of "error", "warn", "off", and null.',
312
+ );
313
+ }
314
+ if (
315
+ !isNonEmptyString(resolvePluginsRelativeTo) &&
316
+ resolvePluginsRelativeTo !== null
317
+ ) {
318
+ errors.push(
319
+ "'resolvePluginsRelativeTo' must be a non-empty string or null.",
320
+ );
321
+ }
322
+ if (!isEmptyArrayOrArrayOfNonEmptyString(rulePaths)) {
323
+ errors.push("'rulePaths' must be an array of non-empty strings.");
324
+ }
325
+ if (typeof useEslintrc !== "boolean") {
326
+ errors.push("'useEslintrc' must be a boolean.");
327
+ }
328
+ if (typeof passOnNoPatterns !== "boolean") {
329
+ errors.push("'passOnNoPatterns' must be a boolean.");
330
+ }
331
+
332
+ if (errors.length > 0) {
333
+ throw new ESLintInvalidOptionsError(errors);
334
+ }
335
+
336
+ return {
337
+ allowInlineConfig,
338
+ baseConfig,
339
+ cache,
340
+ cacheLocation,
341
+ cacheStrategy,
342
+ configFile: overrideConfigFile,
343
+ cwd: path.normalize(cwd),
344
+ errorOnUnmatchedPattern,
345
+ extensions,
346
+ fix,
347
+ fixTypes,
348
+ flags: [], // LegacyESLint does not support flags, so just ignore them.
349
+ globInputPaths,
350
+ ignore,
351
+ ignorePath,
352
+ reportUnusedDisableDirectives,
353
+ resolvePluginsRelativeTo,
354
+ rulePaths,
355
+ useEslintrc,
356
+ passOnNoPatterns,
357
+ };
324
358
  }
325
359
 
326
360
  /**
327
361
  * Check if a value has one or more properties and that value is not undefined.
328
362
  * @param {any} obj The value to check.
329
- * @returns {boolean} `true` if `obj` has one or more properties that that value is not undefined.
363
+ * @returns {boolean} `true` if `obj` has one or more properties that value is not undefined.
330
364
  */
331
365
  function hasDefinedProperty(obj) {
332
- if (typeof obj === "object" && obj !== null) {
333
- for (const key in obj) {
334
- if (typeof obj[key] !== "undefined") {
335
- return true;
336
- }
337
- }
338
- }
339
- return false;
366
+ if (typeof obj === "object" && obj !== null) {
367
+ for (const key in obj) {
368
+ if (typeof obj[key] !== "undefined") {
369
+ return true;
370
+ }
371
+ }
372
+ }
373
+ return false;
340
374
  }
341
375
 
342
376
  /**
@@ -345,10 +379,10 @@ function hasDefinedProperty(obj) {
345
379
  * @returns {Object} metadata for all enabled rules.
346
380
  */
347
381
  function createRulesMeta(rules) {
348
- return Array.from(rules).reduce((retVal, [id, rule]) => {
349
- retVal[id] = rule.meta;
350
- return retVal;
351
- }, {});
382
+ return Array.from(rules).reduce((retVal, [id, rule]) => {
383
+ retVal[id] = rule.meta;
384
+ return retVal;
385
+ }, {});
352
386
  }
353
387
 
354
388
  /** @type {WeakMap<ExtractedConfig, DeprecatedRuleInfo[]>} */
@@ -361,37 +395,37 @@ const usedDeprecatedRulesCache = new WeakMap();
361
395
  * @returns {DeprecatedRuleInfo[]} The used deprecated rule list.
362
396
  */
363
397
  function getOrFindUsedDeprecatedRules(cliEngine, maybeFilePath) {
364
- const {
365
- configArrayFactory,
366
- options: { cwd }
367
- } = getCLIEngineInternalSlots(cliEngine);
368
- const filePath = path.isAbsolute(maybeFilePath)
369
- ? maybeFilePath
370
- : path.join(cwd, "__placeholder__.js");
371
- const configArray = configArrayFactory.getConfigArrayForFile(filePath);
372
- const config = configArray.extractConfig(filePath);
373
-
374
- // Most files use the same config, so cache it.
375
- if (!usedDeprecatedRulesCache.has(config)) {
376
- const pluginRules = configArray.pluginRules;
377
- const retv = [];
378
-
379
- for (const [ruleId, ruleConf] of Object.entries(config.rules)) {
380
- if (getRuleSeverity(ruleConf) === 0) {
381
- continue;
382
- }
383
- const rule = pluginRules.get(ruleId) || BuiltinRules.get(ruleId);
384
- const meta = rule && rule.meta;
385
-
386
- if (meta && meta.deprecated) {
387
- retv.push({ ruleId, replacedBy: meta.replacedBy || [] });
388
- }
389
- }
390
-
391
- usedDeprecatedRulesCache.set(config, Object.freeze(retv));
392
- }
393
-
394
- return usedDeprecatedRulesCache.get(config);
398
+ const {
399
+ configArrayFactory,
400
+ options: { cwd },
401
+ } = getCLIEngineInternalSlots(cliEngine);
402
+ const filePath = path.isAbsolute(maybeFilePath)
403
+ ? maybeFilePath
404
+ : path.join(cwd, "__placeholder__.js");
405
+ const configArray = configArrayFactory.getConfigArrayForFile(filePath);
406
+ const config = configArray.extractConfig(filePath);
407
+
408
+ // Most files use the same config, so cache it.
409
+ if (!usedDeprecatedRulesCache.has(config)) {
410
+ const pluginRules = configArray.pluginRules;
411
+ const retv = [];
412
+
413
+ for (const [ruleId, ruleConf] of Object.entries(config.rules)) {
414
+ if (getRuleSeverity(ruleConf) === 0) {
415
+ continue;
416
+ }
417
+ const rule = pluginRules.get(ruleId) || BuiltinRules.get(ruleId);
418
+ const meta = rule && rule.meta;
419
+
420
+ if (meta && meta.deprecated) {
421
+ retv.push({ ruleId, replacedBy: meta.replacedBy || [] });
422
+ }
423
+ }
424
+
425
+ usedDeprecatedRulesCache.set(config, Object.freeze(retv));
426
+ }
427
+
428
+ return usedDeprecatedRulesCache.get(config);
395
429
  }
396
430
 
397
431
  /**
@@ -402,19 +436,19 @@ function getOrFindUsedDeprecatedRules(cliEngine, maybeFilePath) {
402
436
  * @returns {LintResult[]} The processed linting results.
403
437
  */
404
438
  function processCLIEngineLintReport(cliEngine, { results }) {
405
- const descriptor = {
406
- configurable: true,
407
- enumerable: true,
408
- get() {
409
- return getOrFindUsedDeprecatedRules(cliEngine, this.filePath);
410
- }
411
- };
412
-
413
- for (const result of results) {
414
- Object.defineProperty(result, "usedDeprecatedRules", descriptor);
415
- }
416
-
417
- return results;
439
+ const descriptor = {
440
+ configurable: true,
441
+ enumerable: true,
442
+ get() {
443
+ return getOrFindUsedDeprecatedRules(cliEngine, this.filePath);
444
+ },
445
+ };
446
+
447
+ for (const result of results) {
448
+ Object.defineProperty(result, "usedDeprecatedRules", descriptor);
449
+ }
450
+
451
+ return results;
418
452
  }
419
453
 
420
454
  /**
@@ -424,304 +458,314 @@ function processCLIEngineLintReport(cliEngine, { results }) {
424
458
  * @returns {number} An integer representing the order in which the two results should occur.
425
459
  */
426
460
  function compareResultsByFilePath(a, b) {
427
- if (a.filePath < b.filePath) {
428
- return -1;
429
- }
461
+ if (a.filePath < b.filePath) {
462
+ return -1;
463
+ }
430
464
 
431
- if (a.filePath > b.filePath) {
432
- return 1;
433
- }
465
+ if (a.filePath > b.filePath) {
466
+ return 1;
467
+ }
434
468
 
435
- return 0;
469
+ return 0;
436
470
  }
437
471
 
438
472
  /**
439
473
  * Main API.
440
474
  */
441
475
  class LegacyESLint {
442
-
443
- /**
444
- * The type of configuration used by this class.
445
- * @type {string}
446
- */
447
- static configType = "eslintrc";
448
-
449
- /**
450
- * Creates a new instance of the main ESLint API.
451
- * @param {LegacyESLintOptions} options The options for this instance.
452
- */
453
- constructor(options = {}) {
454
- const processedOptions = processOptions(options);
455
- const cliEngine = new CLIEngine(processedOptions, { preloadedPlugins: options.plugins });
456
- const {
457
- configArrayFactory,
458
- lastConfigArrays
459
- } = getCLIEngineInternalSlots(cliEngine);
460
- let updated = false;
461
-
462
- /*
463
- * Address `overrideConfig` to set override config.
464
- * Operate the `configArrayFactory` internal slot directly because this
465
- * functionality doesn't exist as the public API of CLIEngine.
466
- */
467
- if (hasDefinedProperty(options.overrideConfig)) {
468
- configArrayFactory.setOverrideConfig(options.overrideConfig);
469
- updated = true;
470
- }
471
-
472
- // Update caches.
473
- if (updated) {
474
- configArrayFactory.clearCache();
475
- lastConfigArrays[0] = configArrayFactory.getConfigArrayForFile();
476
- }
477
-
478
- // Initialize private properties.
479
- privateMembersMap.set(this, {
480
- cliEngine,
481
- options: processedOptions
482
- });
483
- }
484
-
485
- /**
486
- * The version text.
487
- * @type {string}
488
- */
489
- static get version() {
490
- return version;
491
- }
492
-
493
- /**
494
- * Outputs fixes from the given results to files.
495
- * @param {LintResult[]} results The lint results.
496
- * @returns {Promise<void>} Returns a promise that is used to track side effects.
497
- */
498
- static async outputFixes(results) {
499
- if (!Array.isArray(results)) {
500
- throw new Error("'results' must be an array");
501
- }
502
-
503
- await Promise.all(
504
- results
505
- .filter(result => {
506
- if (typeof result !== "object" || result === null) {
507
- throw new Error("'results' must include only objects");
508
- }
509
- return (
510
- typeof result.output === "string" &&
511
- path.isAbsolute(result.filePath)
512
- );
513
- })
514
- .map(r => writeFile(r.filePath, r.output))
515
- );
516
- }
517
-
518
- /**
519
- * Returns results that only contains errors.
520
- * @param {LintResult[]} results The results to filter.
521
- * @returns {LintResult[]} The filtered results.
522
- */
523
- static getErrorResults(results) {
524
- return CLIEngine.getErrorResults(results);
525
- }
526
-
527
- /**
528
- * Returns meta objects for each rule represented in the lint results.
529
- * @param {LintResult[]} results The results to fetch rules meta for.
530
- * @returns {Object} A mapping of ruleIds to rule meta objects.
531
- */
532
- getRulesMetaForResults(results) {
533
-
534
- const resultRuleIds = new Set();
535
-
536
- // first gather all ruleIds from all results
537
-
538
- for (const result of results) {
539
- for (const { ruleId } of result.messages) {
540
- resultRuleIds.add(ruleId);
541
- }
542
- for (const { ruleId } of result.suppressedMessages) {
543
- resultRuleIds.add(ruleId);
544
- }
545
- }
546
-
547
- // create a map of all rules in the results
548
-
549
- const { cliEngine } = privateMembersMap.get(this);
550
- const rules = cliEngine.getRules();
551
- const resultRules = new Map();
552
-
553
- for (const [ruleId, rule] of rules) {
554
- if (resultRuleIds.has(ruleId)) {
555
- resultRules.set(ruleId, rule);
556
- }
557
- }
558
-
559
- return createRulesMeta(resultRules);
560
-
561
- }
562
-
563
- /* eslint-disable no-unused-vars, class-methods-use-this -- leaving for compatibility with ESLint#hasFlag */
564
- /**
565
- * Indicates if the given feature flag is enabled for this instance. For this
566
- * class, this always returns `false` because it does not support feature flags.
567
- * @param {string} flag The feature flag to check.
568
- * @returns {boolean} Always false.
569
- */
570
- hasFlag(flag) {
571
- return false;
572
- }
573
- /* eslint-enable no-unused-vars, class-methods-use-this -- reenable rules for the rest of the file */
574
-
575
- /**
576
- * Executes the current configuration on an array of file and directory names.
577
- * @param {string[]} patterns An array of file and directory names.
578
- * @returns {Promise<LintResult[]>} The results of linting the file patterns given.
579
- */
580
- async lintFiles(patterns) {
581
- const { cliEngine, options } = privateMembersMap.get(this);
582
-
583
- if (options.passOnNoPatterns && (patterns === "" || (Array.isArray(patterns) && patterns.length === 0))) {
584
- return [];
585
- }
586
-
587
- if (!isNonEmptyString(patterns) && !isArrayOfNonEmptyString(patterns)) {
588
- throw new Error("'patterns' must be a non-empty string or an array of non-empty strings");
589
- }
590
-
591
- return processCLIEngineLintReport(
592
- cliEngine,
593
- cliEngine.executeOnFiles(patterns)
594
- );
595
- }
596
-
597
- /**
598
- * Executes the current configuration on text.
599
- * @param {string} code A string of JavaScript code to lint.
600
- * @param {Object} [options] The options.
601
- * @param {string} [options.filePath] The path to the file of the source code.
602
- * @param {boolean} [options.warnIgnored] When set to true, warn if given filePath is an ignored path.
603
- * @returns {Promise<LintResult[]>} The results of linting the string of code given.
604
- */
605
- async lintText(code, options = {}) {
606
- if (typeof code !== "string") {
607
- throw new Error("'code' must be a string");
608
- }
609
- if (typeof options !== "object") {
610
- throw new Error("'options' must be an object, null, or undefined");
611
- }
612
- const {
613
- filePath,
614
- warnIgnored = false,
615
- ...unknownOptions
616
- } = options || {};
617
-
618
- const unknownOptionKeys = Object.keys(unknownOptions);
619
-
620
- if (unknownOptionKeys.length > 0) {
621
- throw new Error(`'options' must not include the unknown option(s): ${unknownOptionKeys.join(", ")}`);
622
- }
623
-
624
- if (filePath !== void 0 && !isNonEmptyString(filePath)) {
625
- throw new Error("'options.filePath' must be a non-empty string or undefined");
626
- }
627
- if (typeof warnIgnored !== "boolean") {
628
- throw new Error("'options.warnIgnored' must be a boolean or undefined");
629
- }
630
-
631
- const { cliEngine } = privateMembersMap.get(this);
632
-
633
- return processCLIEngineLintReport(
634
- cliEngine,
635
- cliEngine.executeOnText(code, filePath, warnIgnored)
636
- );
637
- }
638
-
639
- /**
640
- * Returns the formatter representing the given formatter name.
641
- * @param {string} [name] The name of the formatter to load.
642
- * The following values are allowed:
643
- * - `undefined` ... Load `stylish` builtin formatter.
644
- * - A builtin formatter name ... Load the builtin formatter.
645
- * - A third-party formatter name:
646
- * - `foo` → `eslint-formatter-foo`
647
- * - `@foo` → `@foo/eslint-formatter`
648
- * - `@foo/bar` → `@foo/eslint-formatter-bar`
649
- * - A file path ... Load the file.
650
- * @returns {Promise<LoadedFormatter>} A promise resolving to the formatter object.
651
- * This promise will be rejected if the given formatter was not found or not
652
- * a function.
653
- */
654
- async loadFormatter(name = "stylish") {
655
- if (typeof name !== "string") {
656
- throw new Error("'name' must be a string");
657
- }
658
-
659
- const { cliEngine, options } = privateMembersMap.get(this);
660
- const formatter = cliEngine.getFormatter(name);
661
-
662
- if (typeof formatter !== "function") {
663
- throw new Error(`Formatter must be a function, but got a ${typeof formatter}.`);
664
- }
665
-
666
- return {
667
-
668
- /**
669
- * The main formatter method.
670
- * @param {LintResult[]} results The lint results to format.
671
- * @param {ResultsMeta} resultsMeta Warning count and max threshold.
672
- * @returns {string | Promise<string>} The formatted lint results.
673
- */
674
- format(results, resultsMeta) {
675
- let rulesMeta = null;
676
-
677
- results.sort(compareResultsByFilePath);
678
-
679
- return formatter(results, {
680
- ...resultsMeta,
681
- get cwd() {
682
- return options.cwd;
683
- },
684
- get rulesMeta() {
685
- if (!rulesMeta) {
686
- rulesMeta = createRulesMeta(cliEngine.getRules());
687
- }
688
-
689
- return rulesMeta;
690
- }
691
- });
692
- }
693
- };
694
- }
695
-
696
- /**
697
- * Returns a configuration object for the given file based on the CLI options.
698
- * This is the same logic used by the ESLint CLI executable to determine
699
- * configuration for each file it processes.
700
- * @param {string} filePath The path of the file to retrieve a config object for.
701
- * @returns {Promise<ConfigData>} A configuration object for the file.
702
- */
703
- async calculateConfigForFile(filePath) {
704
- if (!isNonEmptyString(filePath)) {
705
- throw new Error("'filePath' must be a non-empty string");
706
- }
707
- const { cliEngine } = privateMembersMap.get(this);
708
-
709
- return cliEngine.getConfigForFile(filePath);
710
- }
711
-
712
- /**
713
- * Checks if a given path is ignored by ESLint.
714
- * @param {string} filePath The path of the file to check.
715
- * @returns {Promise<boolean>} Whether or not the given path is ignored.
716
- */
717
- async isPathIgnored(filePath) {
718
- if (!isNonEmptyString(filePath)) {
719
- throw new Error("'filePath' must be a non-empty string");
720
- }
721
- const { cliEngine } = privateMembersMap.get(this);
722
-
723
- return cliEngine.isPathIgnored(filePath);
724
- }
476
+ /**
477
+ * The type of configuration used by this class.
478
+ * @type {string}
479
+ */
480
+ static configType = "eslintrc";
481
+
482
+ /**
483
+ * Creates a new instance of the main ESLint API.
484
+ * @param {LegacyESLintOptions} options The options for this instance.
485
+ */
486
+ constructor(options = {}) {
487
+ const processedOptions = processOptions(options);
488
+ const cliEngine = new CLIEngine(processedOptions, {
489
+ preloadedPlugins: options.plugins,
490
+ });
491
+ const { configArrayFactory, lastConfigArrays } =
492
+ getCLIEngineInternalSlots(cliEngine);
493
+ let updated = false;
494
+
495
+ /*
496
+ * Address `overrideConfig` to set override config.
497
+ * Operate the `configArrayFactory` internal slot directly because this
498
+ * functionality doesn't exist as the public API of CLIEngine.
499
+ */
500
+ if (hasDefinedProperty(options.overrideConfig)) {
501
+ configArrayFactory.setOverrideConfig(options.overrideConfig);
502
+ updated = true;
503
+ }
504
+
505
+ // Update caches.
506
+ if (updated) {
507
+ configArrayFactory.clearCache();
508
+ lastConfigArrays[0] = configArrayFactory.getConfigArrayForFile();
509
+ }
510
+
511
+ // Initialize private properties.
512
+ privateMembersMap.set(this, {
513
+ cliEngine,
514
+ options: processedOptions,
515
+ });
516
+ }
517
+
518
+ /**
519
+ * The version text.
520
+ * @type {string}
521
+ */
522
+ static get version() {
523
+ return version;
524
+ }
525
+
526
+ /**
527
+ * Outputs fixes from the given results to files.
528
+ * @param {LintResult[]} results The lint results.
529
+ * @returns {Promise<void>} Returns a promise that is used to track side effects.
530
+ */
531
+ static async outputFixes(results) {
532
+ if (!Array.isArray(results)) {
533
+ throw new Error("'results' must be an array");
534
+ }
535
+
536
+ await Promise.all(
537
+ results
538
+ .filter(result => {
539
+ if (typeof result !== "object" || result === null) {
540
+ throw new Error("'results' must include only objects");
541
+ }
542
+ return (
543
+ typeof result.output === "string" &&
544
+ path.isAbsolute(result.filePath)
545
+ );
546
+ })
547
+ .map(r => writeFile(r.filePath, r.output)),
548
+ );
549
+ }
550
+
551
+ /**
552
+ * Returns results that only contains errors.
553
+ * @param {LintResult[]} results The results to filter.
554
+ * @returns {LintResult[]} The filtered results.
555
+ */
556
+ static getErrorResults(results) {
557
+ return CLIEngine.getErrorResults(results);
558
+ }
559
+
560
+ /**
561
+ * Returns meta objects for each rule represented in the lint results.
562
+ * @param {LintResult[]} results The results to fetch rules meta for.
563
+ * @returns {Object} A mapping of ruleIds to rule meta objects.
564
+ */
565
+ getRulesMetaForResults(results) {
566
+ const resultRuleIds = new Set();
567
+
568
+ // first gather all ruleIds from all results
569
+
570
+ for (const result of results) {
571
+ for (const { ruleId } of result.messages) {
572
+ resultRuleIds.add(ruleId);
573
+ }
574
+ for (const { ruleId } of result.suppressedMessages) {
575
+ resultRuleIds.add(ruleId);
576
+ }
577
+ }
578
+
579
+ // create a map of all rules in the results
580
+
581
+ const { cliEngine } = privateMembersMap.get(this);
582
+ const rules = cliEngine.getRules();
583
+ const resultRules = new Map();
584
+
585
+ for (const [ruleId, rule] of rules) {
586
+ if (resultRuleIds.has(ruleId)) {
587
+ resultRules.set(ruleId, rule);
588
+ }
589
+ }
590
+
591
+ return createRulesMeta(resultRules);
592
+ }
593
+
594
+ /* eslint-disable no-unused-vars, class-methods-use-this -- leaving for compatibility with ESLint#hasFlag */
595
+ /**
596
+ * Indicates if the given feature flag is enabled for this instance. For this
597
+ * class, this always returns `false` because it does not support feature flags.
598
+ * @param {string} flag The feature flag to check.
599
+ * @returns {boolean} Always false.
600
+ */
601
+ hasFlag(flag) {
602
+ return false;
603
+ }
604
+ /* eslint-enable no-unused-vars, class-methods-use-this -- reenable rules for the rest of the file */
605
+
606
+ /**
607
+ * Executes the current configuration on an array of file and directory names.
608
+ * @param {string[]} patterns An array of file and directory names.
609
+ * @returns {Promise<LintResult[]>} The results of linting the file patterns given.
610
+ */
611
+ async lintFiles(patterns) {
612
+ const { cliEngine, options } = privateMembersMap.get(this);
613
+
614
+ if (
615
+ options.passOnNoPatterns &&
616
+ (patterns === "" ||
617
+ (Array.isArray(patterns) && patterns.length === 0))
618
+ ) {
619
+ return [];
620
+ }
621
+
622
+ if (!isNonEmptyString(patterns) && !isArrayOfNonEmptyString(patterns)) {
623
+ throw new Error(
624
+ "'patterns' must be a non-empty string or an array of non-empty strings",
625
+ );
626
+ }
627
+
628
+ return processCLIEngineLintReport(
629
+ cliEngine,
630
+ cliEngine.executeOnFiles(patterns),
631
+ );
632
+ }
633
+
634
+ /**
635
+ * Executes the current configuration on text.
636
+ * @param {string} code A string of JavaScript code to lint.
637
+ * @param {Object} [options] The options.
638
+ * @param {string} [options.filePath] The path to the file of the source code.
639
+ * @param {boolean} [options.warnIgnored] When set to true, warn if given filePath is an ignored path.
640
+ * @returns {Promise<LintResult[]>} The results of linting the string of code given.
641
+ */
642
+ async lintText(code, options = {}) {
643
+ if (typeof code !== "string") {
644
+ throw new Error("'code' must be a string");
645
+ }
646
+ if (typeof options !== "object") {
647
+ throw new Error("'options' must be an object, null, or undefined");
648
+ }
649
+ const {
650
+ filePath,
651
+ warnIgnored = false,
652
+ ...unknownOptions
653
+ } = options || {};
654
+
655
+ const unknownOptionKeys = Object.keys(unknownOptions);
656
+
657
+ if (unknownOptionKeys.length > 0) {
658
+ throw new Error(
659
+ `'options' must not include the unknown option(s): ${unknownOptionKeys.join(", ")}`,
660
+ );
661
+ }
662
+
663
+ if (filePath !== void 0 && !isNonEmptyString(filePath)) {
664
+ throw new Error(
665
+ "'options.filePath' must be a non-empty string or undefined",
666
+ );
667
+ }
668
+ if (typeof warnIgnored !== "boolean") {
669
+ throw new Error(
670
+ "'options.warnIgnored' must be a boolean or undefined",
671
+ );
672
+ }
673
+
674
+ const { cliEngine } = privateMembersMap.get(this);
675
+
676
+ return processCLIEngineLintReport(
677
+ cliEngine,
678
+ cliEngine.executeOnText(code, filePath, warnIgnored),
679
+ );
680
+ }
681
+
682
+ /**
683
+ * Returns the formatter representing the given formatter name.
684
+ * @param {string} [name] The name of the formatter to load.
685
+ * The following values are allowed:
686
+ * - `undefined` ... Load `stylish` builtin formatter.
687
+ * - A builtin formatter name ... Load the builtin formatter.
688
+ * - A third-party formatter name:
689
+ * - `foo` `eslint-formatter-foo`
690
+ * - `@foo` `@foo/eslint-formatter`
691
+ * - `@foo/bar` → `@foo/eslint-formatter-bar`
692
+ * - A file path ... Load the file.
693
+ * @returns {Promise<LoadedFormatter>} A promise resolving to the formatter object.
694
+ * This promise will be rejected if the given formatter was not found or not
695
+ * a function.
696
+ */
697
+ async loadFormatter(name = "stylish") {
698
+ if (typeof name !== "string") {
699
+ throw new Error("'name' must be a string");
700
+ }
701
+
702
+ const { cliEngine, options } = privateMembersMap.get(this);
703
+ const formatter = cliEngine.getFormatter(name);
704
+
705
+ if (typeof formatter !== "function") {
706
+ throw new Error(
707
+ `Formatter must be a function, but got a ${typeof formatter}.`,
708
+ );
709
+ }
710
+
711
+ return {
712
+ /**
713
+ * The main formatter method.
714
+ * @param {LintResult[]} results The lint results to format.
715
+ * @param {ResultsMeta} resultsMeta Warning count and max threshold.
716
+ * @returns {string | Promise<string>} The formatted lint results.
717
+ */
718
+ format(results, resultsMeta) {
719
+ let rulesMeta = null;
720
+
721
+ results.sort(compareResultsByFilePath);
722
+
723
+ return formatter(results, {
724
+ ...resultsMeta,
725
+ get cwd() {
726
+ return options.cwd;
727
+ },
728
+ get rulesMeta() {
729
+ if (!rulesMeta) {
730
+ rulesMeta = createRulesMeta(cliEngine.getRules());
731
+ }
732
+
733
+ return rulesMeta;
734
+ },
735
+ });
736
+ },
737
+ };
738
+ }
739
+
740
+ /**
741
+ * Returns a configuration object for the given file based on the CLI options.
742
+ * This is the same logic used by the ESLint CLI executable to determine
743
+ * configuration for each file it processes.
744
+ * @param {string} filePath The path of the file to retrieve a config object for.
745
+ * @returns {Promise<ConfigData>} A configuration object for the file.
746
+ */
747
+ async calculateConfigForFile(filePath) {
748
+ if (!isNonEmptyString(filePath)) {
749
+ throw new Error("'filePath' must be a non-empty string");
750
+ }
751
+ const { cliEngine } = privateMembersMap.get(this);
752
+
753
+ return cliEngine.getConfigForFile(filePath);
754
+ }
755
+
756
+ /**
757
+ * Checks if a given path is ignored by ESLint.
758
+ * @param {string} filePath The path of the file to check.
759
+ * @returns {Promise<boolean>} Whether or not the given path is ignored.
760
+ */
761
+ async isPathIgnored(filePath) {
762
+ if (!isNonEmptyString(filePath)) {
763
+ throw new Error("'filePath' must be a non-empty string");
764
+ }
765
+ const { cliEngine } = privateMembersMap.get(this);
766
+
767
+ return cliEngine.isPathIgnored(filePath);
768
+ }
725
769
  }
726
770
 
727
771
  //------------------------------------------------------------------------------
@@ -729,14 +773,14 @@ class LegacyESLint {
729
773
  //------------------------------------------------------------------------------
730
774
 
731
775
  module.exports = {
732
- LegacyESLint,
733
-
734
- /**
735
- * Get the private class members of a given ESLint instance for tests.
736
- * @param {ESLint} instance The ESLint instance to get.
737
- * @returns {ESLintPrivateMembers} The instance's private class members.
738
- */
739
- getESLintPrivateMembers(instance) {
740
- return privateMembersMap.get(instance);
741
- }
776
+ LegacyESLint,
777
+
778
+ /**
779
+ * Get the private class members of a given ESLint instance for tests.
780
+ * @param {ESLint} instance The ESLint instance to get.
781
+ * @returns {ESLintPrivateMembers} The instance's private class members.
782
+ */
783
+ getESLintPrivateMembers(instance) {
784
+ return privateMembersMap.get(instance);
785
+ },
742
786
  };