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
@@ -22,14 +22,16 @@ const baseTypes = new Set(["Identifier", "Super", "ThisExpression"]);
22
22
  * @returns {boolean} True iff "undefined" or "void ..."
23
23
  */
24
24
  function isUndefined(expression, scope) {
25
- if (expression.type === "Identifier" && expression.name === "undefined") {
26
- return astUtils.isReferenceToGlobalVariable(scope, expression);
27
- }
28
-
29
- return expression.type === "UnaryExpression" &&
30
- expression.operator === "void" &&
31
- expression.argument.type === "Literal" &&
32
- expression.argument.value === 0;
25
+ if (expression.type === "Identifier" && expression.name === "undefined") {
26
+ return astUtils.isReferenceToGlobalVariable(scope, expression);
27
+ }
28
+
29
+ return (
30
+ expression.type === "UnaryExpression" &&
31
+ expression.operator === "void" &&
32
+ expression.argument.type === "Literal" &&
33
+ expression.argument.value === 0
34
+ );
33
35
  }
34
36
 
35
37
  /**
@@ -38,8 +40,10 @@ function isUndefined(expression, scope) {
38
40
  * @returns {boolean} True for identifiers and member expressions
39
41
  */
40
42
  function isReference(expression) {
41
- return (expression.type === "Identifier" && expression.name !== "undefined") ||
42
- expression.type === "MemberExpression";
43
+ return (
44
+ (expression.type === "Identifier" && expression.name !== "undefined") ||
45
+ expression.type === "MemberExpression"
46
+ );
43
47
  }
44
48
 
45
49
  /**
@@ -50,15 +54,21 @@ function isReference(expression) {
50
54
  * @returns {boolean} True iff implicit nullish comparison
51
55
  */
52
56
  function isImplicitNullishComparison(expression, scope) {
53
- if (expression.type !== "BinaryExpression" || expression.operator !== "==") {
54
- return false;
55
- }
56
-
57
- const reference = isReference(expression.left) ? "left" : "right";
58
- const nullish = reference === "left" ? "right" : "left";
59
-
60
- return isReference(expression[reference]) &&
61
- (astUtils.isNullLiteral(expression[nullish]) || isUndefined(expression[nullish], scope));
57
+ if (
58
+ expression.type !== "BinaryExpression" ||
59
+ expression.operator !== "=="
60
+ ) {
61
+ return false;
62
+ }
63
+
64
+ const reference = isReference(expression.left) ? "left" : "right";
65
+ const nullish = reference === "left" ? "right" : "left";
66
+
67
+ return (
68
+ isReference(expression[reference]) &&
69
+ (astUtils.isNullLiteral(expression[nullish]) ||
70
+ isUndefined(expression[nullish], scope))
71
+ );
62
72
  }
63
73
 
64
74
  /**
@@ -67,12 +77,14 @@ function isImplicitNullishComparison(expression, scope) {
67
77
  * @returns {boolean} True iff matches ? === ? || ? === ?
68
78
  */
69
79
  function isDoubleComparison(expression) {
70
- return expression.type === "LogicalExpression" &&
71
- expression.operator === "||" &&
72
- expression.left.type === "BinaryExpression" &&
73
- expression.left.operator === "===" &&
74
- expression.right.type === "BinaryExpression" &&
75
- expression.right.operator === "===";
80
+ return (
81
+ expression.type === "LogicalExpression" &&
82
+ expression.operator === "||" &&
83
+ expression.left.type === "BinaryExpression" &&
84
+ expression.left.operator === "===" &&
85
+ expression.right.type === "BinaryExpression" &&
86
+ expression.right.operator === "==="
87
+ );
76
88
  }
77
89
 
78
90
  /**
@@ -83,17 +95,26 @@ function isDoubleComparison(expression) {
83
95
  * @returns {boolean} True iff explicit nullish comparison
84
96
  */
85
97
  function isExplicitNullishComparison(expression, scope) {
86
- if (!isDoubleComparison(expression)) {
87
- return false;
88
- }
89
- const leftReference = isReference(expression.left.left) ? "left" : "right";
90
- const leftNullish = leftReference === "left" ? "right" : "left";
91
- const rightReference = isReference(expression.right.left) ? "left" : "right";
92
- const rightNullish = rightReference === "left" ? "right" : "left";
93
-
94
- return astUtils.isSameReference(expression.left[leftReference], expression.right[rightReference]) &&
95
- ((astUtils.isNullLiteral(expression.left[leftNullish]) && isUndefined(expression.right[rightNullish], scope)) ||
96
- (isUndefined(expression.left[leftNullish], scope) && astUtils.isNullLiteral(expression.right[rightNullish])));
98
+ if (!isDoubleComparison(expression)) {
99
+ return false;
100
+ }
101
+ const leftReference = isReference(expression.left.left) ? "left" : "right";
102
+ const leftNullish = leftReference === "left" ? "right" : "left";
103
+ const rightReference = isReference(expression.right.left)
104
+ ? "left"
105
+ : "right";
106
+ const rightNullish = rightReference === "left" ? "right" : "left";
107
+
108
+ return (
109
+ astUtils.isSameReference(
110
+ expression.left[leftReference],
111
+ expression.right[rightReference],
112
+ ) &&
113
+ ((astUtils.isNullLiteral(expression.left[leftNullish]) &&
114
+ isUndefined(expression.right[rightNullish], scope)) ||
115
+ (isUndefined(expression.left[leftNullish], scope) &&
116
+ astUtils.isNullLiteral(expression.right[rightNullish])))
117
+ );
97
118
  }
