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
@@ -20,16 +20,15 @@ const path = require("node:path");
20
20
  const defaultOptions = require("../../conf/default-cli-options");
21
21
  const pkg = require("../../package.json");
22
22
 
23
-
24
23
  const {
25
- Legacy: {
26
- ConfigOps,
27
- naming,
28
- CascadingConfigArrayFactory,
29
- IgnorePattern,
30
- getUsedExtractedConfigs,
31
- ModuleResolver
32
- }
24
+ Legacy: {
25
+ ConfigOps,
26
+ naming,
27
+ CascadingConfigArrayFactory,
28
+ IgnorePattern,
29
+ getUsedExtractedConfigs,
30
+ ModuleResolver,
31
+ },
33
32
  } = require("@eslint/eslintrc");
34
33
 
35
34
  const { FileEnumerator } = require("./file-enumerator");
@@ -42,15 +41,15 @@ const LintResultCache = require("./lint-result-cache");
42
41
 
43
42
  const debug = require("debug")("eslint:cli-engine");
44
43
  const removedFormatters = new Set([
45
- "checkstyle",
46
- "codeframe",
47
- "compact",
48
- "jslint-xml",
49
- "junit",
50
- "table",
51
- "tap",
52
- "unix",
53
- "visualstudio"
44
+ "checkstyle",
45
+ "codeframe",
46
+ "compact",
47
+ "jslint-xml",
48
+ "junit",
49
+ "table",
50
+ "tap",
51
+ "unix",
52
+ "visualstudio",
54
53
  ]);
55
54
  const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
56
55
 
@@ -66,8 +65,8 @@ const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
66
65
  /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
67
66
  /** @typedef {import("../shared/types").Plugin} Plugin */
68
67
  /** @typedef {import("../shared/types").RuleConf} RuleConf */
69
- /** @typedef {import("../shared/types").Rule} Rule */
70
- /** @typedef {import("../shared/types").FormatterFunction} FormatterFunction */
68
+ /** @typedef {import("../types").Rule.RuleModule} Rule */
69
+ /** @typedef {import("../types").ESLint.FormatterFunction} FormatterFunction */
71
70
  /** @typedef {ReturnType<CascadingConfigArrayFactory.getConfigArrayForFile>} ConfigArray */
72
71
  /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
73
72
 
@@ -155,11 +154,11 @@ const internalSlotsMap = new WeakMap();
155
154
  * @throws {Error} If an invalid fix type is found.
156
155
  */
157
156
  function validateFixTypes(fixTypes) {
158
- for (const fixType of fixTypes) {
159
- if (!validFixTypes.has(fixType)) {
160
- throw new Error(`Invalid fix type "${fixType}" found.`);
161
- }
162
- }
157
+ for (const fixType of fixTypes) {
158
+ if (!validFixTypes.has(fixType)) {
159
+ throw new Error(`Invalid fix type "${fixType}" found.`);
160
+ }
161
+ }
163
162
  }
164
163
 
165
164
  /**
@@ -169,33 +168,33 @@ function validateFixTypes(fixTypes) {
169
168
  * @private
170
169
  */
171
170
  function calculateStatsPerFile(messages) {
172
- const stat = {
173
- errorCount: 0,
174
- fatalErrorCount: 0,
175
- warningCount: 0,
176
- fixableErrorCount: 0,
177
- fixableWarningCount: 0
178
- };
179
-
180
- for (let i = 0; i < messages.length; i++) {
181
- const message = messages[i];
182
-
183
- if (message.fatal || message.severity === 2) {
184
- stat.errorCount++;
185
- if (message.fatal) {
186
- stat.fatalErrorCount++;
187
- }
188
- if (message.fix) {
189
- stat.fixableErrorCount++;
190
- }
191
- } else {
192
- stat.warningCount++;
193
- if (message.fix) {
194
- stat.fixableWarningCount++;
195
- }
196
- }
197
- }
198
- return stat;
171
+ const stat = {
172
+ errorCount: 0,
173
+ fatalErrorCount: 0,
174
+ warningCount: 0,
175
+ fixableErrorCount: 0,
176
+ fixableWarningCount: 0,
177
+ };
178
+
179
+ for (let i = 0; i < messages.length; i++) {
180
+ const message = messages[i];
181
+
182
+ if (message.fatal || message.severity === 2) {
183
+ stat.errorCount++;
184
+ if (message.fatal) {
185
+ stat.fatalErrorCount++;
186
+ }
187
+ if (message.fix) {
188
+ stat.fixableErrorCount++;
189
+ }
190
+ } else {
191
+ stat.warningCount++;
192
+ if (message.fix) {
193
+ stat.fixableWarningCount++;
194
+ }
195
+ }
196
+ }
197
+ return stat;
199
198
  }
200
199
 
201
200
  /**
@@ -205,25 +204,25 @@ function calculateStatsPerFile(messages) {
205
204
  * @private
206
205
  */
207
206
  function calculateStatsPerRun(results) {
208
- const stat = {
209
- errorCount: 0,
210
- fatalErrorCount: 0,
211
- warningCount: 0,
212
- fixableErrorCount: 0,
213
- fixableWarningCount: 0
214
- };
215
-
216
- for (let i = 0; i < results.length; i++) {
217
- const result = results[i];
218
-
219
- stat.errorCount += result.errorCount;
220
- stat.fatalErrorCount += result.fatalErrorCount;
221
- stat.warningCount += result.warningCount;
222
- stat.fixableErrorCount += result.fixableErrorCount;
223
- stat.fixableWarningCount += result.fixableWarningCount;
224
- }
225
-
226
- return stat;
207
+ const stat = {
208
+ errorCount: 0,
209
+ fatalErrorCount: 0,
210
+ warningCount: 0,
211
+ fixableErrorCount: 0,
212
+ fixableWarningCount: 0,
213
+ };
214
+
215
+ for (let i = 0; i < results.length; i++) {
216
+ const result = results[i];
217
+
218
+ stat.errorCount += result.errorCount;
219
+ stat.fatalErrorCount += result.fatalErrorCount;
220
+ stat.warningCount += result.warningCount;
221
+ stat.fixableErrorCount += result.fixableErrorCount;
222
+ stat.fixableWarningCount += result.fixableWarningCount;
223
+ }
224
+
225
+ return stat;
227
226
  }
228
227
 
229
228
  /**
@@ -242,65 +241,62 @@ function calculateStatsPerRun(results) {
242
241
  * @private
243
242
  */
