eslint 8.57.1 → 9.39.1

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 (458) hide show
  1. package/README.md +165 -115
  2. package/bin/eslint.js +112 -89
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +16 -0
  5. package/conf/globals.js +109 -94
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +89 -26
  8. package/lib/api.js +16 -20
  9. package/lib/cli-engine/cli-engine.js +841 -810
  10. package/lib/cli-engine/file-enumerator.js +384 -390
  11. package/lib/cli-engine/formatters/formatters-meta.json +17 -45
  12. package/lib/cli-engine/formatters/html.js +110 -102
  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 +97 -76
  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 +165 -148
  19. package/lib/cli-engine/load-rules.js +17 -17
  20. package/lib/cli.js +481 -399
  21. package/lib/config/config-loader.js +816 -0
  22. package/lib/config/config.js +674 -0
  23. package/lib/config/default-config.js +57 -46
  24. package/lib/config/flat-config-array.js +170 -333
  25. package/lib/config/flat-config-schema.js +389 -389
  26. package/lib/config-api.js +12 -0
  27. package/lib/eslint/eslint-helpers.js +1196 -663
  28. package/lib/eslint/eslint.js +1262 -607
  29. package/lib/eslint/index.js +3 -3
  30. package/lib/eslint/legacy-eslint.js +786 -0
  31. package/lib/eslint/worker.js +173 -0
  32. package/lib/languages/js/index.js +336 -0
  33. package/lib/languages/js/source-code/index.js +7 -0
  34. package/lib/languages/js/source-code/source-code.js +1364 -0
  35. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +61 -0
  36. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +57 -0
  37. package/lib/{source-code → languages/js/source-code}/token-store/cursor.js +36 -36
  38. package/lib/languages/js/source-code/token-store/cursors.js +120 -0
  39. package/lib/{source-code → languages/js/source-code}/token-store/decorative-cursor.js +17 -18
  40. package/lib/{source-code → languages/js/source-code}/token-store/filter-cursor.js +19 -20
  41. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +65 -0
  42. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +62 -0
  43. package/lib/languages/js/source-code/token-store/index.js +721 -0
  44. package/lib/{source-code → languages/js/source-code}/token-store/limit-cursor.js +17 -18
  45. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +45 -0
  46. package/lib/{source-code → languages/js/source-code}/token-store/skip-cursor.js +19 -20
  47. package/lib/languages/js/source-code/token-store/utils.js +110 -0
  48. package/lib/languages/js/validate-language-options.js +196 -0
  49. package/lib/linter/apply-disable-directives.js +490 -371
  50. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -674
  51. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  52. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  53. package/lib/linter/code-path-analysis/code-path.js +307 -317
  54. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  55. package/lib/linter/code-path-analysis/fork-context.js +297 -272
  56. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  57. package/lib/linter/esquery.js +332 -0
  58. package/lib/linter/file-context.js +144 -0
  59. package/lib/linter/file-report.js +608 -0
  60. package/lib/linter/index.js +3 -5
  61. package/lib/linter/interpolate.js +38 -16
  62. package/lib/linter/linter.js +2328 -1785
  63. package/lib/linter/rule-fixer.js +136 -107
  64. package/lib/linter/rules.js +37 -46
  65. package/lib/linter/source-code-fixer.js +96 -94
  66. package/lib/linter/source-code-traverser.js +333 -0
  67. package/lib/linter/source-code-visitor.js +81 -0
  68. package/lib/linter/timing.js +145 -97
  69. package/lib/linter/vfile.js +115 -0
  70. package/lib/options.js +464 -326
  71. package/lib/rule-tester/index.js +3 -1
  72. package/lib/rule-tester/rule-tester.js +1371 -998
  73. package/lib/rules/accessor-pairs.js +333 -259
  74. package/lib/rules/array-bracket-newline.js +250 -220
  75. package/lib/rules/array-bracket-spacing.js +286 -229
  76. package/lib/rules/array-callback-return.js +401 -354
  77. package/lib/rules/array-element-newline.js +358 -295
  78. package/lib/rules/arrow-body-style.js +400 -278
  79. package/lib/rules/arrow-parens.js +206 -155
  80. package/lib/rules/arrow-spacing.js +169 -145
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -158
  83. package/lib/rules/brace-style.js +262 -181
  84. package/lib/rules/callback-return.js +203 -174
  85. package/lib/rules/camelcase.js +403 -380
  86. package/lib/rules/capitalized-comments.js +253 -228
  87. package/lib/rules/class-methods-use-this.js +231 -168
  88. package/lib/rules/comma-dangle.js +379 -328
  89. package/lib/rules/comma-spacing.js +193 -177
  90. package/lib/rules/comma-style.js +375 -298
  91. package/lib/rules/complexity.js +180 -144
  92. package/lib/rules/computed-property-spacing.js +236 -193
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -141
  95. package/lib/rules/constructor-super.js +418 -411
  96. package/lib/rules/curly.js +407 -468
  97. package/lib/rules/default-case-last.js +39 -32
  98. package/lib/rules/default-case.js +89 -83
  99. package/lib/rules/default-param-last.js +69 -53
  100. package/lib/rules/dot-location.js +122 -92
  101. package/lib/rules/dot-notation.js +193 -153
  102. package/lib/rules/eol-last.js +122 -102
  103. package/lib/rules/eqeqeq.js +191 -155
  104. package/lib/rules/for-direction.js +150 -122
  105. package/lib/rules/func-call-spacing.js +261 -213
  106. package/lib/rules/func-name-matching.js +294 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +209 -86
  109. package/lib/rules/function-call-argument-newline.js +152 -111
  110. package/lib/rules/function-paren-newline.js +349 -273
  111. package/lib/rules/generator-star-spacing.js +229 -192
  112. package/lib/rules/getter-return.js +208 -170
  113. package/lib/rules/global-require.js +85 -58
  114. package/lib/rules/grouped-accessor-pairs.js +201 -148
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -87
  117. package/lib/rules/id-blacklist.js +182 -187
  118. package/lib/rules/id-denylist.js +174 -179
  119. package/lib/rules/id-length.js +197 -157
  120. package/lib/rules/id-match.js +350 -286
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -61
  122. package/lib/rules/indent-legacy.js +1345 -1102
  123. package/lib/rules/indent.js +2272 -1741
  124. package/lib/rules/index.js +320 -294
  125. package/lib/rules/init-declarations.js +139 -106
  126. package/lib/rules/jsx-quotes.js +94 -64
  127. package/lib/rules/key-spacing.js +750 -615
  128. package/lib/rules/keyword-spacing.js +648 -587
  129. package/lib/rules/line-comment-position.js +143 -108
  130. package/lib/rules/linebreak-style.js +115 -88
  131. package/lib/rules/lines-around-comment.js +540 -430
  132. package/lib/rules/lines-around-directive.js +233 -185
  133. package/lib/rules/lines-between-class-members.js +305 -216
  134. package/lib/rules/logical-assignment-operators.js +582 -398
  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 -416
  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 +102 -75
  142. package/lib/rules/max-statements-per-line.js +205 -180
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +638 -460
  145. package/lib/rules/multiline-ternary.js +241 -158
  146. package/lib/rules/new-cap.js +233 -232
  147. package/lib/rules/new-parens.js +88 -61
  148. package/lib/rules/newline-after-var.js +287 -233
  149. package/lib/rules/newline-before-return.js +229 -204
  150. package/lib/rules/newline-per-chained-call.js +142 -109
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +175 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +79 -70
  155. package/lib/rules/no-bitwise.js +113 -87
  156. package/lib/rules/no-buffer-constructor.js +61 -37
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -45
  159. package/lib/rules/no-catch-shadow.js +76 -62
  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 -63
  164. package/lib/rules/no-console.js +202 -188
  165. package/lib/rules/no-const-assign.js +58 -41
  166. package/lib/rules/no-constant-binary-expression.js +501 -407
  167. package/lib/rules/no-constant-condition.js +158 -131
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -26
  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 -40
  174. package/lib/rules/no-dupe-args.js +79 -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 +266 -188
  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 +197 -128
  183. package/lib/rules/no-empty-pattern.js +63 -56
  184. package/lib/rules/no-empty-static-block.js +61 -35
  185. package/lib/rules/no-empty.js +135 -85
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +258 -249
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -160
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -295
  192. package/lib/rules/no-extra-label.js +150 -130
  193. package/lib/rules/no-extra-parens.js +1654 -1307
  194. package/lib/rules/no-extra-semi.js +146 -126
  195. package/lib/rules/no-fallthrough.js +200 -136
  196. package/lib/rules/no-floating-decimal.js +74 -48
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -72
  199. package/lib/rules/no-implicit-coercion.js +350 -262
  200. package/lib/rules/no-implicit-globals.js +174 -133
  201. package/lib/rules/no-implied-eval.js +150 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -96
  204. package/lib/rules/no-inner-declarations.js +115 -78
  205. package/lib/rules/no-invalid-regexp.js +223 -174
  206. package/lib/rules/no-invalid-this.js +145 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -250
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -61
  210. package/lib/rules/no-labels.js +138 -131
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +105 -67
  213. package/lib/rules/no-loop-func.js +245 -184
  214. package/lib/rules/no-loss-of-precision.js +236 -201
  215. package/lib/rules/no-magic-numbers.js +339 -217
  216. package/lib/rules/no-misleading-character-class.js +548 -253
  217. package/lib/rules/no-mixed-operators.js +188 -164
  218. package/lib/rules/no-mixed-requires.js +253 -224
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +135 -103
  220. package/lib/rules/no-multi-assign.js +46 -47
  221. package/lib/rules/no-multi-spaces.js +163 -125
  222. package/lib/rules/no-multi-str.js +42 -40
  223. package/lib/rules/no-multiple-empty-lines.js +196 -140
  224. package/lib/rules/no-native-reassign.js +90 -74
  225. package/lib/rules/no-negated-condition.js +79 -74
  226. package/lib/rules/no-negated-in-lhs.js +45 -32
  227. package/lib/rules/no-nested-ternary.js +33 -31
  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 -39
  231. package/lib/rules/no-new-require.js +48 -31
  232. package/lib/rules/no-new-symbol.js +61 -43
  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 +149 -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 +29 -32
  240. package/lib/rules/no-param-reassign.js +236 -218
  241. package/lib/rules/no-path-concat.js +66 -51
  242. package/lib/rules/no-plusplus.js +60 -63
  243. package/lib/rules/no-process-env.js +49 -32
  244. package/lib/rules/no-process-exit.js +48 -28
  245. package/lib/rules/no-promise-executor-return.js +205 -204
  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 -155
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -174
  251. package/lib/rules/no-restricted-globals.js +254 -112
  252. package/lib/rules/no-restricted-imports.js +824 -384
  253. package/lib/rules/no-restricted-modules.js +222 -186
  254. package/lib/rules/no-restricted-properties.js +218 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +56 -49
  257. package/lib/rules/no-return-await.js +147 -120
  258. package/lib/rules/no-script-url.js +53 -46
  259. package/lib/rules/no-self-assign.js +148 -145
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -115
  262. package/lib/rules/no-setter-return.js +176 -178
  263. package/lib/rules/no-shadow-restricted-names.js +84 -36
  264. package/lib/rules/no-shadow.js +598 -310
  265. package/lib/rules/no-spaced-func.js +82 -60
  266. package/lib/rules/no-sparse-arrays.js +46 -28
  267. package/lib/rules/no-sync.js +61 -44
  268. package/lib/rules/no-tabs.js +83 -54
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -28
  271. package/lib/rules/no-this-before-super.js +332 -298
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +208 -174
  274. package/lib/rules/no-unassigned-vars.js +80 -0
  275. package/lib/rules/no-undef-init.js +86 -60
  276. package/lib/rules/no-undef.js +52 -47
  277. package/lib/rules/no-undefined.js +73 -74
  278. package/lib/rules/no-underscore-dangle.js +370 -322
  279. package/lib/rules/no-unexpected-multiline.js +112 -102
  280. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  281. package/lib/rules/no-unneeded-ternary.js +212 -146
  282. package/lib/rules/no-unreachable-loop.js +145 -140
  283. package/lib/rules/no-unreachable.js +255 -248
  284. package/lib/rules/no-unsafe-finally.js +93 -85
  285. package/lib/rules/no-unsafe-negation.js +105 -81
  286. package/lib/rules/no-unsafe-optional-chaining.js +193 -177
  287. package/lib/rules/no-unused-expressions.js +199 -158
  288. package/lib/rules/no-unused-labels.js +139 -124
  289. package/lib/rules/no-unused-private-class-members.js +206 -182
  290. package/lib/rules/no-unused-vars.js +1708 -687
  291. package/lib/rules/no-use-before-define.js +327 -229
  292. package/lib/rules/no-useless-assignment.js +654 -0
  293. package/lib/rules/no-useless-backreference.js +212 -143
  294. package/lib/rules/no-useless-call.js +58 -53
  295. package/lib/rules/no-useless-catch.js +40 -40
  296. package/lib/rules/no-useless-computed-key.js +144 -108
  297. package/lib/rules/no-useless-concat.js +65 -59
  298. package/lib/rules/no-useless-constructor.js +160 -97
  299. package/lib/rules/no-useless-escape.js +364 -291
  300. package/lib/rules/no-useless-rename.js +183 -153
  301. package/lib/rules/no-useless-return.js +344 -307
  302. package/lib/rules/no-var.js +245 -212
  303. package/lib/rules/no-void.js +51 -46
  304. package/lib/rules/no-warning-comments.js +191 -183
  305. package/lib/rules/no-whitespace-before-property.js +131 -97
  306. package/lib/rules/no-with.js +24 -26
  307. package/lib/rules/nonblock-statement-body-position.js +149 -112
  308. package/lib/rules/object-curly-newline.js +306 -247
  309. package/lib/rules/object-curly-spacing.js +360 -296
  310. package/lib/rules/object-property-newline.js +137 -88
  311. package/lib/rules/object-shorthand.js +632 -500
  312. package/lib/rules/one-var-declaration-per-line.js +104 -82
  313. package/lib/rules/one-var.js +686 -536
  314. package/lib/rules/operator-assignment.js +219 -158
  315. package/lib/rules/operator-linebreak.js +295 -233
  316. package/lib/rules/padded-blocks.js +346 -290
  317. package/lib/rules/padding-line-between-statements.js +443 -421
  318. package/lib/rules/prefer-arrow-callback.js +371 -315
  319. package/lib/rules/prefer-const.js +418 -373
  320. package/lib/rules/prefer-destructuring.js +309 -278
  321. package/lib/rules/prefer-exponentiation-operator.js +176 -132
  322. package/lib/rules/prefer-named-capture-group.js +160 -141
  323. package/lib/rules/prefer-numeric-literals.js +121 -112
  324. package/lib/rules/prefer-object-has-own.js +116 -82
  325. package/lib/rules/prefer-object-spread.js +214 -193
  326. package/lib/rules/prefer-promise-reject-errors.js +140 -118
  327. package/lib/rules/prefer-reflect.js +126 -103
  328. package/lib/rules/prefer-regex-literals.js +561 -463
  329. package/lib/rules/prefer-rest-params.js +79 -80
  330. package/lib/rules/prefer-spread.js +47 -43
  331. package/lib/rules/prefer-template.js +266 -194
  332. package/lib/rules/preserve-caught-error.js +535 -0
  333. package/lib/rules/quote-props.js +373 -289
  334. package/lib/rules/quotes.js +374 -308
  335. package/lib/rules/radix.js +152 -134
  336. package/lib/rules/require-atomic-updates.js +316 -282
  337. package/lib/rules/require-await.js +153 -82
  338. package/lib/rules/require-unicode-regexp.js +296 -108
  339. package/lib/rules/require-yield.js +53 -54
  340. package/lib/rules/rest-spread-spacing.js +128 -98
  341. package/lib/rules/semi-spacing.js +281 -232
  342. package/lib/rules/semi-style.js +176 -116
  343. package/lib/rules/semi.js +456 -418
  344. package/lib/rules/sort-imports.js +307 -229
  345. package/lib/rules/sort-keys.js +219 -181
  346. package/lib/rules/sort-vars.js +127 -91
  347. package/lib/rules/space-before-blocks.js +199 -171
  348. package/lib/rules/space-before-function-paren.js +186 -148
  349. package/lib/rules/space-in-parens.js +359 -270
  350. package/lib/rules/space-infix-ops.js +237 -183
  351. package/lib/rules/space-unary-ops.js +356 -280
  352. package/lib/rules/spaced-comment.js +363 -301
  353. package/lib/rules/strict.js +266 -229
  354. package/lib/rules/switch-colon-spacing.js +130 -104
  355. package/lib/rules/symbol-description.js +45 -48
  356. package/lib/rules/template-curly-spacing.js +148 -124
  357. package/lib/rules/template-tag-spacing.js +98 -70
  358. package/lib/rules/unicode-bom.js +54 -54
  359. package/lib/rules/use-isnan.js +237 -110
  360. package/lib/rules/utils/ast-utils.js +2139 -1688
  361. package/lib/rules/utils/char-source.js +247 -0
  362. package/lib/rules/utils/fix-tracker.js +99 -88
  363. package/lib/rules/utils/keywords.js +59 -59
  364. package/lib/rules/utils/lazy-loading-rule-map.js +81 -78
  365. package/lib/rules/utils/regular-expressions.js +35 -19
  366. package/lib/rules/utils/unicode/index.js +9 -4
  367. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  368. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  369. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  370. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  371. package/lib/rules/valid-typeof.js +153 -109
  372. package/lib/rules/vars-on-top.js +152 -144
  373. package/lib/rules/wrap-iife.js +204 -173
  374. package/lib/rules/wrap-regex.js +77 -47
  375. package/lib/rules/yield-star-spacing.js +145 -116
  376. package/lib/rules/yoda.js +283 -274
  377. package/lib/services/parser-service.js +65 -0
  378. package/lib/services/processor-service.js +101 -0
  379. package/lib/services/suppressions-service.js +302 -0
  380. package/lib/services/warning-service.js +98 -0
  381. package/lib/shared/ajv.js +14 -14
  382. package/lib/shared/assert.js +21 -0
  383. package/lib/shared/ast-utils.js +7 -6
  384. package/lib/shared/deep-merge-arrays.js +62 -0
  385. package/lib/shared/directives.js +3 -2
  386. package/lib/shared/flags.js +108 -0
  387. package/lib/shared/logging.js +24 -16
  388. package/lib/shared/naming.js +109 -0
  389. package/lib/shared/option-utils.js +63 -0
  390. package/lib/shared/relative-module-resolver.js +18 -40
  391. package/lib/shared/runtime-info.js +138 -128
  392. package/lib/shared/serialization.js +78 -0
  393. package/lib/shared/severity.js +22 -22
  394. package/lib/shared/stats.js +30 -0
  395. package/lib/shared/string-utils.js +19 -21
  396. package/lib/shared/text-table.js +68 -0
  397. package/lib/shared/translate-cli-options.js +281 -0
  398. package/lib/shared/traverser.js +153 -146
  399. package/lib/types/config-api.d.ts +12 -0
  400. package/lib/types/index.d.ts +1473 -0
  401. package/lib/types/rules.d.ts +5589 -0
  402. package/lib/types/universal.d.ts +6 -0
  403. package/lib/types/use-at-your-own-risk.d.ts +87 -0
  404. package/lib/universal.js +10 -0
  405. package/lib/unsupported-api.js +8 -9
  406. package/messages/all-files-ignored.js +3 -3
  407. package/messages/all-matched-files-ignored.js +21 -0
  408. package/messages/config-file-missing.js +16 -0
  409. package/messages/config-plugin-missing.js +14 -0
  410. package/messages/config-serialize-function.js +30 -0
  411. package/messages/eslintrc-incompat.js +35 -16
  412. package/messages/eslintrc-plugins.js +8 -5
  413. package/messages/extend-config-missing.js +3 -3
  414. package/messages/failed-to-read-json.js +3 -3
  415. package/messages/file-not-found.js +3 -3
  416. package/messages/invalid-rule-options.js +2 -2
  417. package/messages/invalid-rule-severity.js +2 -2
  418. package/messages/no-config-found.js +4 -4
  419. package/messages/plugin-conflict.js +9 -9
  420. package/messages/plugin-invalid.js +4 -4
  421. package/messages/plugin-missing.js +4 -4
  422. package/messages/print-config-with-directory-path.js +2 -2
  423. package/messages/shared.js +6 -1
  424. package/messages/whitespace-found.js +3 -3
  425. package/package.json +105 -60
  426. package/conf/config-schema.js +0 -93
  427. package/lib/cli-engine/formatters/checkstyle.js +0 -60
  428. package/lib/cli-engine/formatters/compact.js +0 -60
  429. package/lib/cli-engine/formatters/jslint-xml.js +0 -41
  430. package/lib/cli-engine/formatters/junit.js +0 -82
  431. package/lib/cli-engine/formatters/tap.js +0 -95
  432. package/lib/cli-engine/formatters/unix.js +0 -58
  433. package/lib/cli-engine/formatters/visualstudio.js +0 -63
  434. package/lib/cli-engine/xml-escape.js +0 -34
  435. package/lib/config/flat-config-helpers.js +0 -111
  436. package/lib/config/rule-validator.js +0 -158
  437. package/lib/eslint/flat-eslint.js +0 -1159
  438. package/lib/linter/config-comment-parser.js +0 -185
  439. package/lib/linter/node-event-generator.js +0 -354
  440. package/lib/linter/report-translator.js +0 -369
  441. package/lib/linter/safe-emitter.js +0 -52
  442. package/lib/rule-tester/flat-rule-tester.js +0 -1131
  443. package/lib/rules/require-jsdoc.js +0 -122
  444. package/lib/rules/utils/patterns/letters.js +0 -36
  445. package/lib/rules/valid-jsdoc.js +0 -516
  446. package/lib/shared/config-validator.js +0 -347
  447. package/lib/shared/deprecation-warnings.js +0 -58
  448. package/lib/shared/types.js +0 -216
  449. package/lib/source-code/index.js +0 -5
  450. package/lib/source-code/source-code.js +0 -1055
  451. package/lib/source-code/token-store/backward-token-comment-cursor.js +0 -57
  452. package/lib/source-code/token-store/backward-token-cursor.js +0 -58
  453. package/lib/source-code/token-store/cursors.js +0 -90
  454. package/lib/source-code/token-store/forward-token-comment-cursor.js +0 -57
  455. package/lib/source-code/token-store/forward-token-cursor.js +0 -63
  456. package/lib/source-code/token-store/index.js +0 -627
  457. package/lib/source-code/token-store/padded-token-cursor.js +0 -38
  458. package/lib/source-code/token-store/utils.js +0 -107