98
119
 
99
120
  /**
@@ -103,10 +124,12 @@ function isExplicitNullishComparison(expression, scope) {
103
124
  * @returns {boolean} Whether the expression is a boolean cast
104
125
  */
105
126
  function isBooleanCast(expression, scope) {
106
- return expression.type === "CallExpression" &&
107
- expression.callee.name === "Boolean" &&
108
- expression.arguments.length === 1 &&
109
- astUtils.isReferenceToGlobalVariable(scope, expression.callee);
127
+ return (
128
+ expression.type === "CallExpression" &&
129
+ expression.callee.name === "Boolean" &&
130
+ expression.arguments.length === 1 &&
131
+ astUtils.isReferenceToGlobalVariable(scope, expression.callee)
132
+ );
110
133
  }
111
134
 
112
135
  /**
@@ -119,22 +142,39 @@ function isBooleanCast(expression, scope) {
119
142
  * @returns {?{ reference: ASTNode, operator: '??'|'||'|'&&'}} Null if not a known existence
120
143
  */
121
144
  function getExistence(expression, scope) {
122
- const isNegated = expression.type === "UnaryExpression" && expression.operator === "!";
123
- const base = isNegated ? expression.argument : expression;
124
-
125
- switch (true) {
126
- case isReference(base):
127
- return { reference: base, operator: isNegated ? "||" : "&&" };
128
- case base.type === "UnaryExpression" && base.operator === "!" && isReference(base.argument):
129
- return { reference: base.argument, operator: "&&" };
130
- case isBooleanCast(base, scope) && isReference(base.arguments[0]):
131
- return { reference: base.arguments[0], operator: isNegated ? "||" : "&&" };
132
- case isImplicitNullishComparison(expression, scope):
133
- return { reference: isReference(expression.left) ? expression.left : expression.right, operator: "??" };
134
- case isExplicitNullishComparison(expression, scope):
135
- return { reference: isReference(expression.left.left) ? expression.left.left : expression.left.right, operator: "??" };
136
- default: return null;
137
- }
145
+ const isNegated =
146
+ expression.type === "UnaryExpression" && expression.operator === "!";
147
+ const base = isNegated ? expression.argument : expression;
148
+
149
+ switch (true) {
150
+ case isReference(base):
151
+ return { reference: base, operator: isNegated ? "||" : "&&" };
152
+ case base.type === "UnaryExpression" &&
153
+ base.operator === "!" &&
154
+ isReference(base.argument):
155
+ return { reference: base.argument, operator: "&&" };
156
+ case isBooleanCast(base, scope) && isReference(base.arguments[0]):
157
+ return {
158
+ reference: base.arguments[0],
159
+ operator: isNegated ? "||" : "&&",
160
+ };
161
+ case isImplicitNullishComparison(expression, scope):
162
+ return {
163
+ reference: isReference(expression.left)
164
+ ? expression.left
165
+ : expression.right,
166
+ operator: "??",
167
+ };
168
+ case isExplicitNullishComparison(expression, scope):
169
+ return {
170
+ reference: isReference(expression.left.left)
171
+ ? expression.left.left
172
+ : expression.left.right,
173
+ operator: "??",
174
+ };
175
+ default:
176
+ return null;
177
+ }
138
178
  }
139
179
 
140
180
  /**
@@ -143,11 +183,13 @@ function getExistence(expression, scope) {
143
183
  * @returns {boolean} True iff passed node is inside a with block
144
184
  */
145
185
  function isInsideWithBlock(node) {
146
- if (node.type === "Program") {
147
- return false;
148
- }
186
+ if (node.type === "Program") {
187
+ return false;
188
+ }
149
189
 
150
- return node.parent.type === "WithStatement" && node.parent.body === node ? true : isInsideWithBlock(node.parent);
190
+ return node.parent.type === "WithStatement" && node.parent.body === node
191
+ ? true
192
+ : isInsideWithBlock(node.parent);
151
193
  }
152
194
 
153
195
  /**
@@ -157,348 +199,490 @@ function isInsideWithBlock(node) {
157
199
  * @returns {Expression} Leftmost operand
158
200
  */