244
243
  function verifyText({
245
- text,
246
- cwd,
247
- filePath: providedFilePath,
248
- config,
249
- fix,
250
- allowInlineConfig,
251
- reportUnusedDisableDirectives,
252
- fileEnumerator,
253
- linter
244
+ text,
245
+ cwd,
246
+ filePath: providedFilePath,
247
+ config,
248
+ fix,
249
+ allowInlineConfig,
250
+ reportUnusedDisableDirectives,
251
+ fileEnumerator,
252
+ linter,
254
253
  }) {
255
- const filePath = providedFilePath || "<text>";
256
-
257
- debug(`Lint ${filePath}`);
258
-
259
- /*
260
- * Verify.
261
- * `config.extractConfig(filePath)` requires an absolute path, but `linter`
262
- * doesn't know CWD, so it gives `linter` an absolute path always.
263
- */
264
- const filePathToVerify = filePath === "<text>" ? path.join(cwd, filePath) : filePath;
265
- const { fixed, messages, output } = linter.verifyAndFix(
266
- text,
267
- config,
268
- {
269
- allowInlineConfig,
270
- filename: filePathToVerify,
271
- fix,
272
- reportUnusedDisableDirectives,
273
-
274
- /**
275
- * Check if the linter should adopt a given code block or not.
276
- * @param {string} blockFilename The virtual filename of a code block.
277
- * @returns {boolean} `true` if the linter should adopt the code block.
278
- */
279
- filterCodeBlock(blockFilename) {
280
- return fileEnumerator.isTargetPath(blockFilename);
281
- }
282
- }
283
- );
284
-
285
- // Tweak and return.
286
- const result = {
287
- filePath,
288
- messages,
289
- suppressedMessages: linter.getSuppressedMessages(),
290
- ...calculateStatsPerFile(messages)
291
- };
292
-
293
- if (fixed) {
294
- result.output = output;
295
- }
296
- if (
297
- result.errorCount + result.warningCount > 0 &&
298
- typeof result.output === "undefined"
299
- ) {
300
- result.source = text;
301
- }
302
-
303
- return result;
254
+ const filePath = providedFilePath || "<text>";
255
+
256
+ debug(`Lint ${filePath}`);
257
+
258
+ /*
259
+ * Verify.
260
+ * `config.extractConfig(filePath)` requires an absolute path, but `linter`
261
+ * doesn't know CWD, so it gives `linter` an absolute path always.
262
+ */
263
+ const filePathToVerify =
264
+ filePath === "<text>" ? path.join(cwd, filePath) : filePath;
265
+ const { fixed, messages, output } = linter.verifyAndFix(text, config, {
266
+ allowInlineConfig,
267
+ filename: filePathToVerify,
268
+ fix,
269
+ reportUnusedDisableDirectives,
270
+
271
+ /**
272
+ * Check if the linter should adopt a given code block or not.
273
+ * @param {string} blockFilename The virtual filename of a code block.
274
+ * @returns {boolean} `true` if the linter should adopt the code block.
275
+ */
276
+ filterCodeBlock(blockFilename) {
277
+ return fileEnumerator.isTargetPath(blockFilename);
278
+ },
279
+ });
280
+
281
+ // Tweak and return.
282
+ const result = {
283
+ filePath,
284
+ messages,
285
+ suppressedMessages: linter.getSuppressedMessages(),
286
+ ...calculateStatsPerFile(messages),
287
+ };
288
+
289
+ if (fixed) {
290
+ result.output = output;
291
+ }
292
+ if (
293
+ result.errorCount + result.warningCount > 0 &&
294
+ typeof result.output === "undefined"
295
+ ) {
296
+ result.source = text;
297
+ }
298
+
299
+ return result;
304
300
  }
305
301
 
306
302
  /**
@@ -311,37 +307,42 @@ function verifyText({
311
307
  * @private
312
308
  */
313
309
  function createIgnoreResult(filePath, baseDir) {
314
- let message;
315
- const isHidden = filePath.split(path.sep)
316
- .find(segment => /^\./u.test(segment));
317
- const isInNodeModules = baseDir && path.relative(baseDir, filePath).startsWith("node_modules");
318
-
319
- if (isHidden) {
320
- message = "File ignored by default. Use a negated ignore pattern (like \"--ignore-pattern '!<relative/path/to/filename>'\") to override.";
321
- } else if (isInNodeModules) {
322
- message = "File ignored by default. Use \"--ignore-pattern '!node_modules/*'\" to override.";
323
- } else {
324
- message = "File ignored because of a matching ignore pattern. Use \"--no-ignore\" to override.";
325
- }
326
-
327
- return {
328
- filePath: path.resolve(filePath),
329
- messages: [
330
- {
331
- ruleId: null,
332
- fatal: false,
333
- severity: 1,
334
- message,
335
- nodeType: null
336
- }
337
- ],
338
- suppressedMessages: [],
339
- errorCount: 0,
340
- fatalErrorCount: 0,
341
- warningCount: 1,
342
- fixableErrorCount: 0,
343
- fixableWarningCount: 0
344
- };
310
+ let message;
311
+ const isHidden = filePath
312
+ .split(path.sep)
313
+ .find(segment => /^\./u.test(segment));
314
+ const isInNodeModules =
315
+ baseDir && path.relative(baseDir, filePath).startsWith("node_modules");
316
+
317
+ if (isHidden) {
318
+ message =
319
+ "File ignored by default. Use a negated ignore pattern (like \"--ignore-pattern '!<relative/path/to/filename>'\") to override.";
320
+ } else if (isInNodeModules) {
321
+ message =
322
+ "File ignored by default. Use \"--ignore-pattern '!node_modules/*'\" to override.";
323
+ } else {
324
+ message =
325
+ 'File ignored because of a matching ignore pattern. Use "--no-ignore" to override.';
326
+ }
327
+
328
+ return {
329
+ filePath: path.resolve(filePath),
330
+ messages: [
331
+ {
332
+ ruleId: null,
333
+ fatal: false,
334
+ severity: 1,
335
+ message,
336
+ nodeType: null,
337
+ },
338
+ ],
339
+ suppressedMessages: [],
340
+ errorCount: 0,
341
+ fatalErrorCount: 0,
342
+ warningCount: 1,
343
+ fixableErrorCount: 0,
344
+ fixableWarningCount: 0,
345
+ };
345
346
  }
346
347
 
347
348
  /**
@@ -351,14 +352,14 @@ function createIgnoreResult(filePath, baseDir) {
351
352
  * @returns {Rule|null} The rule or null.
352
353
  */
353
354
  function getRule(ruleId, configArrays) {
354
- for (const configArray of configArrays) {
355
- const rule = configArray.pluginRules.get(ruleId);
356
-
357
- if (rule) {
358
- return rule;
359
- }
360
- }
361
- return builtInRules.get(ruleId) || null;
355
+ for (const configArray of configArrays) {
356
+ const rule = configArray.pluginRules.get(ruleId);
357
+
358
+ if (rule) {
359
+ return rule;
360
+ }
361
+ }
362
+ return builtInRules.get(ruleId) || null;
362
363
  }
363
364
 
364
365
  /**
@@ -369,13 +370,13 @@ function getRule(ruleId, configArrays) {
369
370
  * @returns {boolean} Whether the message should be fixed.
370
371
  */
371
372
  function shouldMessageBeFixed(message, lastConfigArrays, fixTypes) {
372
- if (!message.ruleId) {
373
- return fixTypes.has("directive");
374
- }
373
+ if (!message.ruleId) {
374
+ return fixTypes.has("directive");
375
+ }
375
376
 
376
- const rule = message.ruleId && getRule(message.ruleId, lastConfigArrays);
377
+ const rule = message.ruleId && getRule(message.ruleId, lastConfigArrays);
377
378
 
378
- return Boolean(rule && rule.meta && fixTypes.has(rule.meta.type));
379
+ return Boolean(rule && rule.meta && fixTypes.has(rule.meta.type));
379
380
  }
380
381
 
381
382
  /**
@@ -383,41 +384,40 @@ function shouldMessageBeFixed(message, lastConfigArrays, fixTypes) {
383
384
  * @param {ConfigArray[]} usedConfigArrays The config arrays which were used.
384
385
  * @returns {IterableIterator<DeprecatedRuleInfo>} Used deprecated rules.
385
386
  */