@@ -15,21 +15,20 @@
15
15
  // Requirements
16
16
  //------------------------------------------------------------------------------
17
17
 
18
- const fs = require("fs");
19
- const path = require("path");
18
+ const fs = require("node:fs");
19
+ 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");
@@ -41,6 +40,17 @@ const hash = require("./hash");
41
40
  const LintResultCache = require("./lint-result-cache");
42
41
 
43
42
  const debug = require("debug")("eslint:cli-engine");
43
+ const removedFormatters = new Set([
44
+ "checkstyle",
45
+ "codeframe",
46
+ "compact",
47
+ "jslint-xml",
48
+ "junit",
49
+ "table",
50
+ "tap",
51
+ "unix",
52
+ "visualstudio",
53
+ ]);
44
54
  const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
45
55
 
46
56
  //------------------------------------------------------------------------------
@@ -48,15 +58,15 @@ const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
48
58
  //------------------------------------------------------------------------------
49
59
 
50
60
  // For VSCode IntelliSense
51
- /** @typedef {import("../shared/types").ConfigData} ConfigData */
52
- /** @typedef {import("../shared/types").DeprecatedRuleInfo} DeprecatedRuleInfo */
53
- /** @typedef {import("../shared/types").LintMessage} LintMessage */
54
- /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
55
- /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
56
- /** @typedef {import("../shared/types").Plugin} Plugin */
57
- /** @typedef {import("../shared/types").RuleConf} RuleConf */
58
- /** @typedef {import("../shared/types").Rule} Rule */
59
- /** @typedef {import("../shared/types").FormatterFunction} FormatterFunction */
61
+ /** @typedef {import("../types").ESLint.ConfigData} ConfigData */
62
+ /** @typedef {import("../types").ESLint.DeprecatedRuleUse} DeprecatedRuleInfo */
63
+ /** @typedef {import("../types").ESLint.FormatterFunction} FormatterFunction */
64
+ /** @typedef {import("../types").Linter.LintMessage} LintMessage */
65
+ /** @typedef {import("../types").Linter.ParserOptions} ParserOptions */
66
+ /** @typedef {import("../types").ESLint.Plugin} Plugin */
67
+ /** @typedef {import("../types").Rule.RuleModule} Rule */
68
+ /** @typedef {import("../types").Linter.RuleEntry} RuleConf */
69
+ /** @typedef {import("../types").Linter.SuppressedLintMessage} SuppressedLintMessage */
60
70
  /** @typedef {ReturnType<CascadingConfigArrayFactory.getConfigArrayForFile>} ConfigArray */
