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
@@ -1,1159 +0,0 @@
1
- /**
2
- * @fileoverview Main class using flat config
3
- * @author Nicholas C. Zakas
4
- */
5
-
6
- "use strict";
7
-
8
- //------------------------------------------------------------------------------
9
- // Requirements
10
- //------------------------------------------------------------------------------
11
-
12
- // Note: Node.js 12 does not support fs/promises.
13
- const fs = require("fs").promises;
14
- const { existsSync } = require("fs");
15
- const path = require("path");
16
- const findUp = require("find-up");
17
- const { version } = require("../../package.json");
18
- const { Linter } = require("../linter");
19
- const { getRuleFromConfig } = require("../config/flat-config-helpers");
20
- const {
21
- Legacy: {
22
- ConfigOps: {
23
- getRuleSeverity
24
- },
25
- ModuleResolver,
26
- naming
27
- }
28
- } = require("@eslint/eslintrc");
29
-
30
- const {
31
- findFiles,
32
- getCacheFile,
33
-
34
- isNonEmptyString,
35
- isArrayOfNonEmptyString,
36
-
37
- createIgnoreResult,
38
- isErrorMessage,
39
-
40
- processOptions
41
- } = require("./eslint-helpers");
42
- const { pathToFileURL } = require("url");
43
- const { FlatConfigArray } = require("../config/flat-config-array");
44
- const LintResultCache = require("../cli-engine/lint-result-cache");
45
-
46
- /*
47
- * This is necessary to allow overwriting writeFile for testing purposes.
48
- * We can just use fs/promises once we drop Node.js 12 support.
49
- */
50
-
51
- //------------------------------------------------------------------------------
52
- // Typedefs
53
- //------------------------------------------------------------------------------
54
-
55
- // For VSCode IntelliSense
56
- /** @typedef {import("../shared/types").ConfigData} ConfigData */
57
- /** @typedef {import("../shared/types").DeprecatedRuleInfo} DeprecatedRuleInfo */
58
- /** @typedef {import("../shared/types").LintMessage} LintMessage */
59
- /** @typedef {import("../shared/types").LintResult} LintResult */
60
- /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
61
- /** @typedef {import("../shared/types").Plugin} Plugin */
62
- /** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
63
- /** @typedef {import("../shared/types").RuleConf} RuleConf */
64
- /** @typedef {import("../shared/types").Rule} Rule */
65
- /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
66
-
67
- /**
68
- * The options with which to configure the ESLint instance.
69
- * @typedef {Object} FlatESLintOptions
70
- * @property {boolean} [allowInlineConfig] Enable or disable inline configuration comments.
71
- * @property {ConfigData} [baseConfig] Base config object, extended by all configs used with this instance
72
- * @property {boolean} [cache] Enable result caching.
73
- * @property {string} [cacheLocation] The cache file to use instead of .eslintcache.
74
- * @property {"metadata" | "content"} [cacheStrategy] The strategy used to detect changed files.
75
- * @property {string} [cwd] The value to use for the current working directory.
76
- * @property {boolean} [errorOnUnmatchedPattern] If `false` then `ESLint#lintFiles()` doesn't throw even if no target files found. Defaults to `true`.
77
- * @property {boolean|Function} [fix] Execute in autofix mode. If a function, should return a boolean.
78
- * @property {string[]} [fixTypes] Array of rule types to apply fixes for.
79
- * @property {boolean} [globInputPaths] Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
80
- * @property {boolean} [ignore] False disables all ignore patterns except for the default ones.
81
- * @property {string[]} [ignorePatterns] Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`.
82
- * @property {ConfigData} [overrideConfig] Override config object, overrides all configs used with this instance
83
- * @property {boolean|string} [overrideConfigFile] Searches for default config file when falsy;
84
- * doesn't do any config file lookup when `true`; considered to be a config filename
85
- * when a string.
86
- * @property {Record<string,Plugin>} [plugins] An array of plugin implementations.
87
- * @property {boolean} warnIgnored Show warnings when the file list includes ignored files
88
- */
89
-
90
- //------------------------------------------------------------------------------
91
- // Helpers
92
- //------------------------------------------------------------------------------
93
-
94
- const FLAT_CONFIG_FILENAMES = [
95
- "eslint.config.js",
96
- "eslint.config.mjs",
97
- "eslint.config.cjs"
98
- ];
99
- const debug = require("debug")("eslint:flat-eslint");
100
- const removedFormatters = new Set(["table", "codeframe"]);
101
- const privateMembers = new WeakMap();
102
- const importedConfigFileModificationTime = new Map();
103
-
104
- /**
105
- * It will calculate the error and warning count for collection of messages per file
106
- * @param {LintMessage[]} messages Collection of messages
107
- * @returns {Object} Contains the stats
108
- * @private
109
- */
110
- function calculateStatsPerFile(messages) {
111
- const stat = {
112
- errorCount: 0,
113
- fatalErrorCount: 0,
114
- warningCount: 0,
115
- fixableErrorCount: 0,
116
- fixableWarningCount: 0
117
- };
118
-
119
- for (let i = 0; i < messages.length; i++) {
120
- const message = messages[i];
121
-
122
- if (message.fatal || message.severity === 2) {
123
- stat.errorCount++;
124
- if (message.fatal) {
125
- stat.fatalErrorCount++;
126
- }
127
- if (message.fix) {
128
- stat.fixableErrorCount++;
129
- }
130
- } else {
131
- stat.warningCount++;
132
- if (message.fix) {
133
- stat.fixableWarningCount++;
134
- }
135
- }
136
- }
137
- return stat;
138
- }
139
-
140
- /**
141
- * Create rulesMeta object.
142
- * @param {Map<string,Rule>} rules a map of rules from which to generate the object.
143
- * @returns {Object} metadata for all enabled rules.
144
- */
145
- function createRulesMeta(rules) {
146
- return Array.from(rules).reduce((retVal, [id, rule]) => {
147
- retVal[id] = rule.meta;
148
- return retVal;
149
- }, {});
150
- }
151
-
152
- /**
153
- * Return the absolute path of a file named `"__placeholder__.js"` in a given directory.
154
- * This is used as a replacement for a missing file path.
155
- * @param {string} cwd An absolute directory path.
156
- * @returns {string} The absolute path of a file named `"__placeholder__.js"` in the given directory.
157
- */
158
- function getPlaceholderPath(cwd) {
159
- return path.join(cwd, "__placeholder__.js");
160
- }
161
-
162
- /** @type {WeakMap<ExtractedConfig, DeprecatedRuleInfo[]>} */
163
- const usedDeprecatedRulesCache = new WeakMap();
164
-
165
- /**
166
- * Create used deprecated rule list.
167
- * @param {CLIEngine} eslint The CLIEngine instance.
168
- * @param {string} maybeFilePath The absolute path to a lint target file or `"<text>"`.
169
- * @returns {DeprecatedRuleInfo[]} The used deprecated rule list.
170
- */
171
- function getOrFindUsedDeprecatedRules(eslint, maybeFilePath) {
172
- const {
173
- configs,
174
- options: { cwd }
175
- } = privateMembers.get(eslint);
176
- const filePath = path.isAbsolute(maybeFilePath)
177
- ? maybeFilePath
178
- : getPlaceholderPath(cwd);
179
- const config = configs.getConfig(filePath);
180
-
181
- // Most files use the same config, so cache it.
182
- if (config && !usedDeprecatedRulesCache.has(config)) {
183
- const retv = [];
184
-
185
- if (config.rules) {
186
- for (const [ruleId, ruleConf] of Object.entries(config.rules)) {
187
- if (getRuleSeverity(ruleConf) === 0) {
188
- continue;
189
- }
190
- const rule = getRuleFromConfig(ruleId, config);
191
- const meta = rule && rule.meta;
192
-
193
- if (meta && meta.deprecated) {
194
- retv.push({ ruleId, replacedBy: meta.replacedBy || [] });
195
- }
196
- }
197
- }
198
-
199
-
200
- usedDeprecatedRulesCache.set(config, Object.freeze(retv));
201
- }
202
-
203
- return config ? usedDeprecatedRulesCache.get(config) : Object.freeze([]);
204
- }
205
-
206
- /**
207
- * Processes the linting results generated by a CLIEngine linting report to
208
- * match the ESLint class's API.
209
- * @param {CLIEngine} eslint The CLIEngine instance.
210
- * @param {CLIEngineLintReport} report The CLIEngine linting report to process.
211
- * @returns {LintResult[]} The processed linting results.
212
- */
213
- function processLintReport(eslint, { results }) {
214
- const descriptor = {
215
- configurable: true,
216
- enumerable: true,
217
- get() {
218
- return getOrFindUsedDeprecatedRules(eslint, this.filePath);
219
- }
220
- };
221
-
222
- for (const result of results) {
223
- Object.defineProperty(result, "usedDeprecatedRules", descriptor);
224
- }
225
-
226
- return results;
227
- }
228
-
229
- /**
230
- * An Array.prototype.sort() compatible compare function to order results by their file path.
231
- * @param {LintResult} a The first lint result.
232
- * @param {LintResult} b The second lint result.
233
- * @returns {number} An integer representing the order in which the two results should occur.
234
- */
235
- function compareResultsByFilePath(a, b) {
236
- if (a.filePath < b.filePath) {
237
- return -1;
238
- }
239
-
240
- if (a.filePath > b.filePath) {
241
- return 1;
242
- }
243
-
244
- return 0;
245
- }
246
-
247
- /**
248
- * Searches from the current working directory up until finding the
249
- * given flat config filename.
250
- * @param {string} cwd The current working directory to search from.
251
- * @returns {Promise<string|undefined>} The filename if found or `undefined` if not.
252
- */
253
- function findFlatConfigFile(cwd) {
254
- return findUp(
255
- FLAT_CONFIG_FILENAMES,
256
- { cwd }
257
- );
258
- }
259
-
260
- /**
261
- * Load the config array from the given filename.
262
- * @param {string} filePath The filename to load from.
263
- * @returns {Promise<any>} The config loaded from the config file.
264
- */
265
- async function loadFlatConfigFile(filePath) {
266
- debug(`Loading config from ${filePath}`);
267
-
268
- const fileURL = pathToFileURL(filePath);
269
-
270
- debug(`Config file URL is ${fileURL}`);
271
-
272
- const mtime = (await fs.stat(filePath)).mtime.getTime();
273
-
274
- /*
275
- * Append a query with the config file's modification time (`mtime`) in order
276
- * to import the current version of the config file. Without the query, `import()` would
277
- * cache the config file module by the pathname only, and then always return
278
- * the same version (the one that was actual when the module was imported for the first time).
279
- *
280
- * This ensures that the config file module is loaded and executed again
281
- * if it has been changed since the last time it was imported.
282
- * If it hasn't been changed, `import()` will just return the cached version.
283
- *
284
- * Note that we should not overuse queries (e.g., by appending the current time
285
- * to always reload the config file module) as that could cause memory leaks
286
- * because entries are never removed from the import cache.
287
- */
288
- fileURL.searchParams.append("mtime", mtime);
289
-
290
- /*
291
- * With queries, we can bypass the import cache. However, when import-ing a CJS module,
292
- * Node.js uses the require infrastructure under the hood. That includes the require cache,
293
- * which caches the config file module by its file path (queries have no effect).
294
- * Therefore, we also need to clear the require cache before importing the config file module.
295
- * In order to get the same behavior with ESM and CJS config files, in particular - to reload
296
- * the config file only if it has been changed, we track file modification times and clear
297
- * the require cache only if the file has been changed.
298
- */
299
- if (importedConfigFileModificationTime.get(filePath) !== mtime) {
300
- delete require.cache[filePath];
301
- }
302
-
303
- const config = (await import(fileURL)).default;
304
-
305
- importedConfigFileModificationTime.set(filePath, mtime);
306
-
307
- return config;
308
- }
309
-
310
- /**
311
- * Determines which config file to use. This is determined by seeing if an
312
- * override config file was passed, and if so, using it; otherwise, as long
313
- * as override config file is not explicitly set to `false`, it will search
314
- * upwards from the cwd for a file named `eslint.config.js`.
315
- * @param {import("./eslint").ESLintOptions} options The ESLint instance options.
316
- * @returns {{configFilePath:string|undefined,basePath:string,error:Error|null}} Location information for
317
- * the config file.
318
- */
319
- async function locateConfigFileToUse({ configFile, cwd }) {
320
-
321
- // determine where to load config file from
322
- let configFilePath;
323
- let basePath = cwd;
324
- let error = null;
325
-
326
- if (typeof configFile === "string") {
327
- debug(`Override config file path is ${configFile}`);
328
- configFilePath = path.resolve(cwd, configFile);
329
- } else if (configFile !== false) {
330
- debug("Searching for eslint.config.js");
331
- configFilePath = await findFlatConfigFile(cwd);
332
-
333
- if (configFilePath) {
334
- basePath = path.resolve(path.dirname(configFilePath));
335
- } else {
336
- error = new Error("Could not find config file.");
337
- }
338
-
339
- }
340
-
341
- return {
342
- configFilePath,
343
- basePath,
344
- error
345
- };
346
-
347
- }
348
-
349
- /**
350
- * Calculates the config array for this run based on inputs.
351
- * @param {FlatESLint} eslint The instance to create the config array for.
352
- * @param {import("./eslint").ESLintOptions} options The ESLint instance options.
353
- * @returns {FlatConfigArray} The config array for `eslint``.
354
- */
355
- async function calculateConfigArray(eslint, {
356
- cwd,
357
- baseConfig,
358
- overrideConfig,
359
- configFile,
360
- ignore: shouldIgnore,
361
- ignorePatterns
362
- }) {
363
-
364
- // check for cached instance
365
- const slots = privateMembers.get(eslint);
366
-
367
- if (slots.configs) {
368
- return slots.configs;
369
- }
370
-
371
- const { configFilePath, basePath, error } = await locateConfigFileToUse({ configFile, cwd });
372
-
373
- // config file is required to calculate config
374
- if (error) {
375
- throw error;
376
- }
377
-
378
- const configs = new FlatConfigArray(baseConfig || [], { basePath, shouldIgnore });
379
-
380
- // load config file
381
- if (configFilePath) {
382
- const fileConfig = await loadFlatConfigFile(configFilePath);
383
-
384
- if (Array.isArray(fileConfig)) {
385
- configs.push(...fileConfig);
386
- } else {
387
- configs.push(fileConfig);
388
- }
389
- }
390
-
391
- // add in any configured defaults
392
- configs.push(...slots.defaultConfigs);
393
-
394
- // append command line ignore patterns
395
- if (ignorePatterns && ignorePatterns.length > 0) {
396
-
397
- let relativeIgnorePatterns;
398
-
399
- /*
400
- * If the config file basePath is different than the cwd, then
401
- * the ignore patterns won't work correctly. Here, we adjust the
402
- * ignore pattern to include the correct relative path. Patterns
403
- * passed as `ignorePatterns` are relative to the cwd, whereas
404
- * the config file basePath can be an ancestor of the cwd.
405
- */
406
- if (basePath === cwd) {
407
- relativeIgnorePatterns = ignorePatterns;
408
- } else {
409
-
410
- const relativeIgnorePath = path.relative(basePath, cwd);
411
-
412
- relativeIgnorePatterns = ignorePatterns.map(pattern => {
413
- const negated = pattern.startsWith("!");
414
- const basePattern = negated ? pattern.slice(1) : pattern;
415
-
416
- return (negated ? "!" : "") +
417
- path.posix.join(relativeIgnorePath, basePattern);
418
- });
419
- }
420
-
421
- /*
422
- * Ignore patterns are added to the end of the config array
423
- * so they can override default ignores.
424
- */
425
- configs.push({
426
- ignores: relativeIgnorePatterns
427
- });
428
- }
429
-
430
- if (overrideConfig) {
431
- if (Array.isArray(overrideConfig)) {
432
- configs.push(...overrideConfig);
433
- } else {
434
- configs.push(overrideConfig);
435
- }
436
- }
437
-
438
- await configs.normalize();
439
-
440
- // cache the config array for this instance
441
- slots.configs = configs;
442
-
443
- return configs;
444
- }
445
-
446
- /**
447
- * Processes an source code using ESLint.
448
- * @param {Object} config The config object.
449
- * @param {string} config.text The source code to verify.
450
- * @param {string} config.cwd The path to the current working directory.
451
- * @param {string|undefined} config.filePath The path to the file of `text`. If this is undefined, it uses `<text>`.
452
- * @param {FlatConfigArray} config.configs The config.
453
- * @param {boolean} config.fix If `true` then it does fix.
454
- * @param {boolean} config.allowInlineConfig If `true` then it uses directive comments.
455
- * @param {Linter} config.linter The linter instance to verify.
456
- * @returns {LintResult} The result of linting.
457
- * @private
458
- */
459
- function verifyText({
460
- text,
461
- cwd,
462
- filePath: providedFilePath,
463
- configs,
464
- fix,
465
- allowInlineConfig,
466
- linter
467
- }) {
468
- const filePath = providedFilePath || "<text>";
469
-
470
- debug(`Lint ${filePath}`);
471
-
472
- /*
473
- * Verify.
474
- * `config.extractConfig(filePath)` requires an absolute path, but `linter`
475
- * doesn't know CWD, so it gives `linter` an absolute path always.
476
- */
477
- const filePathToVerify = filePath === "<text>" ? getPlaceholderPath(cwd) : filePath;
478
- const { fixed, messages, output } = linter.verifyAndFix(
479
- text,
480
- configs,
481
- {
482
- allowInlineConfig,
483
- filename: filePathToVerify,
484
- fix,
485
-
486
- /**
487
- * Check if the linter should adopt a given code block or not.
488
- * @param {string} blockFilename The virtual filename of a code block.
489
- * @returns {boolean} `true` if the linter should adopt the code block.
490
- */
491
- filterCodeBlock(blockFilename) {
492
- return configs.getConfig(blockFilename) !== void 0;
493
- }
494
- }
495
- );
496
-
497
- // Tweak and return.
498
- const result = {
499
- filePath: filePath === "<text>" ? filePath : path.resolve(filePath),
500
- messages,
501
- suppressedMessages: linter.getSuppressedMessages(),
502
- ...calculateStatsPerFile(messages)
503
- };
504
-
505
- if (fixed) {
506
- result.output = output;
507
- }
508
-
509
- if (
510
- result.errorCount + result.warningCount > 0 &&
511
- typeof result.output === "undefined"
512
- ) {
513
- result.source = text;
514
- }
515
-
516
- return result;
517
- }
518
-
519
- /**
520
- * Checks whether a message's rule type should be fixed.
521
- * @param {LintMessage} message The message to check.
522
- * @param {FlatConfig} config The config for the file that generated the message.
523
- * @param {string[]} fixTypes An array of fix types to check.
524
- * @returns {boolean} Whether the message should be fixed.
525
- */
526
- function shouldMessageBeFixed(message, config, fixTypes) {
527
- if (!message.ruleId) {
528
- return fixTypes.has("directive");
529
- }
530
-
531
- const rule = message.ruleId && getRuleFromConfig(message.ruleId, config);
532
-
533
- return Boolean(rule && rule.meta && fixTypes.has(rule.meta.type));
534
- }
535
-
536
- /**
537
- * Creates an error to be thrown when an array of results passed to `getRulesMetaForResults` was not created by the current engine.
538
- * @returns {TypeError} An error object.
539
- */
540
- function createExtraneousResultsError() {
541
- return new TypeError("Results object was not created from this ESLint instance.");
542
- }
543
-
544
- /**
545
- * Creates a fixer function based on the provided fix, fixTypesSet, and config.
546
- * @param {Function|boolean} fix The original fix option.
547
- * @param {Set<string>} fixTypesSet A set of fix types to filter messages for fixing.
548
- * @param {FlatConfig} config The config for the file that generated the message.
549
- * @returns {Function|boolean} The fixer function or the original fix value.
550
- */
551
- function getFixerForFixTypes(fix, fixTypesSet, config) {
552
- if (!fix || !fixTypesSet) {
553
- return fix;
554
- }
555
-
556
- const originalFix = (typeof fix === "function") ? fix : () => true;
557
-
558
- return message => shouldMessageBeFixed(message, config, fixTypesSet) && originalFix(message);
559
- }
560
-
561
- //-----------------------------------------------------------------------------
562
- // Main API
563
- //-----------------------------------------------------------------------------
564
-
565
- /**
566
- * Primary Node.js API for ESLint.
567
- */
568
- class FlatESLint {
569
-
570
- /**
571
- * Creates a new instance of the main ESLint API.
572
- * @param {FlatESLintOptions} options The options for this instance.
573
- */
574
- constructor(options = {}) {
575
-
576
- const defaultConfigs = [];
577
- const processedOptions = processOptions(options);
578
- const linter = new Linter({
579
- cwd: processedOptions.cwd,
580
- configType: "flat"
581
- });
582
-
583
- const cacheFilePath = getCacheFile(
584
- processedOptions.cacheLocation,
585
- processedOptions.cwd
586
- );
587
-
588
- const lintResultCache = processedOptions.cache
589
- ? new LintResultCache(cacheFilePath, processedOptions.cacheStrategy)
590
- : null;
591
-
592
- privateMembers.set(this, {
593
- options: processedOptions,
594
- linter,
595
- cacheFilePath,
596
- lintResultCache,
597
- defaultConfigs,
598
- configs: null
599
- });
600
-
601
- /**
602
- * If additional plugins are passed in, add that to the default
603
- * configs for this instance.
604
- */
605
- if (options.plugins) {
606
-
607
- const plugins = {};
608
-
609
- for (const [pluginName, plugin] of Object.entries(options.plugins)) {
610
- plugins[naming.getShorthandName(pluginName, "eslint-plugin")] = plugin;
611
- }
612
-
613
- defaultConfigs.push({
614
- plugins
615
- });
616
- }
617
-
618
- }
619
-
620
- /**
621
- * The version text.
622
- * @type {string}
623
- */
624
- static get version() {
625
- return version;
626
- }
627
-
628
- /**
629
- * Outputs fixes from the given results to files.
630
- * @param {LintResult[]} results The lint results.
631
- * @returns {Promise<void>} Returns a promise that is used to track side effects.
632
- */
633
- static async outputFixes(results) {
634
- if (!Array.isArray(results)) {
635
- throw new Error("'results' must be an array");
636
- }
637
-
638
- await Promise.all(
639
- results
640
- .filter(result => {
641
- if (typeof result !== "object" || result === null) {
642
- throw new Error("'results' must include only objects");
643
- }
644
- return (
645
- typeof result.output === "string" &&
646
- path.isAbsolute(result.filePath)
647
- );
648
- })
649
- .map(r => fs.writeFile(r.filePath, r.output))
650
- );
651
- }
652
-
653
- /**
654
- * Returns results that only contains errors.
655
- * @param {LintResult[]} results The results to filter.
656
- * @returns {LintResult[]} The filtered results.
657
- */
658
- static getErrorResults(results) {
659
- const filtered = [];
660
-
661
- results.forEach(result => {
662
- const filteredMessages = result.messages.filter(isErrorMessage);
663
- const filteredSuppressedMessages = result.suppressedMessages.filter(isErrorMessage);
664
-
665
- if (filteredMessages.length > 0) {
666
- filtered.push({
667
- ...result,
668
- messages: filteredMessages,
669
- suppressedMessages: filteredSuppressedMessages,
670
- errorCount: filteredMessages.length,
671
- warningCount: 0,
672
- fixableErrorCount: result.fixableErrorCount,
673
- fixableWarningCount: 0
674
- });
675
- }
676
- });
677
-
678
- return filtered;
679
- }
680
-
681
- /**
682
- * Returns meta objects for each rule represented in the lint results.
683
- * @param {LintResult[]} results The results to fetch rules meta for.
684
- * @returns {Object} A mapping of ruleIds to rule meta objects.
685
- * @throws {TypeError} When the results object wasn't created from this ESLint instance.
686
- * @throws {TypeError} When a plugin or rule is missing.
687
- */
688
- getRulesMetaForResults(results) {
689
-
690
- // short-circuit simple case
691
- if (results.length === 0) {
692
- return {};
693
- }
694
-
695
- const resultRules = new Map();
696
- const {
697
- configs,
698
- options: { cwd }
699
- } = privateMembers.get(this);
700
-
701
- /*
702
- * We can only accurately return rules meta information for linting results if the
703
- * results were created by this instance. Otherwise, the necessary rules data is
704
- * not available. So if the config array doesn't already exist, just throw an error
705
- * to let the user know we can't do anything here.
706
- */
707
- if (!configs) {
708
- throw createExtraneousResultsError();
709
- }
710
-
711
- for (const result of results) {
712
-
713
- /*
714
- * Normalize filename for <text>.
715
- */
716
- const filePath = result.filePath === "<text>"
717
- ? getPlaceholderPath(cwd) : result.filePath;
718
- const allMessages = result.messages.concat(result.suppressedMessages);
719
-
720
- for (const { ruleId } of allMessages) {
721
- if (!ruleId) {
722
- continue;
723
- }
724
-
725
- /*
726
- * All of the plugin and rule information is contained within the
727
- * calculated config for the given file.
728
- */
729
- const config = configs.getConfig(filePath);
730
-
731
- if (!config) {
732
- throw createExtraneousResultsError();
733
- }
734
- const rule = getRuleFromConfig(ruleId, config);
735
-
736
- // ignore unknown rules
737
- if (rule) {
738
- resultRules.set(ruleId, rule);
739
- }
740
- }
741
- }
742
-
743
- return createRulesMeta(resultRules);
744
- }
745
-
746
- /**
747
- * Executes the current configuration on an array of file and directory names.
748
- * @param {string|string[]} patterns An array of file and directory names.
749
- * @returns {Promise<LintResult[]>} The results of linting the file patterns given.
750
- */
751
- async lintFiles(patterns) {
752
- if (!isNonEmptyString(patterns) && !isArrayOfNonEmptyString(patterns)) {
753
- throw new Error("'patterns' must be a non-empty string or an array of non-empty strings");
754
- }
755
-
756
- const {
757
- cacheFilePath,
758
- lintResultCache,
759
- linter,
760
- options: eslintOptions
761
- } = privateMembers.get(this);
762
- const configs = await calculateConfigArray(this, eslintOptions);
763
- const {
764
- allowInlineConfig,
765
- cache,
766
- cwd,
767
- fix,
768
- fixTypes,
769
- globInputPaths,
770
- errorOnUnmatchedPattern,
771
- warnIgnored
772
- } = eslintOptions;
773
- const startTime = Date.now();
774
- const fixTypesSet = fixTypes ? new Set(fixTypes) : null;
775
-
776
- // Delete cache file; should this be done here?
777
- if (!cache && cacheFilePath) {
778
- debug(`Deleting cache file at ${cacheFilePath}`);
779
-
780
- try {
781
- await fs.unlink(cacheFilePath);
782
- } catch (error) {
783
- const errorCode = error && error.code;
784
-
785
- // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
786
- if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !existsSync(cacheFilePath))) {
787
- throw error;
788
- }
789
- }
790
- }
791
-
792
- const filePaths = await findFiles({
793
- patterns: typeof patterns === "string" ? [patterns] : patterns,
794
- cwd,
795
- globInputPaths,
796
- configs,
797
- errorOnUnmatchedPattern
798
- });
799
-
800
- debug(`${filePaths.length} files found in: ${Date.now() - startTime}ms`);
801
-
802
- /*
803
- * Because we need to process multiple files, including reading from disk,
804
- * it is most efficient to start by reading each file via promises so that
805
- * they can be done in parallel. Then, we can lint the returned text. This
806
- * ensures we are waiting the minimum amount of time in between lints.
807
- */
808
- const results = await Promise.all(
809
-
810
- filePaths.map(filePath => {
811
-
812
- const config = configs.getConfig(filePath);
813
-
814
- /*
815
- * If a filename was entered that cannot be matched
816
- * to a config, then notify the user.
817
- */
818
- if (!config) {
819
- if (warnIgnored) {
820
- return createIgnoreResult(filePath, cwd);
821
- }
822
-
823
- return void 0;
824
- }
825
-
826
- // Skip if there is cached result.
827
- if (lintResultCache) {
828
- const cachedResult =
829
- lintResultCache.getCachedLintResults(filePath, config);
830
-
831
- if (cachedResult) {
832
- const hadMessages =
833
- cachedResult.messages &&
834
- cachedResult.messages.length > 0;
835
-
836
- if (hadMessages && fix) {
837
- debug(`Reprocessing cached file to allow autofix: ${filePath}`);
838
- } else {
839
- debug(`Skipping file since it hasn't changed: ${filePath}`);
840
- return cachedResult;
841
- }
842
- }
843
- }
844
-
845
-
846
- // set up fixer for fixTypes if necessary
847
- const fixer = getFixerForFixTypes(fix, fixTypesSet, config);
848
-
849
- return fs.readFile(filePath, "utf8")
850
- .then(text => {
851
-
852
- // do the linting
853
- const result = verifyText({
854
- text,
855
- filePath,
856
- configs,
857
- cwd,
858
- fix: fixer,
859
- allowInlineConfig,
860
- linter
861
- });
862
-
863
- /*
864
- * Store the lint result in the LintResultCache.
865
- * NOTE: The LintResultCache will remove the file source and any
866
- * other properties that are difficult to serialize, and will
867
- * hydrate those properties back in on future lint runs.
868
- */
869
- if (lintResultCache) {
870
- lintResultCache.setCachedLintResults(filePath, config, result);
871
- }
872
-
873
- return result;
874
- });
875
-
876
- })
877
- );
878
-
879
- // Persist the cache to disk.
880
- if (lintResultCache) {
881
- lintResultCache.reconcile();
882
- }
883
-
884
- const finalResults = results.filter(result => !!result);
885
-
886
- return processLintReport(this, {
887
- results: finalResults
888
- });
889
- }
890
-
891
- /**
892
- * Executes the current configuration on text.
893
- * @param {string} code A string of JavaScript code to lint.
894
- * @param {Object} [options] The options.
895
- * @param {string} [options.filePath] The path to the file of the source code.
896
- * @param {boolean} [options.warnIgnored] When set to true, warn if given filePath is an ignored path.
897
- * @returns {Promise<LintResult[]>} The results of linting the string of code given.
898
- */
899
- async lintText(code, options = {}) {
900
-
901
- // Parameter validation
902
-
903
- if (typeof code !== "string") {
904
- throw new Error("'code' must be a string");
905
- }
906
-
907
- if (typeof options !== "object") {
908
- throw new Error("'options' must be an object, null, or undefined");
909
- }
910
-
911
- // Options validation
912
-
913
- const {
914
- filePath,
915
- warnIgnored,
916
- ...unknownOptions
917
- } = options || {};
918
-
919
- const unknownOptionKeys = Object.keys(unknownOptions);
920
-
921
- if (unknownOptionKeys.length > 0) {
922
- throw new Error(`'options' must not include the unknown option(s): ${unknownOptionKeys.join(", ")}`);
923
- }
924
-
925
- if (filePath !== void 0 && !isNonEmptyString(filePath)) {
926
- throw new Error("'options.filePath' must be a non-empty string or undefined");
927
- }
928
-
929
- if (typeof warnIgnored !== "boolean" && typeof warnIgnored !== "undefined") {
930
- throw new Error("'options.warnIgnored' must be a boolean or undefined");
931
- }
932
-
933
- // Now we can get down to linting
934
-
935
- const {
936
- linter,
937
- options: eslintOptions
938
- } = privateMembers.get(this);
939
- const configs = await calculateConfigArray(this, eslintOptions);
940
- const {
941
- allowInlineConfig,
942
- cwd,
943
- fix,
944
- fixTypes,
945
- warnIgnored: constructorWarnIgnored
946
- } = eslintOptions;
947
- const results = [];
948
- const startTime = Date.now();
949
- const fixTypesSet = fixTypes ? new Set(fixTypes) : null;
950
- const resolvedFilename = path.resolve(cwd, filePath || "__placeholder__.js");
951
- const config = configs.getConfig(resolvedFilename);
952
-
953
- const fixer = getFixerForFixTypes(fix, fixTypesSet, config);
954
-
955
- // Clear the last used config arrays.
956
- if (resolvedFilename && await this.isPathIgnored(resolvedFilename)) {
957
- const shouldWarnIgnored = typeof warnIgnored === "boolean" ? warnIgnored : constructorWarnIgnored;
958
-
959
- if (shouldWarnIgnored) {
960
- results.push(createIgnoreResult(resolvedFilename, cwd));
961
- }
962
- } else {
963
-
964
- // Do lint.
965
- results.push(verifyText({
966
- text: code,
967
- filePath: resolvedFilename.endsWith("__placeholder__.js") ? "<text>" : resolvedFilename,
968
- configs,
969
- cwd,
970
- fix: fixer,
971
- allowInlineConfig,
972
- linter
973
- }));
974
- }
975
-
976
- debug(`Linting complete in: ${Date.now() - startTime}ms`);
977
-
978
- return processLintReport(this, {
979
- results
980
- });
981
-
982
- }
983
-
984
- /**
985
- * Returns the formatter representing the given formatter name.
986
- * @param {string} [name] The name of the formatter to load.
987
- * The following values are allowed:
988
- * - `undefined` ... Load `stylish` builtin formatter.
989
- * - A builtin formatter name ... Load the builtin formatter.
990
- * - A third-party formatter name:
991
- * - `foo` → `eslint-formatter-foo`
992
- * - `@foo` → `@foo/eslint-formatter`
993
- * - `@foo/bar` → `@foo/eslint-formatter-bar`
994
- * - A file path ... Load the file.
995
- * @returns {Promise<Formatter>} A promise resolving to the formatter object.
996
- * This promise will be rejected if the given formatter was not found or not
997
- * a function.
998
- */
999
- async loadFormatter(name = "stylish") {
1000
- if (typeof name !== "string") {
1001
- throw new Error("'name' must be a string");
1002
- }
1003
-
1004
- // replace \ with / for Windows compatibility
1005
- const normalizedFormatName = name.replace(/\\/gu, "/");
1006
- const namespace = naming.getNamespaceFromTerm(normalizedFormatName);
1007
-
1008
- // grab our options
1009
- const { cwd } = privateMembers.get(this).options;
1010
-
1011
-
1012
- let formatterPath;
1013
-
1014
- // if there's a slash, then it's a file (TODO: this check seems dubious for scoped npm packages)
1015
- if (!namespace && normalizedFormatName.includes("/")) {
1016
- formatterPath = path.resolve(cwd, normalizedFormatName);
1017
- } else {
1018
- try {
1019
- const npmFormat = naming.normalizePackageName(normalizedFormatName, "eslint-formatter");
1020
-
1021
- // TODO: This is pretty dirty...would be nice to clean up at some point.
1022
- formatterPath = ModuleResolver.resolve(npmFormat, getPlaceholderPath(cwd));
1023
- } catch {
1024
- formatterPath = path.resolve(__dirname, "../", "cli-engine", "formatters", `${normalizedFormatName}.js`);
1025
- }
1026
- }
1027
-
1028
- let formatter;
1029
-
1030
- try {
1031
- formatter = (await import(pathToFileURL(formatterPath))).default;
1032
- } catch (ex) {
1033
-
1034
- // check for formatters that have been removed
1035
- if (removedFormatters.has(name)) {
1036
- ex.message = `The ${name} formatter is no longer part of core ESLint. Install it manually with \`npm install -D eslint-formatter-${name}\``;
1037
- } else {
1038
- ex.message = `There was a problem loading formatter: ${formatterPath}\nError: ${ex.message}`;
1039
- }
1040
-
1041
- throw ex;
1042
- }
1043
-
1044
-
1045
- if (typeof formatter !== "function") {
1046
- throw new TypeError(`Formatter must be a function, but got a ${typeof formatter}.`);
1047
- }
1048
-
1049
- const eslint = this;
1050
-
1051
- return {
1052
-
1053
- /**
1054
- * The main formatter method.
1055
- * @param {LintResults[]} results The lint results to format.
1056
- * @param {ResultsMeta} resultsMeta Warning count and max threshold.
1057
- * @returns {string} The formatted lint results.
1058
- */
1059
- format(results, resultsMeta) {
1060
- let rulesMeta = null;
1061
-
1062
- results.sort(compareResultsByFilePath);
1063
-
1064
- return formatter(results, {
1065
- ...resultsMeta,
1066
- cwd,
1067
- get rulesMeta() {
1068
- if (!rulesMeta) {
1069
- rulesMeta = eslint.getRulesMetaForResults(results);
1070
- }
1071
-
1072
- return rulesMeta;
1073
- }
1074
- });
1075
- }
1076
- };
1077
- }
1078
-
1079
- /**
1080
- * Returns a configuration object for the given file based on the CLI options.
1081
- * This is the same logic used by the ESLint CLI executable to determine
1082
- * configuration for each file it processes.
1083
- * @param {string} filePath The path of the file to retrieve a config object for.
1084
- * @returns {Promise<ConfigData|undefined>} A configuration object for the file
1085
- * or `undefined` if there is no configuration data for the object.
1086
- */
1087
- async calculateConfigForFile(filePath) {
1088
- if (!isNonEmptyString(filePath)) {
1089
- throw new Error("'filePath' must be a non-empty string");
1090
- }
1091
- const options = privateMembers.get(this).options;
1092
- const absolutePath = path.resolve(options.cwd, filePath);
1093
- const configs = await calculateConfigArray(this, options);
1094
-
1095
- return configs.getConfig(absolutePath);
1096
- }
1097
-
1098
- /**
1099
- * Finds the config file being used by this instance based on the options
1100
- * passed to the constructor.
1101
- * @returns {string|undefined} The path to the config file being used or
1102
- * `undefined` if no config file is being used.
1103
- */
1104
- async findConfigFile() {
1105
- const options = privateMembers.get(this).options;
1106
- const { configFilePath } = await locateConfigFileToUse(options);
1107
-
1108
- return configFilePath;
1109
- }
1110
-
1111
- /**
1112
- * Checks if a given path is ignored by ESLint.
1113
- * @param {string} filePath The path of the file to check.
1114
- * @returns {Promise<boolean>} Whether or not the given path is ignored.
1115
- */
1116
- async isPathIgnored(filePath) {
1117
- const config = await this.calculateConfigForFile(filePath);
1118
-
1119
- return config === void 0;
1120
- }
1121
- }
1122
-
1123
- /**
1124
- * The type of configuration used by this class.
1125
- * @type {string}
1126
- * @static
1127
- */
1128
- FlatESLint.configType = "flat";
1129
-
1130
- /**
1131
- * Returns whether flat config should be used.
1132
- * @param {Object} [options] The options for this function.
1133
- * @param {string} [options.cwd] The current working directory.
1134
- * @returns {Promise<boolean>} Whether flat config should be used.
1135
- */
1136
- async function shouldUseFlatConfig({ cwd = process.cwd() } = {}) {
1137
- switch (process.env.ESLINT_USE_FLAT_CONFIG) {
1138
- case "true":
1139
- return true;
1140
- case "false":
1141
- return false;
1142
- default:
1143
-
1144
- /*
1145
- * If neither explicitly enabled nor disabled, then use the presence
1146
- * of a flat config file to determine enablement.
1147
- */
1148
- return !!(await findFlatConfigFile(cwd));
1149
- }
1150
- }
1151
-
1152
- //------------------------------------------------------------------------------
1153
- // Public Interface
1154
- //------------------------------------------------------------------------------
1155
-
1156
- module.exports = {
1157
- FlatESLint,
1158
- shouldUseFlatConfig
1159
- };