386
- function *iterateRuleDeprecationWarnings(usedConfigArrays) {
387
- const processedRuleIds = new Set();
388
-
389
- // Flatten used configs.
390
- /** @type {ExtractedConfig[]} */
391
- const configs = usedConfigArrays.flatMap(getUsedExtractedConfigs);
392
-
393
- // Traverse rule configs.
394
- for (const config of configs) {
395
- for (const [ruleId, ruleConfig] of Object.entries(config.rules)) {
396
-
397
- // Skip if it was processed.
398
- if (processedRuleIds.has(ruleId)) {
399
- continue;
400
- }
401
- processedRuleIds.add(ruleId);
402
-
403
- // Skip if it's not used.
404
- if (!ConfigOps.getRuleSeverity(ruleConfig)) {
405
- continue;
406
- }
407
- const rule = getRule(ruleId, usedConfigArrays);
408
-
409
- // Skip if it's not deprecated.
410
- if (!(rule && rule.meta && rule.meta.deprecated)) {
411
- continue;
412
- }
413
-
414
- // This rule was used and deprecated.
415
- yield {
416
- ruleId,
417
- replacedBy: rule.meta.replacedBy || []
418
- };
419
- }
420
- }
387
+ function* iterateRuleDeprecationWarnings(usedConfigArrays) {
388
+ const processedRuleIds = new Set();
389
+
390
+ // Flatten used configs.
391
+ /** @type {ExtractedConfig[]} */
392
+ const configs = usedConfigArrays.flatMap(getUsedExtractedConfigs);
393
+
394
+ // Traverse rule configs.
395
+ for (const config of configs) {
396
+ for (const [ruleId, ruleConfig] of Object.entries(config.rules)) {
397
+ // Skip if it was processed.
398
+ if (processedRuleIds.has(ruleId)) {
399
+ continue;
400
+ }
401
+ processedRuleIds.add(ruleId);
402
+
403
+ // Skip if it's not used.
404
+ if (!ConfigOps.getRuleSeverity(ruleConfig)) {
405
+ continue;
406
+ }
407
+ const rule = getRule(ruleId, usedConfigArrays);
408
+
409
+ // Skip if it's not deprecated.
410
+ if (!(rule && rule.meta && rule.meta.deprecated)) {
411
+ continue;
412
+ }
413
+
414
+ // This rule was used and deprecated.
415
+ yield {
416
+ ruleId,
417
+ replacedBy: rule.meta.replacedBy || [],
418
+ };
419
+ }
420
+ }
421
421
  }
422
422
 
423
423
  /**
@@ -427,10 +427,9 @@ function *iterateRuleDeprecationWarnings(usedConfigArrays) {
427
427
  * @private
428
428
  */
429
429
  function isErrorMessage(message) {
430
- return message.severity === 2;
430
+ return message.severity === 2;
431
431
  }
432
432
 
433
-
434
433
  /**
435
434
  * return the cacheFile to be used by eslint, based on whether the provided parameter is
436
435
  * a directory or looks like a directory (ends in `path.sep`), in which case the file
@@ -442,65 +441,62 @@ function isErrorMessage(message) {
442
441
  * @returns {string} the resolved path to the cache file
443
442
  */
444
443
  function getCacheFile(cacheFile, cwd) {
445
-
446
- /*
447
- * make sure the path separators are normalized for the environment/os
448
- * keeping the trailing path separator if present
449
- */
450
- const normalizedCacheFile = path.normalize(cacheFile);
451
-
452
- const resolvedCacheFile = path.resolve(cwd, normalizedCacheFile);
453
- const looksLikeADirectory = normalizedCacheFile.slice(-1) === path.sep;
454
-
455
- /**
456
- * return the name for the cache file in case the provided parameter is a directory
457
- * @returns {string} the resolved path to the cacheFile
458
- */
459
- function getCacheFileForDirectory() {
460
- return path.join(resolvedCacheFile, `.cache_${hash(cwd)}`);
461
- }
462
-
463
- let fileStats;
464
-
465
- try {
466
- fileStats = fs.lstatSync(resolvedCacheFile);
467
- } catch {
468
- fileStats = null;
469
- }
470
-
471
-
472
- /*
473
- * in case the file exists we need to verify if the provided path
474
- * is a directory or a file. If it is a directory we want to create a file
475
- * inside that directory
476
- */
477
- if (fileStats) {
478
-
479
- /*
480
- * is a directory or is a file, but the original file the user provided
481
- * looks like a directory but `path.resolve` removed the `last path.sep`
482
- * so we need to still treat this like a directory
483
- */
484
- if (fileStats.isDirectory() || looksLikeADirectory) {
485
- return getCacheFileForDirectory();
486
- }
487
-
488
- // is file so just use that file
489
- return resolvedCacheFile;
490
- }
491
-
492
- /*
493
- * here we known the file or directory doesn't exist,
494
- * so we will try to infer if its a directory if it looks like a directory
495
- * for the current operating system.
496
- */
497
-
498
- // if the last character passed is a path separator we assume is a directory
499
- if (looksLikeADirectory) {
500
- return getCacheFileForDirectory();
501
- }
502
-
503
- return resolvedCacheFile;
444
+ /*
445
+ * make sure the path separators are normalized for the environment/os
446
+ * keeping the trailing path separator if present
447
+ */
448
+ const normalizedCacheFile = path.normalize(cacheFile);
449
+
450
+ const resolvedCacheFile = path.resolve(cwd, normalizedCacheFile);
451
+ const looksLikeADirectory = normalizedCacheFile.slice(-1) === path.sep;
452
+
453
+ /**
454
+ * return the name for the cache file in case the provided parameter is a directory
455
+ * @returns {string} the resolved path to the cacheFile
456
+ */
457
+ function getCacheFileForDirectory() {
458
+ return path.join(resolvedCacheFile, `.cache_${hash(cwd)}`);
459
+ }
460
+
461
+ let fileStats;
462
+
463
+ try {
464
+ fileStats = fs.lstatSync(resolvedCacheFile);
465
+ } catch {
466
+ fileStats = null;
467
+ }
468
+
469
+ /*
470
+ * in case the file exists we need to verify if the provided path
471
+ * is a directory or a file. If it is a directory we want to create a file
472
+ * inside that directory
473
+ */
474
+ if (fileStats) {
475
+ /*
476
+ * is a directory or is a file, but the original file the user provided
477
+ * looks like a directory but `path.resolve` removed the `last path.sep`
478
+ * so we need to still treat this like a directory
479
+ */
480
+ if (fileStats.isDirectory() || looksLikeADirectory) {
481
+ return getCacheFileForDirectory();
482
+ }
483
+
484
+ // is file so just use that file
485
+ return resolvedCacheFile;
486
+ }
487
+
488
+ /*
489
+ * here we known the file or directory doesn't exist,
490
+ * so we will try to infer if its a directory if it looks like a directory
491
+ * for the current operating system.
492
+ */
493
+
494
+ // if the last character passed is a path separator we assume is a directory
495
+ if (looksLikeADirectory) {
496
+ return getCacheFileForDirectory();
497
+ }
498
+
499
+ return resolvedCacheFile;
504
500
  }
505
501
 
506
502
  /**
@@ -512,23 +508,21 @@ function getCacheFile(cacheFile, cwd) {
512
508
  * @returns {Record<string,boolean>} The boolean map.
513
509
  */
514
510
  function toBooleanMap(keys, defaultValue, displayName) {
515
- if (keys && !Array.isArray(keys)) {
516
- throw new Error(`${displayName} must be an array.`);
517
- }
518
- if (keys && keys.length > 0) {
519
- return keys.reduce((map, def) => {
520
- const [key, value] = def.split(":");
521
-
522
- if (key !== "__proto__") {
523
- map[key] = value === void 0
524
- ? defaultValue
525
- : value === "true";
526
- }
527
-
528
- return map;
529
- }, {});
530
- }
531
- return void 0;
511
+ if (keys && !Array.isArray(keys)) {
512
+ throw new Error(`${displayName} must be an array.`);
513
+ }
514
+ if (keys && keys.length > 0) {
515
+ return keys.reduce((map, def) => {
516
+ const [key, value] = def.split(":");
517
+
518
+ if (key !== "__proto__") {
519
+ map[key] = value === void 0 ? defaultValue : value === "true";
520
+ }
521
+
522
+ return map;
523
+ }, {});
524
+ }
525
+ return void 0;
532
526
  }
533
527
 
534
528
  /**
@@ -537,36 +531,30 @@ function toBooleanMap(keys, defaultValue, displayName) {
537
531
  * @returns {ConfigData|null} The created config data.
538
532
  */
539
533
  function createConfigDataFromOptions(options) {
540
- const {
541
- ignorePattern,
542
- parser,
543
- parserOptions,
544
- plugins,
545
- rules
546
- } = options;
547
- const env = toBooleanMap(options.envs, true, "envs");
548
- const globals = toBooleanMap(options.globals, false, "globals");
549
-
550
- if (
551
- env === void 0 &&
552
- globals === void 0 &&
553
- (ignorePattern === void 0 || ignorePattern.length === 0) &&
554
- parser === void 0 &&
555
- parserOptions === void 0 &&
556
- plugins === void 0 &&
557
- rules === void 0
558
- ) {
559
- return null;
560
- }
561
- return {
562
- env,
563
- globals,
564
- ignorePatterns: ignorePattern,
565
- parser,
566
- parserOptions,
567
- plugins,
568
- rules
569
- };
534
+ const { ignorePattern, parser, parserOptions, plugins, rules } = options;
535
+ const env = toBooleanMap(options.envs, true, "envs");
536
+ const globals = toBooleanMap(options.globals, false, "globals");
537
+
538
+ if (
539
+ env === void 0 &&
540
+ globals === void 0 &&
541
+ (ignorePattern === void 0 || ignorePattern.length === 0) &&
542
+ parser === void 0 &&
543
+ parserOptions === void 0 &&
544
+ plugins === void 0 &&
545
+ rules === void 0
546
+ ) {
547
+ return null;
548
+ }
549
+ return {
550
+ env,
551
+ globals,
552
+ ignorePatterns: ignorePattern,
553
+ parser,
554
+ parserOptions,
555
+ plugins,
556
+ rules,
557
+ };
570
558
  }
571
559
 
572
560
  /**
@@ -576,14 +564,14 @@ function createConfigDataFromOptions(options) {
576
564
  * @returns {boolean} `true` if a directory exists
577
565
  */
578
566
  function directoryExists(resolvedPath) {
579
- try {
580
- return fs.statSync(resolvedPath).isDirectory();
581
- } catch (error) {
582
- if (error && (error.code === "ENOENT" || error.code === "ENOTDIR")) {
583
- return false;
584
- }
585
- throw error;
586
- }
567
+ try {
568
+ return fs.statSync(resolvedPath).isDirectory();
569
+ } catch (error) {
570
+ if (error && (error.code === "ENOENT" || error.code === "ENOTDIR")) {
571
+ return false;
572
+ }
573
+ throw error;
574
+ }
587
575
  }
588
576
 
589
577
  //------------------------------------------------------------------------------
@@ -594,496 +582,528 @@ function directoryExists(resolvedPath) {
594
582
  * Core CLI.
595
583
  */
596
584
  class CLIEngine {
597
-
598
- /**
599
- * Creates a new instance of the core CLI engine.
600
- * @param {CLIEngineOptions} providedOptions The options for this instance.
601
- * @param {Object} [additionalData] Additional settings that are not CLIEngineOptions.
602
- * @param {Record<string,Plugin>|null} [additionalData.preloadedPlugins] Preloaded plugins.
603
- */
604
- constructor(providedOptions, { preloadedPlugins } = {}) {
605
- const options = Object.assign(
606
- Object.create(null),
607
- defaultOptions,
608
- { cwd: process.cwd() },
609
- providedOptions
610
- );
611
-
612
- if (options.fix === void 0) {
613
- options.fix = false;
614
- }
615
-
616
- const additionalPluginPool = new Map();
617
-
618
- if (preloadedPlugins) {
619
- for (const [id, plugin] of Object.entries(preloadedPlugins)) {
620
- additionalPluginPool.set(id, plugin);
621
- }
622
- }
623
-
624
- const cacheFilePath = getCacheFile(
625
- options.cacheLocation || options.cacheFile,
626
- options.cwd
627
- );
628
- const configArrayFactory = new CascadingConfigArrayFactory({
629
- additionalPluginPool,
630
- baseConfig: options.baseConfig || null,
631
- cliConfig: createConfigDataFromOptions(options),
632
- cwd: options.cwd,
633
- ignorePath: options.ignorePath,
634
- resolvePluginsRelativeTo: options.resolvePluginsRelativeTo,
635
- rulePaths: options.rulePaths,
636
- specificConfigPath: options.configFile,
637
- useEslintrc: options.useEslintrc,
638
- builtInRules,
639
- loadRules,
640
- getEslintRecommendedConfig: () => require("@eslint/js").configs.recommended,
641
- getEslintAllConfig: () => require("@eslint/js").configs.all
642
- });
643
- const fileEnumerator = new FileEnumerator({
644
- configArrayFactory,
645
- cwd: options.cwd,
646
- extensions: options.extensions,
647
- globInputPaths: options.globInputPaths,
648
- errorOnUnmatchedPattern: options.errorOnUnmatchedPattern,
649
- ignore: options.ignore
650
- });
651
- const lintResultCache =
652
- options.cache ? new LintResultCache(cacheFilePath, options.cacheStrategy) : null;
653
- const linter = new Linter({ cwd: options.cwd, configType: "eslintrc" });
654
-
655
- /** @type {ConfigArray[]} */
656
- const lastConfigArrays = [configArrayFactory.getConfigArrayForFile()];
657
-
658
- // Store private data.
659
- internalSlotsMap.set(this, {
660
- additionalPluginPool,
661
- cacheFilePath,
662
- configArrayFactory,
663
- defaultIgnores: IgnorePattern.createDefaultIgnore(options.cwd),
664
- fileEnumerator,
665
- lastConfigArrays,
666
- lintResultCache,
667
- linter,
668
- options
669
- });
670
-
671
- // setup special filter for fixes
672
- if (options.fix && options.fixTypes && options.fixTypes.length > 0) {
673
- debug(`Using fix types ${options.fixTypes}`);
674
-
675
- // throw an error if any invalid fix types are found
676
- validateFixTypes(options.fixTypes);
677
-
678
- // convert to Set for faster lookup
679
- const fixTypes = new Set(options.fixTypes);
680
-
681
- // save original value of options.fix in case it's a function
682
- const originalFix = (typeof options.fix === "function")
683
- ? options.fix : () => true;
684
-
685
- options.fix = message => shouldMessageBeFixed(message, lastConfigArrays, fixTypes) && originalFix(message);
686
- }
687
- }
688
-
689
- getRules() {
690
- const { lastConfigArrays } = internalSlotsMap.get(this);
691
-
692
- return new Map(function *() {
693
- yield* builtInRules;
694
-
695
- for (const configArray of lastConfigArrays) {
696
- yield* configArray.pluginRules;
697
- }
698
- }());
699
- }
700
-
701
- /**
702
- * Returns results that only contains errors.
703
- * @param {LintResult[]} results The results to filter.
704
- * @returns {LintResult[]} The filtered results.
705
- */
706
- static getErrorResults(results) {
707
- const filtered = [];
708
-
709
- results.forEach(result => {
710
- const filteredMessages = result.messages.filter(isErrorMessage);
711
- const filteredSuppressedMessages = result.suppressedMessages.filter(isErrorMessage);
712
-
713
- if (filteredMessages.length > 0) {
714
- filtered.push({
715
- ...result,
716
- messages: filteredMessages,
717
- suppressedMessages: filteredSuppressedMessages,
718
- errorCount: filteredMessages.length,
719
- warningCount: 0,
720
- fixableErrorCount: result.fixableErrorCount,
721
- fixableWarningCount: 0
722
- });
723
- }
724
- });
725
-
726
- return filtered;
727
- }
728
-
729
- /**
730
- * Outputs fixes from the given results to files.
731
- * @param {LintReport} report The report object created by CLIEngine.
732
- * @returns {void}
733
- */
734
- static outputFixes(report) {
735
- report.results.filter(result => Object.hasOwn(result, "output")).forEach(result => {
736
- fs.writeFileSync(result.filePath, result.output);
737
- });
738
- }
739
-
740
- /**
741
- * Resolves the patterns passed into executeOnFiles() into glob-based patterns
742
- * for easier handling.
743
- * @param {string[]} patterns The file patterns passed on the command line.
744
- * @returns {string[]} The equivalent glob patterns.
745
- */
746
- resolveFileGlobPatterns(patterns) {
747
- const { options } = internalSlotsMap.get(this);
748
-
749
- if (options.globInputPaths === false) {
750
- return patterns.filter(Boolean);
751
- }
752
-
753
- const extensions = (options.extensions || [".js"]).map(ext => ext.replace(/^\./u, ""));
754
- const dirSuffix = `/**/*.{${extensions.join(",")}}`;
755
-
756
- return patterns.filter(Boolean).map(pathname => {
757
- const resolvedPath = path.resolve(options.cwd, pathname);
758
- const newPath = directoryExists(resolvedPath)
759
- ? pathname.replace(/[/\\]$/u, "") + dirSuffix
760
- : pathname;
761
-
762
- return path.normalize(newPath).replace(/\\/gu, "/");
763
- });
764
- }
765
-
766
- /**
767
- * Executes the current configuration on an array of file and directory names.
768
- * @param {string[]} patterns An array of file and directory names.
769
- * @throws {Error} As may be thrown by `fs.unlinkSync`.
770
- * @returns {LintReport} The results for all files that were linted.
771
- */
772
- executeOnFiles(patterns) {
773
- const {
774
- cacheFilePath,
775
- fileEnumerator,
776
- lastConfigArrays,
777
- lintResultCache,
778
- linter,
779
- options: {
780
- allowInlineConfig,
781
- cache,
782
- cwd,
783
- fix,
784
- reportUnusedDisableDirectives
785
- }
786
- } = internalSlotsMap.get(this);
787
- const results = [];
788
- const startTime = Date.now();
789
-
790
- // Clear the last used config arrays.
791
- lastConfigArrays.length = 0;
792
-
793
- // Delete cache file; should this do here?
794
- if (!cache) {
795
- try {
796
- fs.unlinkSync(cacheFilePath);
797
- } catch (error) {
798
- const errorCode = error && error.code;
799
-
800
- // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
801
- if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !fs.existsSync(cacheFilePath))) {
802
- throw error;
803
- }
804
- }
805
- }
806
-
807
- // Iterate source code files.
808
- for (const { config, filePath, ignored } of fileEnumerator.iterateFiles(patterns)) {
809
- if (ignored) {
810
- results.push(createIgnoreResult(filePath, cwd));
811
- continue;
812
- }
813
-
814
- /*
815
- * Store used configs for:
816
- * - this method uses to collect used deprecated rules.
817
- * - `getRules()` method uses to collect all loaded rules.
818
- * - `--fix-type` option uses to get the loaded rule's meta data.
819
- */
820
- if (!lastConfigArrays.includes(config)) {
821
- lastConfigArrays.push(config);
822
- }
823
-
824
- // Skip if there is cached result.
825
- if (lintResultCache) {
826
- const cachedResult =
827
- lintResultCache.getCachedLintResults(filePath, config);
828
-
829
- if (cachedResult) {
830
- const hadMessages =
831
- cachedResult.messages &&
832
- cachedResult.messages.length > 0;
833
-
834
- if (hadMessages && fix) {
835
- debug(`Reprocessing cached file to allow autofix: ${filePath}`);
836
- } else {
837
- debug(`Skipping file since it hasn't changed: ${filePath}`);
838
- results.push(cachedResult);
839
- continue;
840
- }
841
- }
842
- }
843
-
844
- // Do lint.
845
- const result = verifyText({
846
- text: fs.readFileSync(filePath, "utf8"),
847
- filePath,
848
- config,
849
- cwd,
850
- fix,
851
- allowInlineConfig,
852
- reportUnusedDisableDirectives,
853
- fileEnumerator,
854
- linter
855
- });
856
-
857
- results.push(result);
858
-
859
- /*
860
- * Store the lint result in the LintResultCache.
861
- * NOTE: The LintResultCache will remove the file source and any
862
- * other properties that are difficult to serialize, and will
863
- * hydrate those properties back in on future lint runs.
864
- */
865
- if (lintResultCache) {
866
- lintResultCache.setCachedLintResults(filePath, config, result);
867
- }
868
- }
869
-
870
- // Persist the cache to disk.
871
- if (lintResultCache) {
872
- lintResultCache.reconcile();
873
- }
874
-
875
- debug(`Linting complete in: ${Date.now() - startTime}ms`);
876
- let usedDeprecatedRules;
877
-
878
- return {
879
- results,
880
- ...calculateStatsPerRun(results),
881
-
882
- // Initialize it lazily because CLI and `ESLint` API don't use it.
883
- get usedDeprecatedRules() {
884
- if (!usedDeprecatedRules) {
885
- usedDeprecatedRules = Array.from(
886
- iterateRuleDeprecationWarnings(lastConfigArrays)
887
- );
888
- }
889
- return usedDeprecatedRules;
890
- }
891
- };
892
- }
893
-
894
- /**
895
- * Executes the current configuration on text.
896
- * @param {string} text A string of JavaScript code to lint.
897
- * @param {string} [filename] An optional string representing the texts filename.
898
- * @param {boolean} [warnIgnored] Always warn when a file is ignored
899
- * @returns {LintReport} The results for the linting.
900
- */
901
- executeOnText(text, filename, warnIgnored) {
902
- const {
903
- configArrayFactory,
904
- fileEnumerator,
905
- lastConfigArrays,
906
- linter,
907
- options: {
908
- allowInlineConfig,
909
- cwd,
910
- fix,
911
- reportUnusedDisableDirectives
912
- }
913
- } = internalSlotsMap.get(this);
914
- const results = [];
915
- const startTime = Date.now();
916
- const resolvedFilename = filename && path.resolve(cwd, filename);
917
-
918
-
919
- // Clear the last used config arrays.
920
- lastConfigArrays.length = 0;
921
- if (resolvedFilename && this.isPathIgnored(resolvedFilename)) {
922
- if (warnIgnored) {
923
- results.push(createIgnoreResult(resolvedFilename, cwd));
924
- }
925
- } else {
926
- const config = configArrayFactory.getConfigArrayForFile(
927
- resolvedFilename || "__placeholder__.js"
928
- );
929
-
930
- /*
931
- * Store used configs for:
932
- * - this method uses to collect used deprecated rules.
933
- * - `getRules()` method uses to collect all loaded rules.
934
- * - `--fix-type` option uses to get the loaded rule's meta data.
935
- */
936
- lastConfigArrays.push(config);
937
-
938
- // Do lint.
939
- results.push(verifyText({
940
- text,
941
- filePath: resolvedFilename,
942
- config,
943
- cwd,
944
- fix,
945
- allowInlineConfig,
946
- reportUnusedDisableDirectives,
947
- fileEnumerator,
948
- linter
949
- }));
950
- }
951
-
952
- debug(`Linting complete in: ${Date.now() - startTime}ms`);
953
- let usedDeprecatedRules;
954
-
955
- return {
956
- results,
957
- ...calculateStatsPerRun(results),
958
-
959
- // Initialize it lazily because CLI and `ESLint` API don't use it.
960
- get usedDeprecatedRules() {
961
- if (!usedDeprecatedRules) {
962
- usedDeprecatedRules = Array.from(
963
- iterateRuleDeprecationWarnings(lastConfigArrays)
964
- );
965
- }
966
- return usedDeprecatedRules;
967
- }
968
- };
969
- }
970
-
971
- /**
972
- * Returns a configuration object for the given file based on the CLI options.
973
- * This is the same logic used by the ESLint CLI executable to determine
974
- * configuration for each file it processes.
975
- * @param {string} filePath The path of the file to retrieve a config object for.
976
- * @throws {Error} If filepath a directory path.
977
- * @returns {ConfigData} A configuration object for the file.
978
- */
979
- getConfigForFile(filePath) {
980
- const { configArrayFactory, options } = internalSlotsMap.get(this);
981
- const absolutePath = path.resolve(options.cwd, filePath);
982
-
983
- if (directoryExists(absolutePath)) {
984
- throw Object.assign(
985
- new Error("'filePath' should not be a directory path."),
986
- { messageTemplate: "print-config-with-directory-path" }
987
- );
988
- }
989
-
990
- return configArrayFactory
991
- .getConfigArrayForFile(absolutePath)
992
- .extractConfig(absolutePath)
993
- .toCompatibleObjectAsConfigFileContent();
994
- }
995
-
996
- /**
997
- * Checks if a given path is ignored by ESLint.
998
- * @param {string} filePath The path of the file to check.
999
- * @returns {boolean} Whether or not the given path is ignored.
1000
- */
1001
- isPathIgnored(filePath) {
1002
- const {
1003
- configArrayFactory,
1004
- defaultIgnores,
1005
- options: { cwd, ignore }
1006
- } = internalSlotsMap.get(this);
1007
- const absolutePath = path.resolve(cwd, filePath);
1008
-
1009
- if (ignore) {
1010
- const config = configArrayFactory
1011
- .getConfigArrayForFile(absolutePath)
1012
- .extractConfig(absolutePath);
1013
- const ignores = config.ignores || defaultIgnores;
1014
-
1015
- return ignores(absolutePath);
1016
- }
1017
-
1018
- return defaultIgnores(absolutePath);
1019
- }
1020
-
1021
- /**
1022
- * Returns the formatter representing the given format or null if the `format` is not a string.
1023
- * @param {string} [format] The name of the format to load or the path to a
1024
- * custom formatter.
1025
- * @throws {any} As may be thrown by requiring of formatter
1026
- * @returns {(FormatterFunction|null)} The formatter function or null if the `format` is not a string.
1027
- */
1028
- getFormatter(format) {
1029
-
1030
- // default is stylish
1031
- const resolvedFormatName = format || "stylish";
1032
-
1033
- // only strings are valid formatters
1034
- if (typeof resolvedFormatName === "string") {
1035
-
1036
- // replace \ with / for Windows compatibility
1037
- const normalizedFormatName = resolvedFormatName.replace(/\\/gu, "/");
1038
-
1039
- const slots = internalSlotsMap.get(this);
1040
- const cwd = slots ? slots.options.cwd : process.cwd();
1041
- const namespace = naming.getNamespaceFromTerm(normalizedFormatName);
1042
-
1043
- let formatterPath;
1044
-
1045
- // if there's a slash, then it's a file (TODO: this check seems dubious for scoped npm packages)
1046
- if (!namespace && normalizedFormatName.includes("/")) {
1047
- formatterPath = path.resolve(cwd, normalizedFormatName);
1048
- } else {
1049
- try {
1050
- const npmFormat = naming.normalizePackageName(normalizedFormatName, "eslint-formatter");
1051
-
1052
- formatterPath = ModuleResolver.resolve(npmFormat, path.join(cwd, "__placeholder__.js"));
1053
- } catch {
1054
- formatterPath = path.resolve(__dirname, "formatters", normalizedFormatName);
1055
- }
1056
- }
1057
-
1058
- try {
1059
- return require(formatterPath);
1060
- } catch (ex) {
1061
- if (removedFormatters.has(format)) {
1062
- ex.message = `The ${format} formatter is no longer part of core ESLint. Install it manually with \`npm install -D eslint-formatter-${format}\``;
1063
- } else {
1064
- ex.message = `There was a problem loading formatter: ${formatterPath}\nError: ${ex.message}`;
1065
- }
1066
- throw ex;
1067
- }
1068
-
1069
- } else {
1070
- return null;
1071
- }
1072
- }
585
+ /**
586
+ * Creates a new instance of the core CLI engine.
587
+ * @param {CLIEngineOptions} providedOptions The options for this instance.
588
+ * @param {Object} [additionalData] Additional settings that are not CLIEngineOptions.
589
+ * @param {Record<string,Plugin>|null} [additionalData.preloadedPlugins] Preloaded plugins.
590
+ */
591
+ constructor(providedOptions, { preloadedPlugins } = {}) {
592
+ const options = Object.assign(
593
+ Object.create(null),
594
+ defaultOptions,
595
+ { cwd: process.cwd() },
596
+ providedOptions,
597
+ );
598
+
599
+ if (options.fix === void 0) {
600
+ options.fix = false;
601
+ }
602
+
603
+ const additionalPluginPool = new Map();
604
+
605
+ if (preloadedPlugins) {
606
+ for (const [id, plugin] of Object.entries(preloadedPlugins)) {
607
+ additionalPluginPool.set(id, plugin);
608
+ }
609
+ }
610
+
611
+ const cacheFilePath = getCacheFile(
612
+ options.cacheLocation || options.cacheFile,
613
+ options.cwd,
614
+ );
615
+ const configArrayFactory = new CascadingConfigArrayFactory({
616
+ additionalPluginPool,
617
+ baseConfig: options.baseConfig || null,
618
+ cliConfig: createConfigDataFromOptions(options),
619
+ cwd: options.cwd,
620
+ ignorePath: options.ignorePath,
621
+ resolvePluginsRelativeTo: options.resolvePluginsRelativeTo,
622
+ rulePaths: options.rulePaths,
623
+ specificConfigPath: options.configFile,
624
+ useEslintrc: options.useEslintrc,
625
+ builtInRules,
626
+ loadRules,
627
+ getEslintRecommendedConfig: () =>
628
+ require("@eslint/js").configs.recommended,
629
+ getEslintAllConfig: () => require("@eslint/js").configs.all,
630
+ });
631
+ const fileEnumerator = new FileEnumerator({
632
+ configArrayFactory,
633
+ cwd: options.cwd,
634
+ extensions: options.extensions,
635
+ globInputPaths: options.globInputPaths,
636
+ errorOnUnmatchedPattern: options.errorOnUnmatchedPattern,
637
+ ignore: options.ignore,
638
+ });
639
+ const lintResultCache = options.cache
640
+ ? new LintResultCache(cacheFilePath, options.cacheStrategy)
641
+ : null;
642
+ const linter = new Linter({ cwd: options.cwd, configType: "eslintrc" });
643
+
644
+ /** @type {ConfigArray[]} */
645
+ const lastConfigArrays = [configArrayFactory.getConfigArrayForFile()];
646
+
647
+ // Store private data.
648
+ internalSlotsMap.set(this, {
649
+ additionalPluginPool,
650
+ cacheFilePath,
651
+ configArrayFactory,
652
+ defaultIgnores: IgnorePattern.createDefaultIgnore(options.cwd),
653
+ fileEnumerator,
654
+ lastConfigArrays,
655
+ lintResultCache,
656
+ linter,
657
+ options,
658
+ });
659
+
660
+ // setup special filter for fixes
661
+ if (options.fix && options.fixTypes && options.fixTypes.length > 0) {
662
+ debug(`Using fix types ${options.fixTypes}`);
663
+
664
+ // throw an error if any invalid fix types are found
665
+ validateFixTypes(options.fixTypes);
666
+
667
+ // convert to Set for faster lookup
668
+ const fixTypes = new Set(options.fixTypes);
669
+
670
+ // save original value of options.fix in case it's a function
671
+ const originalFix =
672
+ typeof options.fix === "function" ? options.fix : () => true;
673
+
674
+ options.fix = message =>
675
+ shouldMessageBeFixed(message, lastConfigArrays, fixTypes) &&
676
+ originalFix(message);
677
+ }
678
+ }
679
+
680
+ getRules() {
681
+ const { lastConfigArrays } = internalSlotsMap.get(this);
682
+
683
+ return new Map(
684
+ (function* () {
685
+ yield* builtInRules;
686
+
687
+ for (const configArray of lastConfigArrays) {
688
+ yield* configArray.pluginRules;
689
+ }
690
+ })(),
691
+ );
692
+ }
693
+
694
+ /**
695
+ * Returns results that only contains errors.
696
+ * @param {LintResult[]} results The results to filter.
697
+ * @returns {LintResult[]} The filtered results.
698
+ */
699
+ static getErrorResults(results) {
700
+ const filtered = [];
701
+
702
+ results.forEach(result => {
703
+ const filteredMessages = result.messages.filter(isErrorMessage);
704
+ const filteredSuppressedMessages =
705
+ result.suppressedMessages.filter(isErrorMessage);
706
+
707
+ if (filteredMessages.length > 0) {
708
+ filtered.push({
709
+ ...result,
710
+ messages: filteredMessages,
711
+ suppressedMessages: filteredSuppressedMessages,
712
+ errorCount: filteredMessages.length,
713
+ warningCount: 0,
714
+ fixableErrorCount: result.fixableErrorCount,
715
+ fixableWarningCount: 0,
716
+ });
717
+ }
718
+ });
719
+
720
+ return filtered;
721
+ }
722
+
723
+ /**
724
+ * Outputs fixes from the given results to files.
725
+ * @param {LintReport} report The report object created by CLIEngine.
726
+ * @returns {void}
727
+ */
728
+ static outputFixes(report) {
729
+ report.results
730
+ .filter(result => Object.hasOwn(result, "output"))
731
+ .forEach(result => {
732
+ fs.writeFileSync(result.filePath, result.output);
733
+ });
734
+ }
735
+
736
+ /**
737
+ * Resolves the patterns passed into executeOnFiles() into glob-based patterns
738
+ * for easier handling.
739
+ * @param {string[]} patterns The file patterns passed on the command line.
740
+ * @returns {string[]} The equivalent glob patterns.
741
+ */
742
+ resolveFileGlobPatterns(patterns) {
743
+ const { options } = internalSlotsMap.get(this);
744
+
745
+ if (options.globInputPaths === false) {
746
+ return patterns.filter(Boolean);
747
+ }
748
+
749
+ const extensions = (options.extensions || [".js"]).map(ext =>
750
+ ext.replace(/^\./u, ""),
751
+ );
752
+ const dirSuffix = `/**/*.{${extensions.join(",")}}`;
753
+
754
+ return patterns.filter(Boolean).map(pathname => {
755
+ const resolvedPath = path.resolve(options.cwd, pathname);
756
+ const newPath = directoryExists(resolvedPath)
757
+ ? pathname.replace(/[/\\]$/u, "") + dirSuffix
758
+ : pathname;
759
+
760
+ return path.normalize(newPath).replace(/\\/gu, "/");
761
+ });
762
+ }
763
+
764
+ /**
765
+ * Executes the current configuration on an array of file and directory names.
766
+ * @param {string[]} patterns An array of file and directory names.
767
+ * @throws {Error} As may be thrown by `fs.unlinkSync`.
768
+ * @returns {LintReport} The results for all files that were linted.
769
+ */
770
+ executeOnFiles(patterns) {
771
+ const {
772
+ cacheFilePath,
773
+ fileEnumerator,
774
+ lastConfigArrays,
775
+ lintResultCache,
776
+ linter,
777
+ options: {
778
+ allowInlineConfig,
779
+ cache,
780
+ cwd,
781
+ fix,
782
+ reportUnusedDisableDirectives,
783
+ },
784
+ } = internalSlotsMap.get(this);
785
+ const results = [];
786
+ const startTime = Date.now();
787
+
788
+ // Clear the last used config arrays.
789
+ lastConfigArrays.length = 0;
790
+
791
+ // Delete cache file; should this do here?
792
+ if (!cache) {
793
+ try {
794
+ fs.unlinkSync(cacheFilePath);
795
+ } catch (error) {
796
+ const errorCode = error && error.code;
797
+
798
+ // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
799
+ if (
800
+ errorCode !== "ENOENT" &&
801
+ !(errorCode === "EROFS" && !fs.existsSync(cacheFilePath))
802
+ ) {
803
+ throw error;
804
+ }
805
+ }
806
+ }
807
+
808
+ // Iterate source code files.
809
+ for (const { config, filePath, ignored } of fileEnumerator.iterateFiles(
810
+ patterns,
811
+ )) {
812
+ if (ignored) {
813
+ results.push(createIgnoreResult(filePath, cwd));
814
+ continue;
815
+ }
816
+
817
+ /*
818
+ * Store used configs for:
819
+ * - this method uses to collect used deprecated rules.
820
+ * - `getRules()` method uses to collect all loaded rules.
821
+ * - `--fix-type` option uses to get the loaded rule's meta data.
822
+ */
823
+ if (!lastConfigArrays.includes(config)) {
824
+ lastConfigArrays.push(config);
825
+ }
826
+
827
+ // Skip if there is cached result.
828
+ if (lintResultCache) {
829
+ const cachedResult = lintResultCache.getCachedLintResults(
830
+ filePath,
831
+ config,
832
+ );
833
+
834
+ if (cachedResult) {
835
+ const hadMessages =
836
+ cachedResult.messages &&
837
+ cachedResult.messages.length > 0;
838
+
839
+ if (hadMessages && fix) {
840
+ debug(
841
+ `Reprocessing cached file to allow autofix: ${filePath}`,
842
+ );
843
+ } else {
844
+ debug(
845
+ `Skipping file since it hasn't changed: ${filePath}`,
846
+ );
847
+ results.push(cachedResult);
848
+ continue;
849
+ }
850
+ }
851
+ }
852
+
853
+ // Do lint.
854
+ const result = verifyText({
855
+ text: fs.readFileSync(filePath, "utf8"),
856
+ filePath,
857
+ config,
858
+ cwd,
859
+ fix,
860
+ allowInlineConfig,
861
+ reportUnusedDisableDirectives,
862
+ fileEnumerator,
863
+ linter,
864
+ });
865
+
866
+ results.push(result);
867
+
868
+ /*
869
+ * Store the lint result in the LintResultCache.
870
+ * NOTE: The LintResultCache will remove the file source and any
871
+ * other properties that are difficult to serialize, and will
872
+ * hydrate those properties back in on future lint runs.
873
+ */
874
+ if (lintResultCache) {
875
+ lintResultCache.setCachedLintResults(filePath, config, result);
876
+ }
877
+ }
878
+
879
+ // Persist the cache to disk.
880
+ if (lintResultCache) {
881
+ lintResultCache.reconcile();
882
+ }
883
+
884
+ debug(`Linting complete in: ${Date.now() - startTime}ms`);
885
+ let usedDeprecatedRules;
886
+
887
+ return {
888
+ results,
889
+ ...calculateStatsPerRun(results),
890
+
891
+ // Initialize it lazily because CLI and `ESLint` API don't use it.
892
+ get usedDeprecatedRules() {
893
+ if (!usedDeprecatedRules) {
894
+ usedDeprecatedRules = Array.from(
895
+ iterateRuleDeprecationWarnings(lastConfigArrays),
896
+ );
897
+ }
898
+ return usedDeprecatedRules;
899
+ },
900
+ };
901
+ }
902
+
903
+ /**
904
+ * Executes the current configuration on text.
905
+ * @param {string} text A string of JavaScript code to lint.
906
+ * @param {string} [filename] An optional string representing the texts filename.
907
+ * @param {boolean} [warnIgnored] Always warn when a file is ignored
908
+ * @returns {LintReport} The results for the linting.
909
+ */
910
+ executeOnText(text, filename, warnIgnored) {
911
+ const {
912
+ configArrayFactory,
913
+ fileEnumerator,
914
+ lastConfigArrays,
915
+ linter,
916
+ options: {
917
+ allowInlineConfig,
918
+ cwd,
919
+ fix,
920
+ reportUnusedDisableDirectives,
921
+ },
922
+ } = internalSlotsMap.get(this);
923
+ const results = [];
924
+ const startTime = Date.now();
925
+ const resolvedFilename = filename && path.resolve(cwd, filename);
926
+
927
+ // Clear the last used config arrays.
928
+ lastConfigArrays.length = 0;
929
+ if (resolvedFilename && this.isPathIgnored(resolvedFilename)) {
930
+ if (warnIgnored) {
931
+ results.push(createIgnoreResult(resolvedFilename, cwd));
932
+ }
933
+ } else {
934
+ const config = configArrayFactory.getConfigArrayForFile(
935
+ resolvedFilename || "__placeholder__.js",
936
+ );
937
+
938
+ /*
939
+ * Store used configs for:
940
+ * - this method uses to collect used deprecated rules.
941
+ * - `getRules()` method uses to collect all loaded rules.
942
+ * - `--fix-type` option uses to get the loaded rule's meta data.
943
+ */
944
+ lastConfigArrays.push(config);
945
+
946
+ // Do lint.
947
+ results.push(
948
+ verifyText({
949
+ text,
950
+ filePath: resolvedFilename,
951
+ config,
952
+ cwd,
953
+ fix,
954
+ allowInlineConfig,
955
+ reportUnusedDisableDirectives,
956
+ fileEnumerator,
957
+ linter,
958
+ }),
959
+ );
960
+ }
961
+
962
+ debug(`Linting complete in: ${Date.now() - startTime}ms`);
963
+ let usedDeprecatedRules;
964
+
965
+ return {
966
+ results,
967
+ ...calculateStatsPerRun(results),
968
+
969
+ // Initialize it lazily because CLI and `ESLint` API don't use it.
970
+ get usedDeprecatedRules() {
971
+ if (!usedDeprecatedRules) {
972
+ usedDeprecatedRules = Array.from(
973
+ iterateRuleDeprecationWarnings(lastConfigArrays),
974
+ );
975
+ }
976
+ return usedDeprecatedRules;
977
+ },
978
+ };
979
+ }
980
+
981
+ /**
982
+ * Returns a configuration object for the given file based on the CLI options.
983
+ * This is the same logic used by the ESLint CLI executable to determine
984
+ * configuration for each file it processes.
985
+ * @param {string} filePath The path of the file to retrieve a config object for.
986
+ * @throws {Error} If filepath a directory path.
987
+ * @returns {ConfigData} A configuration object for the file.
988
+ */
989
+ getConfigForFile(filePath) {
990
+ const { configArrayFactory, options } = internalSlotsMap.get(this);
991
+ const absolutePath = path.resolve(options.cwd, filePath);
992
+
993
+ if (directoryExists(absolutePath)) {
994
+ throw Object.assign(
995
+ new Error("'filePath' should not be a directory path."),
996
+ { messageTemplate: "print-config-with-directory-path" },
997
+ );
998
+ }
999
+
1000
+ return configArrayFactory
1001
+ .getConfigArrayForFile(absolutePath)
1002
+ .extractConfig(absolutePath)
1003
+ .toCompatibleObjectAsConfigFileContent();
1004
+ }
1005
+
1006
+ /**
1007
+ * Checks if a given path is ignored by ESLint.
1008
+ * @param {string} filePath The path of the file to check.
1009
+ * @returns {boolean} Whether or not the given path is ignored.
1010
+ */
1011
+ isPathIgnored(filePath) {
1012
+ const {
1013
+ configArrayFactory,
1014
+ defaultIgnores,
1015
+ options: { cwd, ignore },
1016
+ } = internalSlotsMap.get(this);
1017
+ const absolutePath = path.resolve(cwd, filePath);
1018
+
1019
+ if (ignore) {
1020
+ const config = configArrayFactory
1021
+ .getConfigArrayForFile(absolutePath)
1022
+ .extractConfig(absolutePath);
1023
+ const ignores = config.ignores || defaultIgnores;
1024
+
1025
+ return ignores(absolutePath);
1026
+ }
1027
+
1028
+ return defaultIgnores(absolutePath);
1029
+ }
1030
+
1031
+ /**
1032
+ * Returns the formatter representing the given format or null if the `format` is not a string.
1033
+ * @param {string} [format] The name of the format to load or the path to a
1034
+ * custom formatter.
1035
+ * @throws {any} As may be thrown by requiring of formatter
1036
+ * @returns {(FormatterFunction|null)} The formatter function or null if the `format` is not a string.
1037
+ */
1038
+ getFormatter(format) {
1039
+ // default is stylish
1040
+ const resolvedFormatName = format || "stylish";
1041
+
1042
+ // only strings are valid formatters
1043
+ if (typeof resolvedFormatName === "string") {
1044
+ // replace \ with / for Windows compatibility
1045
+ const normalizedFormatName = resolvedFormatName.replace(
1046
+ /\\/gu,
1047
+ "/",
1048
+ );
1049
+
1050
+ const slots = internalSlotsMap.get(this);
1051
+ const cwd = slots ? slots.options.cwd : process.cwd();
1052
+ const namespace = naming.getNamespaceFromTerm(normalizedFormatName);
1053
+
1054
+ let formatterPath;
1055
+
1056
+ // if there's a slash, then it's a file (TODO: this check seems dubious for scoped npm packages)
1057
+ if (!namespace && normalizedFormatName.includes("/")) {
1058
+ formatterPath = path.resolve(cwd, normalizedFormatName);
1059
+ } else {
1060
+ try {
1061
+ const npmFormat = naming.normalizePackageName(
1062
+ normalizedFormatName,
1063
+ "eslint-formatter",
1064
+ );
1065
+
1066
+ formatterPath = ModuleResolver.resolve(
1067
+ npmFormat,
1068
+ path.join(cwd, "__placeholder__.js"),
1069
+ );
1070
+ } catch {
1071
+ formatterPath = path.resolve(
1072
+ __dirname,
1073
+ "formatters",
1074
+ normalizedFormatName,
1075
+ );
1076
+ }
1077
+ }
1078
+
1079
+ try {
1080
+ return require(formatterPath);
1081
+ } catch (ex) {
1082
+ if (removedFormatters.has(format)) {
1083
+ ex.message = `The ${format} formatter is no longer part of core ESLint. Install it manually with \`npm install -D eslint-formatter-${format}\``;
1084
+ } else {
1085
+ ex.message = `There was a problem loading formatter: ${formatterPath}\nError: ${ex.message}`;
1086
+ }
1087
+ throw ex;
1088
+ }
1089
+ } else {
1090
+ return null;
1091
+ }
1092
+ }
1073
1093
  }
1074
1094
 
1075
1095
  CLIEngine.version = pkg.version;
1076
1096
  CLIEngine.getFormatter = CLIEngine.prototype.getFormatter;
1077
1097
 
1078
1098
  module.exports = {
1079
- CLIEngine,
1080
-
1081
- /**
1082
- * Get the internal slots of a given CLIEngine instance for tests.
1083
- * @param {CLIEngine} instance The CLIEngine instance to get.
1084
- * @returns {CLIEngineInternalSlots} The internal slots.
1085
- */
1086
- getCLIEngineInternalSlots(instance) {
1087
- return internalSlotsMap.get(instance);
1088
- }
1099
+ CLIEngine,
1100
+
1101
+ /**
1102
+ * Get the internal slots of a given CLIEngine instance for tests.
1103
+ * @param {CLIEngine} instance The CLIEngine instance to get.
1104
+ * @returns {CLIEngineInternalSlots} The internal slots.
1105
+ */
1106
+ getCLIEngineInternalSlots(instance) {
1107
+ return internalSlotsMap.get(instance);
1108
+ },
1089
1109
  };