61
71
  /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
62
72
 
@@ -144,11 +154,11 @@ const internalSlotsMap = new WeakMap();
144
154
  * @throws {Error} If an invalid fix type is found.
145
155
  */
146
156
  function validateFixTypes(fixTypes) {
147
- for (const fixType of fixTypes) {
148
- if (!validFixTypes.has(fixType)) {
149
- throw new Error(`Invalid fix type "${fixType}" found.`);
150
- }
151
- }
157
+ for (const fixType of fixTypes) {
158
+ if (!validFixTypes.has(fixType)) {
159
+ throw new Error(`Invalid fix type "${fixType}" found.`);
160
+ }
161
+ }
152
162
  }
153
163
 
154
164
  /**
@@ -158,33 +168,33 @@ function validateFixTypes(fixTypes) {
158
168
  * @private
159
169
  */
160
170
  function calculateStatsPerFile(messages) {
161
- const stat = {
162
- errorCount: 0,
163
- fatalErrorCount: 0,
164
- warningCount: 0,
165
- fixableErrorCount: 0,
166
- fixableWarningCount: 0
167
- };
168
-
169
- for (let i = 0; i < messages.length; i++) {
170
- const message = messages[i];
171
-
172
- if (message.fatal || message.severity === 2) {
173
- stat.errorCount++;
174
- if (message.fatal) {
175
- stat.fatalErrorCount++;
176
- }
177
- if (message.fix) {
178
- stat.fixableErrorCount++;
179
- }
180
- } else {
181
- stat.warningCount++;
182
- if (message.fix) {
183
- stat.fixableWarningCount++;
184
- }
185
- }
186
- }
187
- 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;
188
198
  }