159
201
  function getLeftmostOperand(sourceCode, node) {
160
- let left = node.left;
161
-
162
- while (left.type === "LogicalExpression" && left.operator === node.operator) {
163
-
164
- if (astUtils.isParenthesised(sourceCode, left)) {
165
-
166
- /*
167
- * It should have associativity,
168
- * but ignore it if use parentheses to make the evaluation order clear.
169
- */
170
- return left;
171
- }
172
- left = left.left;
173
- }
174
- return left;
175
-
202
+ let left = node.left;
203
+
204
+ while (
205
+ left.type === "LogicalExpression" &&
206
+ left.operator === node.operator
207
+ ) {
208
+ if (astUtils.isParenthesised(sourceCode, left)) {
209
+ /*
210
+ * It should have associativity,
211
+ * but ignore it if use parentheses to make the evaluation order clear.
212
+ */
213
+ return left;
214
+ }
215
+ left = left.left;
216
+ }
217
+ return left;
176
218
  }
177
219
 
178
220
  //------------------------------------------------------------------------------
179
221
  // Rule Definition
180
222
  //------------------------------------------------------------------------------
181
- /** @type {import('../shared/types').Rule} */
223
+ /** @type {import('../types').Rule.RuleModule} */
182
224
  module.exports = {
183
- meta: {
184
- type: "suggestion",
185
-
186
- docs: {
187
- description: "Require or disallow logical assignment operator shorthand",
188
- recommended: false,
189
- url: "https://eslint.org/docs/latest/rules/logical-assignment-operators"
190
- },
191
-
192
- schema: {
193
- type: "array",
194
- oneOf: [{
195
- items: [
196
- { const: "always" },
197
- {
198
- type: "object",
199
- properties: {
200
- enforceForIfStatements: {
201
- type: "boolean"
202
- }
203
- },
204
- additionalProperties: false
205
- }
206
- ],
207
- minItems: 0, // 0 for allowing passing no options
208
- maxItems: 2
209
- }, {
210
- items: [{ const: "never" }],
211
- minItems: 1,
212
- maxItems: 1
213
- }]
214
- },
215
- fixable: "code",
216
- hasSuggestions: true,
217
- messages: {
218
- assignment: "Assignment (=) can be replaced with operator assignment ({{operator}}).",
219
- useLogicalOperator: "Convert this assignment to use the operator {{ operator }}.",
220
- logical: "Logical expression can be replaced with an assignment ({{ operator }}).",
221
- convertLogical: "Replace this logical expression with an assignment with the operator {{ operator }}.",
222
- if: "'if' statement can be replaced with a logical operator assignment with operator {{ operator }}.",
223
- convertIf: "Replace this 'if' statement with a logical assignment with operator {{ operator }}.",
224
- unexpected: "Unexpected logical operator assignment ({{operator}}) shorthand.",
225
- separate: "Separate the logical assignment into an assignment with a logical operator."
226
- }
227
- },
228
-
229
- create(context) {
230
- const mode = context.options[0] === "never" ? "never" : "always";
231
- const checkIf = mode === "always" && context.options.length > 1 && context.options[1].enforceForIfStatements;
232
- const sourceCode = context.sourceCode;
233
- const isStrict = sourceCode.getScope(sourceCode.ast).isStrict;
234
-
235
- /**
236
- * Returns false if the access could be a getter
237
- * @param {ASTNode} node Assignment expression
238
- * @returns {boolean} True iff the fix is safe
239
- */
240
- function cannotBeGetter(node) {
241
- return node.type === "Identifier" &&
242
- (isStrict || !isInsideWithBlock(node));
243
- }
244
-
245
- /**
246
- * Check whether only a single property is accessed
247
- * @param {ASTNode} node reference
248
- * @returns {boolean} True iff a single property is accessed
249
- */
250
- function accessesSingleProperty(node) {
251
- if (!isStrict && isInsideWithBlock(node)) {
252
- return node.type === "Identifier";
253
- }
254
-
255
- return node.type === "MemberExpression" &&
256
- baseTypes.has(node.object.type) &&
257
- (!node.computed || (node.property.type !== "MemberExpression" && node.property.type !== "ChainExpression"));
258
- }
259
-
260
- /**
261
- * Adds a fixer or suggestion whether on the fix is safe.
262
- * @param {{ messageId: string, node: ASTNode }} descriptor Report descriptor without fix or suggest
263
- * @param {{ messageId: string, fix: Function }} suggestion Adds the fix or the whole suggestion as only element in "suggest" to suggestion
264
- * @param {boolean} shouldBeFixed Fix iff the condition is true
265
- * @returns {Object} Descriptor with either an added fix or suggestion
266
- */
267
- function createConditionalFixer(descriptor, suggestion, shouldBeFixed) {
268
- if (shouldBeFixed) {
269
- return {
270
- ...descriptor,
271
- fix: suggestion.fix
272
- };
273
- }
274
-
275
- return {
276
- ...descriptor,
277
- suggest: [suggestion]
278
- };
279
- }
280
-
281
-
282
- /**
283
- * Returns the operator token for assignments and binary expressions
284
- * @param {ASTNode} node AssignmentExpression or BinaryExpression
285
- * @returns {import('eslint').AST.Token} Operator token between the left and right expression
286
- */
287
- function getOperatorToken(node) {
288
- return sourceCode.getFirstTokenBetween(node.left, node.right, token => token.value === node.operator);
289
- }
290
-
291
- if (mode === "never") {
292
- return {
293
-
294
- // foo ||= bar
295
- "AssignmentExpression"(assignment) {
296
- if (!astUtils.isLogicalAssignmentOperator(assignment.operator)) {
297
- return;
298
- }
299
-
300
- const descriptor = {
301
- messageId: "unexpected",
302
- node: assignment,
303
- data: { operator: assignment.operator }
304
- };
305
- const suggestion = {
306
- messageId: "separate",
307
- *fix(ruleFixer) {
308
- if (sourceCode.getCommentsInside(assignment).length > 0) {
309
- return;
310
- }
311
-
312
- const operatorToken = getOperatorToken(assignment);
313
-
314
- // -> foo = bar
315
- yield ruleFixer.replaceText(operatorToken, "=");
316
-
317
- const assignmentText = sourceCode.getText(assignment.left);
318
- const operator = assignment.operator.slice(0, -1);
319
-
320
- // -> foo = foo || bar
321
- yield ruleFixer.insertTextAfter(operatorToken, ` ${assignmentText} ${operator}`);
322
-
323
- const precedence = astUtils.getPrecedence(assignment.right) <= astUtils.getPrecedence({ type: "LogicalExpression", operator });
324
-
325
- // ?? and || / && cannot be mixed but have same precedence
326
- const mixed = assignment.operator === "??=" && astUtils.isLogicalExpression(assignment.right);
327
-
328
- if (!astUtils.isParenthesised(sourceCode, assignment.right) && (precedence || mixed)) {
329
-
330
- // -> foo = foo || (bar)
331
- yield ruleFixer.insertTextBefore(assignment.right, "(");
332
- yield ruleFixer.insertTextAfter(assignment.right, ")");
333
- }
334
- }
335
- };
336
-
337
- context.report(createConditionalFixer(descriptor, suggestion, cannotBeGetter(assignment.left)));
338
- }
339
- };
340
- }
341
-
342
- return {
343
-
344
- // foo = foo || bar
345
- "AssignmentExpression[operator='='][right.type='LogicalExpression']"(assignment) {
346
- const leftOperand = getLeftmostOperand(sourceCode, assignment.right);
347
-
348
- if (!astUtils.isSameReference(assignment.left, leftOperand)
349
- ) {
350
- return;
351
- }
352
-
353
- const descriptor = {
354
- messageId: "assignment",
355
- node: assignment,
356
- data: { operator: `${assignment.right.operator}=` }
357
- };
358
- const suggestion = {
359
- messageId: "useLogicalOperator",
360
- data: { operator: `${assignment.right.operator}=` },
361
- *fix(ruleFixer) {
362
- if (sourceCode.getCommentsInside(assignment).length > 0) {
363
- return;
364
- }
365
-
366
- // No need for parenthesis around the assignment based on precedence as the precedence stays the same even with changed operator
367
- const assignmentOperatorToken = getOperatorToken(assignment);
368
-
369
- // -> foo ||= foo || bar
370
- yield ruleFixer.insertTextBefore(assignmentOperatorToken, assignment.right.operator);
371
-
372
- // -> foo ||= bar
373
- const logicalOperatorToken = getOperatorToken(leftOperand.parent);
374
- const firstRightOperandToken = sourceCode.getTokenAfter(logicalOperatorToken);
375
-
376
- yield ruleFixer.removeRange([leftOperand.parent.range[0], firstRightOperandToken.range[0]]);
377
- }
378
- };
379
-
380
- context.report(createConditionalFixer(descriptor, suggestion, cannotBeGetter(assignment.left)));
381
- },
382
-
383
- // foo || (foo = bar)
384
- 'LogicalExpression[right.type="AssignmentExpression"][right.operator="="]'(logical) {
385
-
386
- // Right side has to be parenthesized, otherwise would be parsed as (foo || foo) = bar which is illegal
387
- if (isReference(logical.left) && astUtils.isSameReference(logical.left, logical.right.left)) {
388
- const descriptor = {
389
- messageId: "logical",
390
- node: logical,
391
- data: { operator: `${logical.operator}=` }
392
- };
393
- const suggestion = {
394
- messageId: "convertLogical",
395
- data: { operator: `${logical.operator}=` },
396
- *fix(ruleFixer) {
397
- if (sourceCode.getCommentsInside(logical).length > 0) {
398
- return;
399
- }
400
-
401
- const parentPrecedence = astUtils.getPrecedence(logical.parent);
402
- const requiresOuterParenthesis = logical.parent.type !== "ExpressionStatement" && (
403
- parentPrecedence === -1 ||
404
- astUtils.getPrecedence({ type: "AssignmentExpression" }) < parentPrecedence
405
- );
406
-
407
- if (!astUtils.isParenthesised(sourceCode, logical) && requiresOuterParenthesis) {
408
- yield ruleFixer.insertTextBefore(logical, "(");
409
- yield ruleFixer.insertTextAfter(logical, ")");
410
- }
411
-
412
- // Also removes all opening parenthesis
413
- yield ruleFixer.removeRange([logical.range[0], logical.right.range[0]]); // -> foo = bar)
414
-
415
- // Also removes all ending parenthesis
416
- yield ruleFixer.removeRange([logical.right.range[1], logical.range[1]]); // -> foo = bar
417
-
418
- const operatorToken = getOperatorToken(logical.right);
419
-
420
- yield ruleFixer.insertTextBefore(operatorToken, logical.operator); // -> foo ||= bar
421
- }
422
- };
423
- const fix = cannotBeGetter(logical.left) || accessesSingleProperty(logical.left);
424
-
425
- context.report(createConditionalFixer(descriptor, suggestion, fix));
426
- }
427
- },
428
-
429
- // if (foo) foo = bar
430
- "IfStatement[alternate=null]"(ifNode) {
431
- if (!checkIf) {
432
- return;
433
- }
434
-
435
- const hasBody = ifNode.consequent.type === "BlockStatement";
436
-
437
- if (hasBody && ifNode.consequent.body.length !== 1) {
438
- return;
439
- }
440
-
441
- const body = hasBody ? ifNode.consequent.body[0] : ifNode.consequent;
442
- const scope = sourceCode.getScope(ifNode);
443
- const existence = getExistence(ifNode.test, scope);
444
-
445
- if (
446
- body.type === "ExpressionStatement" &&
447
- body.expression.type === "AssignmentExpression" &&
448
- body.expression.operator === "=" &&
449
- existence !== null &&
450
- astUtils.isSameReference(existence.reference, body.expression.left)
451
- ) {
452
- const descriptor = {
453
- messageId: "if",
454
- node: ifNode,
455
- data: { operator: `${existence.operator}=` }
456
- };
457
- const suggestion = {
458
- messageId: "convertIf",
459
- data: { operator: `${existence.operator}=` },
460
- *fix(ruleFixer) {
461
- if (sourceCode.getCommentsInside(ifNode).length > 0) {
462
- return;
463
- }
464
-
465
- const firstBodyToken = sourceCode.getFirstToken(body);
466
- const prevToken = sourceCode.getTokenBefore(ifNode);
467
-
468
- if (
469
- prevToken !== null &&
470
- prevToken.value !== ";" &&
471
- prevToken.value !== "{" &&
472
- firstBodyToken.type !== "Identifier" &&
473
- firstBodyToken.type !== "Keyword"
474
- ) {
475
-
476
- // Do not fix if the fixed statement could be part of the previous statement (eg. fn() if (a == null) (a) = b --> fn()(a) ??= b)
477
- return;
478
- }
479
-
480
-
481
- const operatorToken = getOperatorToken(body.expression);
482
-
483
- yield ruleFixer.insertTextBefore(operatorToken, existence.operator); // -> if (foo) foo ||= bar
484
-
485
- yield ruleFixer.removeRange([ifNode.range[0], body.range[0]]); // -> foo ||= bar
486
-
487
- yield ruleFixer.removeRange([body.range[1], ifNode.range[1]]); // -> foo ||= bar, only present if "if" had a body
488
-
489
- const nextToken = sourceCode.getTokenAfter(body.expression);
490
-
491
- if (hasBody && (nextToken !== null && nextToken.value !== ";")) {
492
- yield ruleFixer.insertTextAfter(ifNode, ";");
493
- }
494
- }
495
- };
496
- const shouldBeFixed = cannotBeGetter(existence.reference) ||
497
- (ifNode.test.type !== "LogicalExpression" && accessesSingleProperty(existence.reference));
498
-
499
- context.report(createConditionalFixer(descriptor, suggestion, shouldBeFixed));
500
- }
501
- }
502
- };
503
- }
225
+ meta: {
226
+ type: "suggestion",
227
+
228
+ docs: {
229
+ description:
230
+ "Require or disallow logical assignment operator shorthand",
231
+ recommended: false,
232
+ frozen: true,
233
+ url: "https://eslint.org/docs/latest/rules/logical-assignment-operators",
234
+ },
235
+
236
+ schema: {
237
+ type: "array",
238
+ oneOf: [
239
+ {
240
+ items: [
241
+ { const: "always" },
242
+ {
243
+ type: "object",
244
+ properties: {
245
+ enforceForIfStatements: {
246
+ type: "boolean",
247
+ },
248
+ },
249
+ additionalProperties: false,
250
+ },
251
+ ],
252
+ minItems: 0, // 0 for allowing passing no options
253
+ maxItems: 2,
254
+ },
255
+ {
256
+ items: [{ const: "never" }],
257
+ minItems: 1,
258
+ maxItems: 1,
259
+ },
260
+ ],
261
+ },
262
+ fixable: "code",
263
+ hasSuggestions: true,
264
+ messages: {
265
+ assignment:
266
+ "Assignment (=) can be replaced with operator assignment ({{operator}}).",
267
+ useLogicalOperator:
268
+ "Convert this assignment to use the operator {{ operator }}.",
269
+ logical:
270
+ "Logical expression can be replaced with an assignment ({{ operator }}).",
271
+ convertLogical:
272
+ "Replace this logical expression with an assignment with the operator {{ operator }}.",
273
+ if: "'if' statement can be replaced with a logical operator assignment with operator {{ operator }}.",
274
+ convertIf:
275
+ "Replace this 'if' statement with a logical assignment with operator {{ operator }}.",
276
+ unexpected:
277
+ "Unexpected logical operator assignment ({{operator}}) shorthand.",
278
+ separate:
279
+ "Separate the logical assignment into an assignment with a logical operator.",
280
+ },
281
+ },
282
+
283
+ create(context) {
284
+ const mode = context.options[0] === "never" ? "never" : "always";
285
+ const checkIf =
286
+ mode === "always" &&
287
+ context.options.length > 1 &&
288
+ context.options[1].enforceForIfStatements;
289
+ const sourceCode = context.sourceCode;
290
+ const isStrict = sourceCode.getScope(sourceCode.ast).isStrict;
291
+
292
+ /**
293
+ * Returns false if the access could be a getter
294
+ * @param {ASTNode} node Assignment expression
295
+ * @returns {boolean} True iff the fix is safe
296
+ */
297
+ function cannotBeGetter(node) {
298
+ return (
299
+ node.type === "Identifier" &&
300
+ (isStrict || !isInsideWithBlock(node))
301
+ );
302
+ }
303
+
304
+ /**
305
+ * Check whether only a single property is accessed
306
+ * @param {ASTNode} node reference
307
+ * @returns {boolean} True iff a single property is accessed
308
+ */
309
+ function accessesSingleProperty(node) {
310
+ if (!isStrict && isInsideWithBlock(node)) {
311
+ return node.type === "Identifier";
312
+ }
313
+
314
+ return (
315
+ node.type === "MemberExpression" &&
316
+ baseTypes.has(node.object.type) &&
317
+ (!node.computed ||
318
+ (node.property.type !== "MemberExpression" &&
319
+ node.property.type !== "ChainExpression"))
320
+ );
321
+ }
322
+
323
+ /**
324
+ * Adds a fixer or suggestion whether on the fix is safe.
325
+ * @param {{ messageId: string, node: ASTNode }} descriptor Report descriptor without fix or suggest
326
+ * @param {{ messageId: string, fix: Function }} suggestion Adds the fix or the whole suggestion as only element in "suggest" to suggestion
327
+ * @param {boolean} shouldBeFixed Fix iff the condition is true
328
+ * @returns {Object} Descriptor with either an added fix or suggestion
329
+ */
330
+ function createConditionalFixer(descriptor, suggestion, shouldBeFixed) {
331
+ if (shouldBeFixed) {
332
+ return {
333
+ ...descriptor,
334
+ fix: suggestion.fix,
335
+ };
336
+ }
337
+
338
+ return {
339
+ ...descriptor,
340
+ suggest: [suggestion],
341
+ };
342
+ }
343
+
344
+ /**
345
+ * Returns the operator token for assignments and binary expressions
346
+ * @param {ASTNode} node AssignmentExpression or BinaryExpression
347
+ * @returns {import('eslint').AST.Token} Operator token between the left and right expression
348
+ */
349
+ function getOperatorToken(node) {
350
+ return sourceCode.getFirstTokenBetween(
351
+ node.left,
352
+ node.right,
353
+ token => token.value === node.operator,
354
+ );
355
+ }
356
+
357
+ if (mode === "never") {
358
+ return {
359
+ // foo ||= bar
360
+ AssignmentExpression(assignment) {
361
+ if (
362
+ !astUtils.isLogicalAssignmentOperator(
363
+ assignment.operator,
364
+ )
365
+ ) {
366
+ return;
367
+ }
368
+
369
+ const descriptor = {
370
+ messageId: "unexpected",
371
+ node: assignment,
372
+ data: { operator: assignment.operator },
373
+ };
374
+ const suggestion = {
375
+ messageId: "separate",
376
+ *fix(ruleFixer) {
377
+ if (
378
+ sourceCode.getCommentsInside(assignment)
379
+ .length > 0
380
+ ) {
381
+ return;
382
+ }
383
+
384
+ const operatorToken = getOperatorToken(assignment);
385
+
386
+ // -> foo = bar
387
+ yield ruleFixer.replaceText(operatorToken, "=");
388
+
389
+ const assignmentText = sourceCode.getText(
390
+ assignment.left,
391
+ );
392
+ const operator = assignment.operator.slice(0, -1);
393
+
394
+ // -> foo = foo || bar
395
+ yield ruleFixer.insertTextAfter(
396
+ operatorToken,
397
+ ` ${assignmentText} ${operator}`,
398
+ );
399
+
400
+ const precedence =
401
+ astUtils.getPrecedence(assignment.right) <=
402
+ astUtils.getPrecedence({
403
+ type: "LogicalExpression",
404
+ operator,
405
+ });
406
+
407
+ // ?? and || / && cannot be mixed but have same precedence
408
+ const mixed =
409
+ assignment.operator === "??=" &&
410
+ astUtils.isLogicalExpression(assignment.right);
411
+
412
+ if (
413
+ !astUtils.isParenthesised(
414
+ sourceCode,
415
+ assignment.right,
416
+ ) &&
417
+ (precedence || mixed)
418
+ ) {
419
+ // -> foo = foo || (bar)
420
+ yield ruleFixer.insertTextBefore(
421
+ assignment.right,
422
+ "(",
423
+ );
424
+ yield ruleFixer.insertTextAfter(
425
+ assignment.right,
426
+ ")",
427
+ );
428
+ }
429
+ },
430
+ };
431
+
432
+ context.report(
433
+ createConditionalFixer(
434
+ descriptor,
435
+ suggestion,
436
+ cannotBeGetter(assignment.left),
437
+ ),
438
+ );
439
+ },
440
+ };
441
+ }
442
+
443
+ return {
444
+ // foo = foo || bar
445
+ "AssignmentExpression[operator='='][right.type='LogicalExpression']"(
446
+ assignment,
447
+ ) {
448
+ const leftOperand = getLeftmostOperand(
449
+ sourceCode,
450
+ assignment.right,
451
+ );
452
+
453
+ if (!astUtils.isSameReference(assignment.left, leftOperand)) {
454
+ return;
455
+ }
456
+
457
+ const descriptor = {
458
+ messageId: "assignment",
459
+ node: assignment,
460
+ data: { operator: `${assignment.right.operator}=` },
461
+ };
462
+ const suggestion = {
463
+ messageId: "useLogicalOperator",
464
+ data: { operator: `${assignment.right.operator}=` },
465
+ *fix(ruleFixer) {
466
+ if (
467
+ sourceCode.getCommentsInside(assignment).length > 0
468
+ ) {
469
+ return;
470
+ }
471
+
472
+ // No need for parenthesis around the assignment based on precedence as the precedence stays the same even with changed operator
473
+ const assignmentOperatorToken =
474
+ getOperatorToken(assignment);
475
+
476
+ // -> foo ||= foo || bar
477
+ yield ruleFixer.insertTextBefore(
478
+ assignmentOperatorToken,
479
+ assignment.right.operator,
480
+ );
481
+
482
+ // -> foo ||= bar
483
+ const logicalOperatorToken = getOperatorToken(
484
+ leftOperand.parent,
485
+ );
486
+ const firstRightOperandToken =
487
+ sourceCode.getTokenAfter(logicalOperatorToken);
488
+
489
+ yield ruleFixer.removeRange([
490
+ leftOperand.parent.range[0],
491
+ firstRightOperandToken.range[0],
492
+ ]);
493
+ },
494
+ };
495
+
496
+ context.report(
497
+ createConditionalFixer(
498
+ descriptor,
499
+ suggestion,
500
+ cannotBeGetter(assignment.left),
501
+ ),
502
+ );
503
+ },
504
+
505
+ // foo || (foo = bar)
506
+ 'LogicalExpression[right.type="AssignmentExpression"][right.operator="="]'(
507
+ logical,
508
+ ) {
509
+ // Right side has to be parenthesized, otherwise would be parsed as (foo || foo) = bar which is illegal
510
+ if (
511
+ isReference(logical.left) &&
512
+ astUtils.isSameReference(logical.left, logical.right.left)
513
+ ) {
514
+ const descriptor = {
515
+ messageId: "logical",
516
+ node: logical,
517
+ data: { operator: `${logical.operator}=` },
518
+ };
519
+ const suggestion = {
520
+ messageId: "convertLogical",
521
+ data: { operator: `${logical.operator}=` },
522
+ *fix(ruleFixer) {
523
+ if (
524
+ sourceCode.getCommentsInside(logical).length > 0
525
+ ) {
526
+ return;
527
+ }
528
+
529
+ const parentPrecedence = astUtils.getPrecedence(
530
+ logical.parent,
531
+ );
532
+ const requiresOuterParenthesis =
533
+ logical.parent.type !== "ExpressionStatement" &&
534
+ (parentPrecedence === -1 ||
535
+ astUtils.getPrecedence({
536
+ type: "AssignmentExpression",
537
+ }) < parentPrecedence);
538
+
539
+ if (
540
+ !astUtils.isParenthesised(
541
+ sourceCode,
542
+ logical,
543
+ ) &&
544
+ requiresOuterParenthesis
545
+ ) {
546
+ yield ruleFixer.insertTextBefore(logical, "(");
547
+ yield ruleFixer.insertTextAfter(logical, ")");
548
+ }
549
+
550
+ // Also removes all opening parenthesis
551
+ yield ruleFixer.removeRange([
552
+ logical.range[0],
553
+ logical.right.range[0],
554
+ ]); // -> foo = bar)
555
+
556
+ // Also removes all ending parenthesis
557
+ yield ruleFixer.removeRange([
558
+ logical.right.range[1],
559
+ logical.range[1],
560
+ ]); // -> foo = bar
561
+
562
+ const operatorToken = getOperatorToken(
563
+ logical.right,
564
+ );
565
+
566
+ yield ruleFixer.insertTextBefore(
567
+ operatorToken,
568
+ logical.operator,
569
+ ); // -> foo ||= bar
570
+ },
571
+ };
572
+ const fix =
573
+ cannotBeGetter(logical.left) ||
574
+ accessesSingleProperty(logical.left);
575
+
576
+ context.report(
577
+ createConditionalFixer(descriptor, suggestion, fix),
578
+ );
579
+ }
580
+ },
581
+
582
+ // if (foo) foo = bar
583
+ "IfStatement[alternate=null]"(ifNode) {
584
+ if (!checkIf) {
585
+ return;
586
+ }
587
+
588
+ const hasBody = ifNode.consequent.type === "BlockStatement";
589
+
590
+ if (hasBody && ifNode.consequent.body.length !== 1) {
591
+ return;
592
+ }
593
+
594
+ const body = hasBody
595
+ ? ifNode.consequent.body[0]
596
+ : ifNode.consequent;
597
+ const scope = sourceCode.getScope(ifNode);
598
+ const existence = getExistence(ifNode.test, scope);
599
+
600
+ if (
601
+ body.type === "ExpressionStatement" &&
602
+ body.expression.type === "AssignmentExpression" &&
603
+ body.expression.operator === "=" &&
604
+ existence !== null &&
605
+ astUtils.isSameReference(
606
+ existence.reference,
607
+ body.expression.left,
608
+ )
609
+ ) {
610
+ const descriptor = {
611
+ messageId: "if",
612
+ node: ifNode,
613
+ data: { operator: `${existence.operator}=` },
614
+ };
615
+ const suggestion = {
616
+ messageId: "convertIf",
617
+ data: { operator: `${existence.operator}=` },
618
+ *fix(ruleFixer) {
619
+ if (
620
+ sourceCode.getCommentsInside(ifNode).length > 0
621
+ ) {
622
+ return;
623
+ }
624
+
625
+ const firstBodyToken =
626
+ sourceCode.getFirstToken(body);
627
+ const prevToken = sourceCode.getTokenBefore(ifNode);
628
+
629
+ if (
630
+ prevToken !== null &&
631
+ prevToken.value !== ";" &&
632
+ prevToken.value !== "{" &&
633
+ firstBodyToken.type !== "Identifier" &&
634
+ firstBodyToken.type !== "Keyword"
635
+ ) {
636
+ // Do not fix if the fixed statement could be part of the previous statement (eg. fn() if (a == null) (a) = b --> fn()(a) ??= b)
637
+ return;
638
+ }
639
+
640
+ const operatorToken = getOperatorToken(
641
+ body.expression,
642
+ );
643
+
644
+ yield ruleFixer.insertTextBefore(
645
+ operatorToken,
646
+ existence.operator,
647
+ ); // -> if (foo) foo ||= bar
648
+
649
+ yield ruleFixer.removeRange([
650
+ ifNode.range[0],
651
+ body.range[0],
652
+ ]); // -> foo ||= bar
653
+
654
+ yield ruleFixer.removeRange([
655
+ body.range[1],
656
+ ifNode.range[1],
657
+ ]); // -> foo ||= bar, only present if "if" had a body
658
+
659
+ const nextToken = sourceCode.getTokenAfter(
660
+ body.expression,
661
+ );
662
+
663
+ if (
664
+ hasBody &&
665
+ nextToken !== null &&
666
+ nextToken.value !== ";"
667
+ ) {
668
+ yield ruleFixer.insertTextAfter(ifNode, ";");
669
+ }
670
+ },
671
+ };
672
+ const shouldBeFixed =
673
+ cannotBeGetter(existence.reference) ||
674
+ (ifNode.test.type !== "LogicalExpression" &&
675
+ accessesSingleProperty(existence.reference));
676
+
677
+ context.report(
678
+ createConditionalFixer(
679
+ descriptor,
680
+ suggestion,
681
+ shouldBeFixed,
682
+ ),
683
+ );
684
+ }
685
+ },
686
+ };
687
+ },
504
688
  };