189
199
 
190
200
  /**
@@ -194,25 +204,25 @@ function calculateStatsPerFile(messages) {
194
204
  * @private
195
205
  */
196
206
  function calculateStatsPerRun(results) {
197
- const stat = {
198
- errorCount: 0,
199
- fatalErrorCount: 0,
200
- warningCount: 0,
201
- fixableErrorCount: 0,
202
- fixableWarningCount: 0
203
- };
204
-
205
- for (let i = 0; i < results.length; i++) {
206
- const result = results[i];
207
-
208
- stat.errorCount += result.errorCount;
209
- stat.fatalErrorCount += result.fatalErrorCount;
210
- stat.warningCount += result.warningCount;
211
- stat.fixableErrorCount += result.fixableErrorCount;
212
- stat.fixableWarningCount += result.fixableWarningCount;
213
- }
214
-
215
- 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;
216
226
  }
217
227
 
218
228
  /**
@@ -231,65 +241,62 @@ function calculateStatsPerRun(results) {
231
241
  * @private
232
242
  */
233
243
  function verifyText({
234
- text,
235
- cwd,
236
- filePath: providedFilePath,
237
- config,
238
- fix,
239
- allowInlineConfig,
240
- reportUnusedDisableDirectives,
241
- fileEnumerator,
242
- linter
244
+ text,
245
+ cwd,
246
+ filePath: providedFilePath,
247
+ config,
248
+ fix,
249
+ allowInlineConfig,
250
+ reportUnusedDisableDirectives,
251
+ fileEnumerator,
252
+ linter,
243
253
  }) {
244
- const filePath = providedFilePath || "<text>";
245
-
246
- debug(`Lint ${filePath}`);
247
-
248
- /*
249
- * Verify.
250
- * `config.extractConfig(filePath)` requires an absolute path, but `linter`
251
- * doesn't know CWD, so it gives `linter` an absolute path always.
252
- */
253
- const filePathToVerify = filePath === "<text>" ? path.join(cwd, filePath) : filePath;
254
- const { fixed, messages, output } = linter.verifyAndFix(
255
- text,
256
- config,
257
- {
258
- allowInlineConfig,
259
- filename: filePathToVerify,
260
- fix,
261
- reportUnusedDisableDirectives,
262
-
263
- /**
264
- * Check if the linter should adopt a given code block or not.
265
- * @param {string} blockFilename The virtual filename of a code block.
266
- * @returns {boolean} `true` if the linter should adopt the code block.
267
- */
268
- filterCodeBlock(blockFilename) {
269
- return fileEnumerator.isTargetPath(blockFilename);
270
- }
271
- }
272
- );
273
-
274
- // Tweak and return.
275
- const result = {
276
- filePath,
277
- messages,
278
- suppressedMessages: linter.getSuppressedMessages(),
279
- ...calculateStatsPerFile(messages)
280
- };
281
-
282
- if (fixed) {
283
- result.output = output;
284
- }
285
- if (
286
- result.errorCount + result.warningCount > 0 &&
287
- typeof result.output === "undefined"
288
- ) {
289
- result.source = text;
290
- }
291
-
292
- 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;
293
300
  }
294
301
 
295
302
  /**
@@ -300,37 +307,42 @@ function verifyText({
300
307
  * @private
301
308
  */
302
309
  function createIgnoreResult(filePath, baseDir) {
303
- let message;
304
- const isHidden = filePath.split(path.sep)
305
- .find(segment => /^\./u.test(segment));
306
- const isInNodeModules = baseDir && path.relative(baseDir, filePath).startsWith("node_modules");
307
-
308
- if (isHidden) {
309
- message = "File ignored by default. Use a negated ignore pattern (like \"--ignore-pattern '!<relative/path/to/filename>'\") to override.";
310
- } else if (isInNodeModules) {
311
- message = "File ignored by default. Use \"--ignore-pattern '!node_modules/*'\" to override.";
312
- } else {
313
- message = "File ignored because of a matching ignore pattern. Use \"--no-ignore\" to override.";
314
- }
315
-
316
- return {
317
- filePath: path.resolve(filePath),
318
- messages: [
319
- {
320
- ruleId: null,
321
- fatal: false,
322
- severity: 1,
323
- message,
324
- nodeType: null
325
- }
326
- ],
327
- suppressedMessages: [],
328
- errorCount: 0,
329
- fatalErrorCount: 0,
330
- warningCount: 1,
331
- fixableErrorCount: 0,
332
- fixableWarningCount: 0
333
- };
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
+ };
334
346
  }
335
347
 
336
348
  /**
@@ -340,14 +352,14 @@ function createIgnoreResult(filePath, baseDir) {
340
352
  * @returns {Rule|null} The rule or null.
341
353
  */
342
354
  function getRule(ruleId, configArrays) {
343
- for (const configArray of configArrays) {
344
- const rule = configArray.pluginRules.get(ruleId);
345
-
346
- if (rule) {
347
- return rule;
348
- }
349
- }
350
- 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;
351
363
  }
352
364
 
353
365
  /**
@@ -358,13 +370,13 @@ function getRule(ruleId, configArrays) {
358
370
  * @returns {boolean} Whether the message should be fixed.
359
371
  */
360
372
  function shouldMessageBeFixed(message, lastConfigArrays, fixTypes) {
361
- if (!message.ruleId) {
362
- return fixTypes.has("directive");
363
- }
373
+ if (!message.ruleId) {
374
+ return fixTypes.has("directive");
375
+ }
364
376
 
365
- const rule = message.ruleId && getRule(message.ruleId, lastConfigArrays);
377
+ const rule = message.ruleId && getRule(message.ruleId, lastConfigArrays);
366
378
 
367
- return Boolean(rule && rule.meta && fixTypes.has(rule.meta.type));
379
+ return Boolean(rule && rule.meta && fixTypes.has(rule.meta.type));
368
380
  }
369
381
 
370
382
  /**
@@ -372,41 +384,40 @@ function shouldMessageBeFixed(message, lastConfigArrays, fixTypes) {
372
384
  * @param {ConfigArray[]} usedConfigArrays The config arrays which were used.
373
385
  * @returns {IterableIterator<DeprecatedRuleInfo>} Used deprecated rules.
374
386
  */
375
- function *iterateRuleDeprecationWarnings(usedConfigArrays) {
376
- const processedRuleIds = new Set();
377
-
378
- // Flatten used configs.
379
- /** @type {ExtractedConfig[]} */
380
- const configs = usedConfigArrays.flatMap(getUsedExtractedConfigs);
381
-
382
- // Traverse rule configs.
383
- for (const config of configs) {
384
- for (const [ruleId, ruleConfig] of Object.entries(config.rules)) {
385
-
386
- // Skip if it was processed.
387
- if (processedRuleIds.has(ruleId)) {
388
- continue;
389
- }
390
- processedRuleIds.add(ruleId);
391
-
392
- // Skip if it's not used.
393
- if (!ConfigOps.getRuleSeverity(ruleConfig)) {
394
- continue;
395
- }
396
- const rule = getRule(ruleId, usedConfigArrays);
397
-
398
- // Skip if it's not deprecated.
399
- if (!(rule && rule.meta && rule.meta.deprecated)) {
400
- continue;
401
- }
402
-
403
- // This rule was used and deprecated.
404
- yield {
405
- ruleId,
406
- replacedBy: rule.meta.replacedBy || []
407
- };
408
- }
409
- }
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
+ }
410
421
  }
411
422
 
412
423
  /**
@@ -416,10 +427,9 @@ function *iterateRuleDeprecationWarnings(usedConfigArrays) {
416
427
  * @private
417
428
  */
418
429
  function isErrorMessage(message) {
419
- return message.severity === 2;
430
+ return message.severity === 2;
420
431
  }
421
432
 
422
-
423
433
  /**
424
434
  * return the cacheFile to be used by eslint, based on whether the provided parameter is
425
435
  * a directory or looks like a directory (ends in `path.sep`), in which case the file
@@ -431,65 +441,62 @@ function isErrorMessage(message) {
431
441
  * @returns {string} the resolved path to the cache file
432
442
  */
433
443
  function getCacheFile(cacheFile, cwd) {
434
-
435
- /*
436
- * make sure the path separators are normalized for the environment/os
437
- * keeping the trailing path separator if present
438
- */
439
- const normalizedCacheFile = path.normalize(cacheFile);
440
-
441
- const resolvedCacheFile = path.resolve(cwd, normalizedCacheFile);
442
- const looksLikeADirectory = normalizedCacheFile.slice(-1) === path.sep;
443
-
444
- /**
445
- * return the name for the cache file in case the provided parameter is a directory
446
- * @returns {string} the resolved path to the cacheFile
447
- */
448
- function getCacheFileForDirectory() {
449
- return path.join(resolvedCacheFile, `.cache_${hash(cwd)}`);
450
- }
451
-
452
- let fileStats;
453
-
454
- try {
455
- fileStats = fs.lstatSync(resolvedCacheFile);
456
- } catch {
457
- fileStats = null;
458
- }
459
-
460
-
461
- /*
462
- * in case the file exists we need to verify if the provided path
463
- * is a directory or a file. If it is a directory we want to create a file
464
- * inside that directory
465
- */
466
- if (fileStats) {
467
-
468
- /*
469
- * is a directory or is a file, but the original file the user provided
470
- * looks like a directory but `path.resolve` removed the `last path.sep`
471
- * so we need to still treat this like a directory
472
- */
473
- if (fileStats.isDirectory() || looksLikeADirectory) {
474
- return getCacheFileForDirectory();
475
- }
476
-
477
- // is file so just use that file
478
- return resolvedCacheFile;
479
- }
480
-
481
- /*
482
- * here we known the file or directory doesn't exist,
483
- * so we will try to infer if its a directory if it looks like a directory
484
- * for the current operating system.
485
- */
486
-
487
- // if the last character passed is a path separator we assume is a directory
488
- if (looksLikeADirectory) {
489
- return getCacheFileForDirectory();
490
- }
491
-
492
- 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;
493
500
  }
494
501
 
495
502
  /**
@@ -501,23 +508,21 @@ function getCacheFile(cacheFile, cwd) {
501
508
  * @returns {Record<string,boolean>} The boolean map.
502
509
  */
503
510
  function toBooleanMap(keys, defaultValue, displayName) {
504
- if (keys && !Array.isArray(keys)) {
505
- throw new Error(`${displayName} must be an array.`);
506
- }
507
- if (keys && keys.length > 0) {
508
- return keys.reduce((map, def) => {
509
- const [key, value] = def.split(":");
510
-
511
- if (key !== "__proto__") {
512
- map[key] = value === void 0
513
- ? defaultValue
514
- : value === "true";
515
- }
516
-
517
- return map;
518
- }, {});
519
- }
520
- 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;
521
526
  }
522
527
 
523
528
  /**
@@ -526,36 +531,30 @@ function toBooleanMap(keys, defaultValue, displayName) {
526
531
  * @returns {ConfigData|null} The created config data.
527
532
  */
528
533
  function createConfigDataFromOptions(options) {
529
- const {
530
- ignorePattern,
531
- parser,
532
- parserOptions,
533
- plugins,
534
- rules
535
- } = options;
536
- const env = toBooleanMap(options.envs, true, "envs");
537
- const globals = toBooleanMap(options.globals, false, "globals");
538
-
539
- if (
540
- env === void 0 &&
541
- globals === void 0 &&
542
- (ignorePattern === void 0 || ignorePattern.length === 0) &&
543
- parser === void 0 &&
544
- parserOptions === void 0 &&
545
- plugins === void 0 &&
546
- rules === void 0
547
- ) {
548
- return null;
549
- }
550
- return {
551
- env,
552
- globals,
553
- ignorePatterns: ignorePattern,
554
- parser,
555
- parserOptions,
556
- plugins,
557
- rules
558
- };
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
+ };
559
558
  }
560
559
 
561
560
  /**
@@ -565,14 +564,14 @@ function createConfigDataFromOptions(options) {
565
564
  * @returns {boolean} `true` if a directory exists
566
565
  */
567
566
  function directoryExists(resolvedPath) {
568
- try {
569
- return fs.statSync(resolvedPath).isDirectory();
570
- } catch (error) {
571
- if (error && (error.code === "ENOENT" || error.code === "ENOTDIR")) {
572
- return false;
573
- }
574
- throw error;
575
- }
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
+ }
576
575
  }
577
576
 
578
577
  //------------------------------------------------------------------------------
@@ -583,496 +582,528 @@ function directoryExists(resolvedPath) {
583
582
  * Core CLI.
584
583
  */
585
584
  class CLIEngine {
586
-
587
- /**
588
- * Creates a new instance of the core CLI engine.
589
- * @param {CLIEngineOptions} providedOptions The options for this instance.
590
- * @param {Object} [additionalData] Additional settings that are not CLIEngineOptions.
591
- * @param {Record<string,Plugin>|null} [additionalData.preloadedPlugins] Preloaded plugins.
592
- */
593
- constructor(providedOptions, { preloadedPlugins } = {}) {
594
- const options = Object.assign(
595
- Object.create(null),
596
- defaultOptions,
597
- { cwd: process.cwd() },
598
- providedOptions
599
- );
600
-
601
- if (options.fix === void 0) {
602
- options.fix = false;
603
- }
604
-
605
- const additionalPluginPool = new Map();
606
-
607
- if (preloadedPlugins) {
608
- for (const [id, plugin] of Object.entries(preloadedPlugins)) {
609
- additionalPluginPool.set(id, plugin);
610
- }
611
- }
612
-
613
- const cacheFilePath = getCacheFile(
614
- options.cacheLocation || options.cacheFile,
615
- options.cwd
616
- );
617
- const configArrayFactory = new CascadingConfigArrayFactory({
618
- additionalPluginPool,
619
- baseConfig: options.baseConfig || null,
620
- cliConfig: createConfigDataFromOptions(options),
621
- cwd: options.cwd,
622
- ignorePath: options.ignorePath,
623
- resolvePluginsRelativeTo: options.resolvePluginsRelativeTo,
624
- rulePaths: options.rulePaths,
625
- specificConfigPath: options.configFile,
626
- useEslintrc: options.useEslintrc,
627
- builtInRules,
628
- loadRules,
629
- getEslintRecommendedConfig: () => require("@eslint/js").configs.recommended,
630
- getEslintAllConfig: () => require("@eslint/js").configs.all
631
- });
632
- const fileEnumerator = new FileEnumerator({
633
- configArrayFactory,
634
- cwd: options.cwd,
635
- extensions: options.extensions,
636
- globInputPaths: options.globInputPaths,
637
- errorOnUnmatchedPattern: options.errorOnUnmatchedPattern,
638
- ignore: options.ignore
639
- });
640
- const lintResultCache =
641
- options.cache ? new LintResultCache(cacheFilePath, options.cacheStrategy) : null;
642
- const linter = new Linter({ cwd: options.cwd });
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 = (typeof options.fix === "function")
672
- ? options.fix : () => true;
673
-
674
- options.fix = message => shouldMessageBeFixed(message, lastConfigArrays, fixTypes) && originalFix(message);
675
- }
676
- }
677
-
678
- getRules() {
679
- const { lastConfigArrays } = internalSlotsMap.get(this);
680
-
681
- return new Map(function *() {
682
- yield* builtInRules;
683
-
684
- for (const configArray of lastConfigArrays) {
685
- yield* configArray.pluginRules;
686
- }
687
- }());
688
- }
689
-
690
- /**
691
- * Returns results that only contains errors.
692
- * @param {LintResult[]} results The results to filter.
693
- * @returns {LintResult[]} The filtered results.
694
- */
695
- static getErrorResults(results) {
696
- const filtered = [];
697
-
698
- results.forEach(result => {
699
- const filteredMessages = result.messages.filter(isErrorMessage);
700
- const filteredSuppressedMessages = result.suppressedMessages.filter(isErrorMessage);
701
-
702
- if (filteredMessages.length > 0) {
703
- filtered.push({
704
- ...result,
705
- messages: filteredMessages,
706
- suppressedMessages: filteredSuppressedMessages,
707
- errorCount: filteredMessages.length,
708
- warningCount: 0,
709
- fixableErrorCount: result.fixableErrorCount,
710
- fixableWarningCount: 0
711
- });
712
- }
713
- });
714
-
715
- return filtered;
716
- }
717
-
718
- /**
719
- * Outputs fixes from the given results to files.
720
- * @param {LintReport} report The report object created by CLIEngine.
721
- * @returns {void}
722
- */
723
- static outputFixes(report) {
724
- report.results.filter(result => Object.prototype.hasOwnProperty.call(result, "output")).forEach(result => {
725
- fs.writeFileSync(result.filePath, result.output);
726
- });
727
- }
728
-
729
- /**
730
- * Resolves the patterns passed into executeOnFiles() into glob-based patterns
731
- * for easier handling.
732
- * @param {string[]} patterns The file patterns passed on the command line.
733
- * @returns {string[]} The equivalent glob patterns.
734
- */
735
- resolveFileGlobPatterns(patterns) {
736
- const { options } = internalSlotsMap.get(this);
737
-
738
- if (options.globInputPaths === false) {
739
- return patterns.filter(Boolean);
740
- }
741
-
742
- const extensions = (options.extensions || [".js"]).map(ext => ext.replace(/^\./u, ""));
743
- const dirSuffix = `/**/*.{${extensions.join(",")}}`;
744
-
745
- return patterns.filter(Boolean).map(pathname => {
746
- const resolvedPath = path.resolve(options.cwd, pathname);
747
- const newPath = directoryExists(resolvedPath)
748
- ? pathname.replace(/[/\\]$/u, "") + dirSuffix
749
- : pathname;
750
-
751
- return path.normalize(newPath).replace(/\\/gu, "/");
752
- });
753
- }
754
-
755
- /**
756
- * Executes the current configuration on an array of file and directory names.
757
- * @param {string[]} patterns An array of file and directory names.
758
- * @throws {Error} As may be thrown by `fs.unlinkSync`.
759
- * @returns {LintReport} The results for all files that were linted.
760
- */
761
- executeOnFiles(patterns) {
762
- const {
763
- cacheFilePath,
764
- fileEnumerator,
765
- lastConfigArrays,
766
- lintResultCache,
767
- linter,
768
- options: {
769
- allowInlineConfig,
770
- cache,
771
- cwd,
772
- fix,
773
- reportUnusedDisableDirectives
774
- }
775
- } = internalSlotsMap.get(this);
776
- const results = [];
777
- const startTime = Date.now();
778
-
779
- // Clear the last used config arrays.
780
- lastConfigArrays.length = 0;
781
-
782
- // Delete cache file; should this do here?
783
- if (!cache) {
784
- try {
785
- fs.unlinkSync(cacheFilePath);
786
- } catch (error) {
787
- const errorCode = error && error.code;
788
-
789
- // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
790
- if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !fs.existsSync(cacheFilePath))) {
791
- throw error;
792
- }
793
- }
794
- }
795
-
796
- // Iterate source code files.
797
- for (const { config, filePath, ignored } of fileEnumerator.iterateFiles(patterns)) {
798
- if (ignored) {
799
- results.push(createIgnoreResult(filePath, cwd));
800
- continue;
801
- }
802
-
803
- /*
804
- * Store used configs for:
805
- * - this method uses to collect used deprecated rules.
806
- * - `getRules()` method uses to collect all loaded rules.
807
- * - `--fix-type` option uses to get the loaded rule's meta data.
808
- */
809
- if (!lastConfigArrays.includes(config)) {
810
- lastConfigArrays.push(config);
811
- }
812
-
813
- // Skip if there is cached result.
814
- if (lintResultCache) {
815
- const cachedResult =
816
- lintResultCache.getCachedLintResults(filePath, config);
817
-
818
- if (cachedResult) {
819
- const hadMessages =
820
- cachedResult.messages &&
821
- cachedResult.messages.length > 0;
822
-
823
- if (hadMessages && fix) {
824
- debug(`Reprocessing cached file to allow autofix: ${filePath}`);
825
- } else {
826
- debug(`Skipping file since it hasn't changed: ${filePath}`);
827
- results.push(cachedResult);
828
- continue;
829
- }
830
- }
831
- }
832
-
833
- // Do lint.
834
- const result = verifyText({
835
- text: fs.readFileSync(filePath, "utf8"),
836
- filePath,
837
- config,
838
- cwd,
839
- fix,
840
- allowInlineConfig,
841
- reportUnusedDisableDirectives,
842
- fileEnumerator,
843
- linter
844
- });
845
-
846
- results.push(result);
847
-
848
- /*
849
- * Store the lint result in the LintResultCache.
850
- * NOTE: The LintResultCache will remove the file source and any
851
- * other properties that are difficult to serialize, and will
852
- * hydrate those properties back in on future lint runs.
853
- */
854
- if (lintResultCache) {
855
- lintResultCache.setCachedLintResults(filePath, config, result);
856
- }
857
- }
858
-
859
- // Persist the cache to disk.
860
- if (lintResultCache) {
861
- lintResultCache.reconcile();
862
- }
863
-
864
- debug(`Linting complete in: ${Date.now() - startTime}ms`);
865
- let usedDeprecatedRules;
866
-
867
- return {
868
- results,
869
- ...calculateStatsPerRun(results),
870
-
871
- // Initialize it lazily because CLI and `ESLint` API don't use it.
872
- get usedDeprecatedRules() {
873
- if (!usedDeprecatedRules) {
874
- usedDeprecatedRules = Array.from(
875
- iterateRuleDeprecationWarnings(lastConfigArrays)
876
- );
877
- }
878
- return usedDeprecatedRules;
879
- }
880
- };
881
- }
882
-
883
- /**
884
- * Executes the current configuration on text.
885
- * @param {string} text A string of JavaScript code to lint.
886
- * @param {string} [filename] An optional string representing the texts filename.
887
- * @param {boolean} [warnIgnored] Always warn when a file is ignored
888
- * @returns {LintReport} The results for the linting.
889
- */
890
- executeOnText(text, filename, warnIgnored) {
891
- const {
892
- configArrayFactory,
893
- fileEnumerator,
894
- lastConfigArrays,
895
- linter,
896
- options: {
897
- allowInlineConfig,
898
- cwd,
899
- fix,
900
- reportUnusedDisableDirectives
901
- }
902
- } = internalSlotsMap.get(this);
903
- const results = [];
904
- const startTime = Date.now();
905
- const resolvedFilename = filename && path.resolve(cwd, filename);
906
-
907
-
908
- // Clear the last used config arrays.
909
- lastConfigArrays.length = 0;
910
- if (resolvedFilename && this.isPathIgnored(resolvedFilename)) {
911
- if (warnIgnored) {
912
- results.push(createIgnoreResult(resolvedFilename, cwd));
913
- }
914
- } else {
915
- const config = configArrayFactory.getConfigArrayForFile(
916
- resolvedFilename || "__placeholder__.js"
917
- );
918
-
919
- /*
920
- * Store used configs for:
921
- * - this method uses to collect used deprecated rules.
922
- * - `getRules()` method uses to collect all loaded rules.
923
- * - `--fix-type` option uses to get the loaded rule's meta data.
924
- */
925
- lastConfigArrays.push(config);
926
-
927
- // Do lint.
928
- results.push(verifyText({
929
- text,
930
- filePath: resolvedFilename,
931
- config,
932
- cwd,
933
- fix,
934
- allowInlineConfig,
935
- reportUnusedDisableDirectives,
936
- fileEnumerator,
937
- linter
938
- }));
939
- }
940
-
941
- debug(`Linting complete in: ${Date.now() - startTime}ms`);
942
- let usedDeprecatedRules;
943
-
944
- return {
945
- results,
946
- ...calculateStatsPerRun(results),
947
-
948
- // Initialize it lazily because CLI and `ESLint` API don't use it.
949
- get usedDeprecatedRules() {
950
- if (!usedDeprecatedRules) {
951
- usedDeprecatedRules = Array.from(
952
- iterateRuleDeprecationWarnings(lastConfigArrays)
953
- );
954
- }
955
- return usedDeprecatedRules;
956
- }
957
- };
958
- }
959
-
960
- /**
961
- * Returns a configuration object for the given file based on the CLI options.
962
- * This is the same logic used by the ESLint CLI executable to determine
963
- * configuration for each file it processes.
964
- * @param {string} filePath The path of the file to retrieve a config object for.
965
- * @throws {Error} If filepath a directory path.
966
- * @returns {ConfigData} A configuration object for the file.
967
- */
968
- getConfigForFile(filePath) {
969
- const { configArrayFactory, options } = internalSlotsMap.get(this);
970
- const absolutePath = path.resolve(options.cwd, filePath);
971
-
972
- if (directoryExists(absolutePath)) {
973
- throw Object.assign(
974
- new Error("'filePath' should not be a directory path."),
975
- { messageTemplate: "print-config-with-directory-path" }
976
- );
977
- }
978
-
979
- return configArrayFactory
980
- .getConfigArrayForFile(absolutePath)
981
- .extractConfig(absolutePath)
982
- .toCompatibleObjectAsConfigFileContent();
983
- }
984
-
985
- /**
986
- * Checks if a given path is ignored by ESLint.
987
- * @param {string} filePath The path of the file to check.
988
- * @returns {boolean} Whether or not the given path is ignored.
989
- */
990
- isPathIgnored(filePath) {
991
- const {
992
- configArrayFactory,
993
- defaultIgnores,
994
- options: { cwd, ignore }
995
- } = internalSlotsMap.get(this);
996
- const absolutePath = path.resolve(cwd, filePath);
997
-
998
- if (ignore) {
999
- const config = configArrayFactory
1000
- .getConfigArrayForFile(absolutePath)
1001
- .extractConfig(absolutePath);
1002
- const ignores = config.ignores || defaultIgnores;
1003
-
1004
- return ignores(absolutePath);
1005
- }
1006
-
1007
- return defaultIgnores(absolutePath);
1008
- }
1009
-
1010
- /**
1011
- * Returns the formatter representing the given format or null if the `format` is not a string.
1012
- * @param {string} [format] The name of the format to load or the path to a
1013
- * custom formatter.
1014
- * @throws {any} As may be thrown by requiring of formatter
1015
- * @returns {(FormatterFunction|null)} The formatter function or null if the `format` is not a string.
1016
- */
1017
- getFormatter(format) {
1018
-
1019
- // default is stylish
1020
- const resolvedFormatName = format || "stylish";
1021
-
1022
- // only strings are valid formatters
1023
- if (typeof resolvedFormatName === "string") {
1024
-
1025
- // replace \ with / for Windows compatibility
1026
- const normalizedFormatName = resolvedFormatName.replace(/\\/gu, "/");
1027
-
1028
- const slots = internalSlotsMap.get(this);
1029
- const cwd = slots ? slots.options.cwd : process.cwd();
1030
- const namespace = naming.getNamespaceFromTerm(normalizedFormatName);
1031
-
1032
- let formatterPath;
1033
-
1034
- // if there's a slash, then it's a file (TODO: this check seems dubious for scoped npm packages)
1035
- if (!namespace && normalizedFormatName.includes("/")) {
1036
- formatterPath = path.resolve(cwd, normalizedFormatName);
1037
- } else {
1038
- try {
1039
- const npmFormat = naming.normalizePackageName(normalizedFormatName, "eslint-formatter");
1040
-
1041
- formatterPath = ModuleResolver.resolve(npmFormat, path.join(cwd, "__placeholder__.js"));
1042
- } catch {
1043
- formatterPath = path.resolve(__dirname, "formatters", normalizedFormatName);
1044
- }
1045
- }
1046
-
1047
- try {
1048
- return require(formatterPath);
1049
- } catch (ex) {
1050
- if (format === "table" || format === "codeframe") {
1051
- ex.message = `The ${format} formatter is no longer part of core ESLint. Install it manually with \`npm install -D eslint-formatter-${format}\``;
1052
- } else {
1053
- ex.message = `There was a problem loading formatter: ${formatterPath}\nError: ${ex.message}`;
1054
- }
1055
- throw ex;
1056
- }
1057
-
1058
- } else {
1059
- return null;
1060
- }
1061
- }
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
+ }
1062
1093
  }
1063
1094
 
1064
1095
  CLIEngine.version = pkg.version;
1065
1096
  CLIEngine.getFormatter = CLIEngine.prototype.getFormatter;
1066
1097
 
1067
1098
  module.exports = {
1068
- CLIEngine,
1069
-
1070
- /**
1071
- * Get the internal slots of a given CLIEngine instance for tests.
1072
- * @param {CLIEngine} instance The CLIEngine instance to get.
1073
- * @returns {CLIEngineInternalSlots} The internal slots.
1074
- */
1075
- getCLIEngineInternalSlots(instance) {
1076
- return internalSlotsMap.get(instance);
1077
- }
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
+ },
1078
1109
  };