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
@@ -14,473 +14,412 @@ const astUtils = require("./utils/ast-utils");
14
14
  // Rule Definition
15
15
  //------------------------------------------------------------------------------
16
16
 
17
- /** @type {import('../shared/types').Rule} */
17
+ /** @type {import('../types').Rule.RuleModule} */
18
18
  module.exports = {
19
- meta: {
20
- type: "suggestion",
21
-
22
- docs: {
23
- description: "Enforce consistent brace style for all control statements",
24
- recommended: false,
25
- url: "https://eslint.org/docs/latest/rules/curly"
26
- },
27
-
28
- schema: {
29
- anyOf: [
30
- {
31
- type: "array",
32
- items: [
33
- {
34
- enum: ["all"]
35
- }
36
- ],
37
- minItems: 0,
38
- maxItems: 1
39
- },
40
- {
41
- type: "array",
42
- items: [
43
- {
44
- enum: ["multi", "multi-line", "multi-or-nest"]
45
- },
46
- {
47
- enum: ["consistent"]
48
- }
49
- ],
50
- minItems: 0,
51
- maxItems: 2
52
- }
53
- ]
54
- },
55
-
56
- fixable: "code",
57
-
58
- messages: {
59
- missingCurlyAfter: "Expected { after '{{name}}'.",
60
- missingCurlyAfterCondition: "Expected { after '{{name}}' condition.",
61
- unexpectedCurlyAfter: "Unnecessary { after '{{name}}'.",
62
- unexpectedCurlyAfterCondition: "Unnecessary { after '{{name}}' condition."
63
- }
64
- },
65
-
66
- create(context) {
67
-
68
- const multiOnly = (context.options[0] === "multi");
69
- const multiLine = (context.options[0] === "multi-line");
70
- const multiOrNest = (context.options[0] === "multi-or-nest");
71
- const consistent = (context.options[1] === "consistent");
72
-
73
- const sourceCode = context.sourceCode;
74
-
75
- //--------------------------------------------------------------------------
76
- // Helpers
77
- //--------------------------------------------------------------------------
78
-
79
- /**
80
- * Determines if a given node is a one-liner that's on the same line as it's preceding code.
81
- * @param {ASTNode} node The node to check.
82
- * @returns {boolean} True if the node is a one-liner that's on the same line as it's preceding code.
83
- * @private
84
- */
85
- function isCollapsedOneLiner(node) {
86
- const before = sourceCode.getTokenBefore(node);
87
- const last = sourceCode.getLastToken(node);
88
- const lastExcludingSemicolon = astUtils.isSemicolonToken(last) ? sourceCode.getTokenBefore(last) : last;
89
-
90
- return before.loc.start.line === lastExcludingSemicolon.loc.end.line;
91
- }
92
-
93
- /**
94
- * Determines if a given node is a one-liner.
95
- * @param {ASTNode} node The node to check.
96
- * @returns {boolean} True if the node is a one-liner.
97
- * @private
98
- */
99
- function isOneLiner(node) {
100
- if (node.type === "EmptyStatement") {
101
- return true;
102
- }
103
-
104
- const first = sourceCode.getFirstToken(node);
105
- const last = sourceCode.getLastToken(node);
106
- const lastExcludingSemicolon = astUtils.isSemicolonToken(last) ? sourceCode.getTokenBefore(last) : last;
107
-
108
- return first.loc.start.line === lastExcludingSemicolon.loc.end.line;
109
- }
110
-
111
- /**
112
- * Determines if the given node is a lexical declaration (let, const, function, or class)
113
- * @param {ASTNode} node The node to check
114
- * @returns {boolean} True if the node is a lexical declaration
115
- * @private
116
- */
117
- function isLexicalDeclaration(node) {
118
- if (node.type === "VariableDeclaration") {
119
- return node.kind === "const" || node.kind === "let";
120
- }
121
-
122
- return node.type === "FunctionDeclaration" || node.type === "ClassDeclaration";
123
- }
124
-
125
- /**
126
- * Checks if the given token is an `else` token or not.
127
- * @param {Token} token The token to check.
128
- * @returns {boolean} `true` if the token is an `else` token.
129
- */
130
- function isElseKeywordToken(token) {
131
- return token.value === "else" && token.type === "Keyword";
132
- }
133
-
134
- /**
135
- * Determines whether the given node has an `else` keyword token as the first token after.
136
- * @param {ASTNode} node The node to check.
137
- * @returns {boolean} `true` if the node is followed by an `else` keyword token.
138
- */
139
- function isFollowedByElseKeyword(node) {
140
- const nextToken = sourceCode.getTokenAfter(node);
141
-
142
- return Boolean(nextToken) && isElseKeywordToken(nextToken);
143
- }
144
-
145
- /**
146
- * Determines if a semicolon needs to be inserted after removing a set of curly brackets, in order to avoid a SyntaxError.
147
- * @param {Token} closingBracket The } token
148
- * @returns {boolean} `true` if a semicolon needs to be inserted after the last statement in the block.
149
- */
150
- function needsSemicolon(closingBracket) {
151
- const tokenBefore = sourceCode.getTokenBefore(closingBracket);
152
- const tokenAfter = sourceCode.getTokenAfter(closingBracket);
153
- const lastBlockNode = sourceCode.getNodeByRangeIndex(tokenBefore.range[0]);
154
-
155
- if (astUtils.isSemicolonToken(tokenBefore)) {
156
-
157
- // If the last statement already has a semicolon, don't add another one.
158
- return false;
159
- }
160
-
161
- if (!tokenAfter) {
162
-
163
- // If there are no statements after this block, there is no need to add a semicolon.
164
- return false;
165
- }
166
-
167
- if (lastBlockNode.type === "BlockStatement" && lastBlockNode.parent.type !== "FunctionExpression" && lastBlockNode.parent.type !== "ArrowFunctionExpression") {
168
-
169
- /*
170
- * If the last node surrounded by curly brackets is a BlockStatement (other than a FunctionExpression or an ArrowFunctionExpression),
171
- * don't insert a semicolon. Otherwise, the semicolon would be parsed as a separate statement, which would cause
172
- * a SyntaxError if it was followed by `else`.
173
- */
174
- return false;
175
- }
176
-
177
- if (tokenBefore.loc.end.line === tokenAfter.loc.start.line) {
178
-
179
- // If the next token is on the same line, insert a semicolon.
180
- return true;
181
- }
182
-
183
- if (/^[([/`+-]/u.test(tokenAfter.value)) {
184
-
185
- // If the next token starts with a character that would disrupt ASI, insert a semicolon.
186
- return true;
187
- }
188
-
189
- if (tokenBefore.type === "Punctuator" && (tokenBefore.value === "++" || tokenBefore.value === "--")) {
190
-
191
- // If the last token is ++ or --, insert a semicolon to avoid disrupting ASI.
192
- return true;
193
- }
194
-
195
- // Otherwise, do not insert a semicolon.
196
- return false;
197
- }
198
-
199
- /**
200
- * Determines whether the code represented by the given node contains an `if` statement
201
- * that would become associated with an `else` keyword directly appended to that code.
202
- *
203
- * Examples where it returns `true`:
204
- *
205
- * if (a)
206
- * foo();
207
- *
208
- * if (a) {
209
- * foo();
210
- * }
211
- *
212
- * if (a)
213
- * foo();
214
- * else if (b)
215
- * bar();
216
- *
217
- * while (a)
218
- * if (b)
219
- * if(c)
220
- * foo();
221
- * else
222
- * bar();
223
- *
224
- * Examples where it returns `false`:
225
- *
226
- * if (a)
227
- * foo();
228
- * else
229
- * bar();
230
- *
231
- * while (a) {
232
- * if (b)
233
- * if(c)
234
- * foo();
235
- * else
236
- * bar();
237
- * }
238
- *
239
- * while (a)
240
- * if (b) {
241
- * if(c)
242
- * foo();
243
- * }
244
- * else
245
- * bar();
246
- * @param {ASTNode} node Node representing the code to check.
247
- * @returns {boolean} `true` if an `if` statement within the code would become associated with an `else` appended to that code.
248
- */
249
- function hasUnsafeIf(node) {
250
- switch (node.type) {
251
- case "IfStatement":
252
- if (!node.alternate) {
253
- return true;
254
- }
255
- return hasUnsafeIf(node.alternate);
256
- case "ForStatement":
257
- case "ForInStatement":
258
- case "ForOfStatement":
259
- case "LabeledStatement":
260
- case "WithStatement":
261
- case "WhileStatement":
262
- return hasUnsafeIf(node.body);
263
- default:
264
- return false;
265
- }
266
- }
267
-
268
- /**
269
- * Determines whether the existing curly braces around the single statement are necessary to preserve the semantics of the code.
270
- * The braces, which make the given block body, are necessary in either of the following situations:
271
- *
272
- * 1. The statement is a lexical declaration.
273
- * 2. Without the braces, an `if` within the statement would become associated with an `else` after the closing brace:
274
- *
275
- * if (a) {
276
- * if (b)
277
- * foo();
278
- * }
279
- * else
280
- * bar();
281
- *
282
- * if (a)
283
- * while (b)
284
- * while (c) {
285
- * while (d)
286
- * if (e)
287
- * while(f)
288
- * foo();
289
- * }
290
- * else
291
- * bar();
292
- * @param {ASTNode} node `BlockStatement` body with exactly one statement directly inside. The statement can have its own nested statements.
293
- * @returns {boolean} `true` if the braces are necessary - removing them (replacing the given `BlockStatement` body with its single statement content)
294
- * would change the semantics of the code or produce a syntax error.
295
- */
296
- function areBracesNecessary(node) {
297
- const statement = node.body[0];
298
-
299
- return isLexicalDeclaration(statement) ||
300
- hasUnsafeIf(statement) && isFollowedByElseKeyword(node);
301
- }
302
-
303
- /**
304
- * Prepares to check the body of a node to see if it's a block statement.
305
- * @param {ASTNode} node The node to report if there's a problem.
306
- * @param {ASTNode} body The body node to check for blocks.
307
- * @param {string} name The name to report if there's a problem.
308
- * @param {{ condition: boolean }} opts Options to pass to the report functions
309
- * @returns {Object} a prepared check object, with "actual", "expected", "check" properties.
310
- * "actual" will be `true` or `false` whether the body is already a block statement.
311
- * "expected" will be `true` or `false` if the body should be a block statement or not, or
312
- * `null` if it doesn't matter, depending on the rule options. It can be modified to change
313
- * the final behavior of "check".
314
- * "check" will be a function reporting appropriate problems depending on the other
315
- * properties.
316
- */
317
- function prepareCheck(node, body, name, opts) {
318
- const hasBlock = (body.type === "BlockStatement");
319
- let expected = null;
320
-
321
- if (hasBlock && (body.body.length !== 1 || areBracesNecessary(body))) {
322
- expected = true;
323
- } else if (multiOnly) {
324
- expected = false;
325
- } else if (multiLine) {
326
- if (!isCollapsedOneLiner(body)) {
327
- expected = true;
328
- }
329
-
330
- // otherwise, the body is allowed to have braces or not to have braces
331
-
332
- } else if (multiOrNest) {
333
- if (hasBlock) {
334
- const statement = body.body[0];
335
- const leadingCommentsInBlock = sourceCode.getCommentsBefore(statement);
336
-
337
- expected = !isOneLiner(statement) || leadingCommentsInBlock.length > 0;
338
- } else {
339
- expected = !isOneLiner(body);
340
- }
341
- } else {
342
-
343
- // default "all"
344
- expected = true;
345
- }
346
-
347
- return {
348
- actual: hasBlock,
349
- expected,
350
- check() {
351
- if (this.expected !== null && this.expected !== this.actual) {
352
- if (this.expected) {
353
- context.report({
354
- node,
355
- loc: body.loc,
356
- messageId: opts && opts.condition ? "missingCurlyAfterCondition" : "missingCurlyAfter",
357
- data: {
358
- name
359
- },
360
- fix: fixer => fixer.replaceText(body, `{${sourceCode.getText(body)}}`)
361
- });
362
- } else {
363
- context.report({
364
- node,
365
- loc: body.loc,
366
- messageId: opts && opts.condition ? "unexpectedCurlyAfterCondition" : "unexpectedCurlyAfter",
367
- data: {
368
- name
369
- },
370
- fix(fixer) {
371
-
372
- /*
373
- * `do while` expressions sometimes need a space to be inserted after `do`.
374
- * e.g. `do{foo()} while (bar)` should be corrected to `do foo() while (bar)`
375
- */
376
- const needsPrecedingSpace = node.type === "DoWhileStatement" &&
377
- sourceCode.getTokenBefore(body).range[1] === body.range[0] &&
378
- !astUtils.canTokensBeAdjacent("do", sourceCode.getFirstToken(body, { skip: 1 }));
379
-
380
- const openingBracket = sourceCode.getFirstToken(body);
381
- const closingBracket = sourceCode.getLastToken(body);
382
- const lastTokenInBlock = sourceCode.getTokenBefore(closingBracket);
383
-
384
- if (needsSemicolon(closingBracket)) {
385
-
386
- /*
387
- * If removing braces would cause a SyntaxError due to multiple statements on the same line (or
388
- * change the semantics of the code due to ASI), don't perform a fix.
389
- */
390
- return null;
391
- }
392
-
393
- const resultingBodyText = sourceCode.getText().slice(openingBracket.range[1], lastTokenInBlock.range[0]) +
394
- sourceCode.getText(lastTokenInBlock) +
395
- sourceCode.getText().slice(lastTokenInBlock.range[1], closingBracket.range[0]);
396
-
397
- return fixer.replaceText(body, (needsPrecedingSpace ? " " : "") + resultingBodyText);
398
- }
399
- });
400
- }
401
- }
402
- }
403
- };
404
- }
405
-
406
- /**
407
- * Prepares to check the bodies of a "if", "else if" and "else" chain.
408
- * @param {ASTNode} node The first IfStatement node of the chain.
409
- * @returns {Object[]} prepared checks for each body of the chain. See `prepareCheck` for more
410
- * information.
411
- */
412
- function prepareIfChecks(node) {
413
- const preparedChecks = [];
414
-
415
- for (let currentNode = node; currentNode; currentNode = currentNode.alternate) {
416
- preparedChecks.push(prepareCheck(currentNode, currentNode.consequent, "if", { condition: true }));
417
- if (currentNode.alternate && currentNode.alternate.type !== "IfStatement") {
418
- preparedChecks.push(prepareCheck(currentNode, currentNode.alternate, "else"));
419
- break;
420
- }
421
- }
422
-
423
- if (consistent) {
424
-
425
- /*
426
- * If any node should have or already have braces, make sure they
427
- * all have braces.
428
- * If all nodes shouldn't have braces, make sure they don't.
429
- */
430
- const expected = preparedChecks.some(preparedCheck => {
431
- if (preparedCheck.expected !== null) {
432
- return preparedCheck.expected;
433
- }
434
- return preparedCheck.actual;
435
- });
436
-
437
- preparedChecks.forEach(preparedCheck => {
438
- preparedCheck.expected = expected;
439
- });
440
- }
441
-
442
- return preparedChecks;
443
- }
444
-
445
- //--------------------------------------------------------------------------
446
- // Public
447
- //--------------------------------------------------------------------------
448
-
449
- return {
450
- IfStatement(node) {
451
- const parent = node.parent;
452
- const isElseIf = parent.type === "IfStatement" && parent.alternate === node;
453
-
454
- if (!isElseIf) {
455
-
456
- // This is a top `if`, check the whole `if-else-if` chain
457
- prepareIfChecks(node).forEach(preparedCheck => {
458
- preparedCheck.check();
459
- });
460
- }
461
-
462
- // Skip `else if`, it's already checked (when the top `if` was visited)
463
- },
464
-
465
- WhileStatement(node) {
466
- prepareCheck(node, node.body, "while", { condition: true }).check();
467
- },
468
-
469
- DoWhileStatement(node) {
470
- prepareCheck(node, node.body, "do").check();
471
- },
472
-
473
- ForStatement(node) {
474
- prepareCheck(node, node.body, "for", { condition: true }).check();
475
- },
476
-
477
- ForInStatement(node) {
478
- prepareCheck(node, node.body, "for-in").check();
479
- },
480
-
481
- ForOfStatement(node) {
482
- prepareCheck(node, node.body, "for-of").check();
483
- }
484
- };
485
- }
19
+ meta: {
20
+ type: "suggestion",
21
+
22
+ docs: {
23
+ description:
24
+ "Enforce consistent brace style for all control statements",
25
+ recommended: false,
26
+ frozen: true,
27
+ url: "https://eslint.org/docs/latest/rules/curly",
28
+ },
29
+
30
+ schema: {
31
+ anyOf: [
32
+ {
33
+ type: "array",
34
+ items: [
35
+ {
36
+ enum: ["all"],
37
+ },
38
+ ],
39
+ minItems: 0,
40
+ maxItems: 1,
41
+ },
42
+ {
43
+ type: "array",
44
+ items: [
45
+ {
46
+ enum: ["multi", "multi-line", "multi-or-nest"],
47
+ },
48
+ {
49
+ enum: ["consistent"],
50
+ },
51
+ ],
52
+ minItems: 0,
53
+ maxItems: 2,
54
+ },
55
+ ],
56
+ },
57
+
58
+ defaultOptions: ["all"],
59
+
60
+ fixable: "code",
61
+
62
+ messages: {
63
+ missingCurlyAfter: "Expected { after '{{name}}'.",
64
+ missingCurlyAfterCondition:
65
+ "Expected { after '{{name}}' condition.",
66
+ unexpectedCurlyAfter: "Unnecessary { after '{{name}}'.",
67
+ unexpectedCurlyAfterCondition:
68
+ "Unnecessary { after '{{name}}' condition.",
69
+ },
70
+ },
71
+
72
+ create(context) {
73
+ const multiOnly = context.options[0] === "multi";
74
+ const multiLine = context.options[0] === "multi-line";
75
+ const multiOrNest = context.options[0] === "multi-or-nest";
76
+ const consistent = context.options[1] === "consistent";
77
+
78
+ const sourceCode = context.sourceCode;
79
+
80
+ //--------------------------------------------------------------------------
81
+ // Helpers
82
+ //--------------------------------------------------------------------------
83
+
84
+ /**
85
+ * Determines if a given node is a one-liner that's on the same line as it's preceding code.
86
+ * @param {ASTNode} node The node to check.
87
+ * @returns {boolean} True if the node is a one-liner that's on the same line as it's preceding code.
88
+ * @private
89
+ */
90
+ function isCollapsedOneLiner(node) {
91
+ const before = sourceCode.getTokenBefore(node);
92
+ const last = sourceCode.getLastToken(node);
93
+ const lastExcludingSemicolon = astUtils.isSemicolonToken(last)
94
+ ? sourceCode.getTokenBefore(last)
95
+ : last;
96
+
97
+ return (
98
+ before.loc.start.line === lastExcludingSemicolon.loc.end.line
99
+ );
100
+ }
101
+
102
+ /**
103
+ * Determines if a given node is a one-liner.
104
+ * @param {ASTNode} node The node to check.
105
+ * @returns {boolean} True if the node is a one-liner.
106
+ * @private
107
+ */
108
+ function isOneLiner(node) {
109
+ if (node.type === "EmptyStatement") {
110
+ return true;
111
+ }
112
+
113
+ const first = sourceCode.getFirstToken(node);
114
+ const last = sourceCode.getLastToken(node);
115
+ const lastExcludingSemicolon = astUtils.isSemicolonToken(last)
116
+ ? sourceCode.getTokenBefore(last)
117
+ : last;
118
+
119
+ return first.loc.start.line === lastExcludingSemicolon.loc.end.line;
120
+ }
121
+
122
+ /**
123
+ * Determines if a semicolon needs to be inserted after removing a set of curly brackets, in order to avoid a SyntaxError.
124
+ * @param {Token} closingBracket The } token
125
+ * @returns {boolean} `true` if a semicolon needs to be inserted after the last statement in the block.
126
+ */
127
+ function needsSemicolon(closingBracket) {
128
+ const tokenBefore = sourceCode.getTokenBefore(closingBracket);
129
+ const tokenAfter = sourceCode.getTokenAfter(closingBracket);
130
+ const lastBlockNode = sourceCode.getNodeByRangeIndex(
131
+ tokenBefore.range[0],
132
+ );
133
+
134
+ if (astUtils.isSemicolonToken(tokenBefore)) {
135
+ // If the last statement already has a semicolon, don't add another one.
136
+ return false;
137
+ }
138
+
139
+ if (!tokenAfter) {
140
+ // If there are no statements after this block, there is no need to add a semicolon.
141
+ return false;
142
+ }
143
+
144
+ if (
145
+ lastBlockNode.type === "BlockStatement" &&
146
+ lastBlockNode.parent.type !== "FunctionExpression" &&
147
+ lastBlockNode.parent.type !== "ArrowFunctionExpression"
148
+ ) {
149
+ /*
150
+ * If the last node surrounded by curly brackets is a BlockStatement (other than a FunctionExpression or an ArrowFunctionExpression),
151
+ * don't insert a semicolon. Otherwise, the semicolon would be parsed as a separate statement, which would cause
152
+ * a SyntaxError if it was followed by `else`.
153
+ */
154
+ return false;
155
+ }
156
+
157
+ if (tokenBefore.loc.end.line === tokenAfter.loc.start.line) {
158
+ // If the next token is on the same line, insert a semicolon.
159
+ return true;
160
+ }
161
+
162
+ if (/^[([/`+-]/u.test(tokenAfter.value)) {
163
+ // If the next token starts with a character that would disrupt ASI, insert a semicolon.
164
+ return true;
165
+ }
166
+
167
+ if (
168
+ tokenBefore.type === "Punctuator" &&
169
+ (tokenBefore.value === "++" || tokenBefore.value === "--")
170
+ ) {
171
+ // If the last token is ++ or --, insert a semicolon to avoid disrupting ASI.
172
+ return true;
173
+ }
174
+
175
+ // Otherwise, do not insert a semicolon.
176
+ return false;
177
+ }
178
+
179
+ /**
180
+ * Prepares to check the body of a node to see if it's a block statement.
181
+ * @param {ASTNode} node The node to report if there's a problem.
182
+ * @param {ASTNode} body The body node to check for blocks.
183
+ * @param {string} name The name to report if there's a problem.
184
+ * @param {{ condition: boolean }} opts Options to pass to the report functions
185
+ * @returns {Object} a prepared check object, with "actual", "expected", "check" properties.
186
+ * "actual" will be `true` or `false` whether the body is already a block statement.
187
+ * "expected" will be `true` or `false` if the body should be a block statement or not, or
188
+ * `null` if it doesn't matter, depending on the rule options. It can be modified to change
189
+ * the final behavior of "check".
190
+ * "check" will be a function reporting appropriate problems depending on the other
191
+ * properties.
192
+ */
193
+ function prepareCheck(node, body, name, opts) {
194
+ const hasBlock = body.type === "BlockStatement";
195
+ let expected = null;
196
+
197
+ if (
198
+ hasBlock &&
199
+ (body.body.length !== 1 ||
200
+ astUtils.areBracesNecessary(body, sourceCode))
201
+ ) {
202
+ expected = true;
203
+ } else if (multiOnly) {
204
+ expected = false;
205
+ } else if (multiLine) {
206
+ if (!isCollapsedOneLiner(body)) {
207
+ expected = true;
208
+ }
209
+
210
+ // otherwise, the body is allowed to have braces or not to have braces
211
+ } else if (multiOrNest) {
212
+ if (hasBlock) {
213
+ const statement = body.body[0];
214
+ const leadingCommentsInBlock =
215
+ sourceCode.getCommentsBefore(statement);
216
+
217
+ expected =
218
+ !isOneLiner(statement) ||
219
+ leadingCommentsInBlock.length > 0;
220
+ } else {
221
+ expected = !isOneLiner(body);
222
+ }
223
+ } else {
224
+ // default "all"
225
+ expected = true;
226
+ }
227
+
228
+ return {
229
+ actual: hasBlock,
230
+ expected,
231
+ check() {
232
+ if (
233
+ this.expected !== null &&
234
+ this.expected !== this.actual
235
+ ) {
236
+ if (this.expected) {
237
+ context.report({
238
+ node,
239
+ loc: body.loc,
240
+ messageId:
241
+ opts && opts.condition
242
+ ? "missingCurlyAfterCondition"
243
+ : "missingCurlyAfter",
244
+ data: {
245
+ name,
246
+ },
247
+ fix: fixer =>
248
+ fixer.replaceText(
249
+ body,
250
+ `{${sourceCode.getText(body)}}`,
251
+ ),
252
+ });
253
+ } else {
254
+ context.report({
255
+ node,
256
+ loc: body.loc,
257
+ messageId:
258
+ opts && opts.condition
259
+ ? "unexpectedCurlyAfterCondition"
260
+ : "unexpectedCurlyAfter",
261
+ data: {
262
+ name,
263
+ },
264
+ fix(fixer) {
265
+ /*
266
+ * `do while` expressions sometimes need a space to be inserted after `do`.
267
+ * e.g. `do{foo()} while (bar)` should be corrected to `do foo() while (bar)`
268
+ */
269
+ const needsPrecedingSpace =
270
+ node.type === "DoWhileStatement" &&
271
+ sourceCode.getTokenBefore(body)
272
+ .range[1] === body.range[0] &&
273
+ !astUtils.canTokensBeAdjacent(
274
+ "do",
275
+ sourceCode.getFirstToken(body, {
276
+ skip: 1,
277
+ }),
278
+ );
279
+
280
+ const openingBracket =
281
+ sourceCode.getFirstToken(body);
282
+ const closingBracket =
283
+ sourceCode.getLastToken(body);
284
+ const lastTokenInBlock =
285
+ sourceCode.getTokenBefore(
286
+ closingBracket,
287
+ );
288
+
289
+ if (needsSemicolon(closingBracket)) {
290
+ /*
291
+ * If removing braces would cause a SyntaxError due to multiple statements on the same line (or
292
+ * change the semantics of the code due to ASI), don't perform a fix.
293
+ */
294
+ return null;
295
+ }
296
+
297
+ const resultingBodyText =
298
+ sourceCode
299
+ .getText()
300
+ .slice(
301
+ openingBracket.range[1],
302
+ lastTokenInBlock.range[0],
303
+ ) +
304
+ sourceCode.getText(lastTokenInBlock) +
305
+ sourceCode
306
+ .getText()
307
+ .slice(
308
+ lastTokenInBlock.range[1],
309
+ closingBracket.range[0],
310
+ );
311
+
312
+ return fixer.replaceText(
313
+ body,
314
+ (needsPrecedingSpace ? " " : "") +
315
+ resultingBodyText,
316
+ );
317
+ },
318
+ });
319
+ }
320
+ }
321
+ },
322
+ };
323
+ }
324
+
325
+ /**
326
+ * Prepares to check the bodies of a "if", "else if" and "else" chain.
327
+ * @param {ASTNode} node The first IfStatement node of the chain.
328
+ * @returns {Object[]} prepared checks for each body of the chain. See `prepareCheck` for more
329
+ * information.
330
+ */
331
+ function prepareIfChecks(node) {
332
+ const preparedChecks = [];
333
+
334
+ for (
335
+ let currentNode = node;
336
+ currentNode;
337
+ currentNode = currentNode.alternate
338
+ ) {
339
+ preparedChecks.push(
340
+ prepareCheck(currentNode, currentNode.consequent, "if", {
341
+ condition: true,
342
+ }),
343
+ );
344
+ if (
345
+ currentNode.alternate &&
346
+ currentNode.alternate.type !== "IfStatement"
347
+ ) {
348
+ preparedChecks.push(
349
+ prepareCheck(
350
+ currentNode,
351
+ currentNode.alternate,
352
+ "else",
353
+ ),
354
+ );
355
+ break;
356
+ }
357
+ }
358
+
359
+ if (consistent) {
360
+ /*
361
+ * If any node should have or already have braces, make sure they
362
+ * all have braces.
363
+ * If all nodes shouldn't have braces, make sure they don't.
364
+ */
365
+ const expected = preparedChecks.some(preparedCheck => {
366
+ if (preparedCheck.expected !== null) {
367
+ return preparedCheck.expected;
368
+ }
369
+ return preparedCheck.actual;
370
+ });
371
+
372
+ preparedChecks.forEach(preparedCheck => {
373
+ preparedCheck.expected = expected;
374
+ });
375
+ }
376
+
377
+ return preparedChecks;
378
+ }
379
+
380
+ //--------------------------------------------------------------------------
381
+ // Public
382
+ //--------------------------------------------------------------------------
383
+
384
+ return {
385
+ IfStatement(node) {
386
+ const parent = node.parent;
387
+ const isElseIf =
388
+ parent.type === "IfStatement" && parent.alternate === node;
389
+
390
+ if (!isElseIf) {
391
+ // This is a top `if`, check the whole `if-else-if` chain
392
+ prepareIfChecks(node).forEach(preparedCheck => {
393
+ preparedCheck.check();
394
+ });
395
+ }
396
+
397
+ // Skip `else if`, it's already checked (when the top `if` was visited)
398
+ },
399
+
400
+ WhileStatement(node) {
401
+ prepareCheck(node, node.body, "while", {
402
+ condition: true,
403
+ }).check();
404
+ },
405
+
406
+ DoWhileStatement(node) {
407
+ prepareCheck(node, node.body, "do").check();
408
+ },
409
+
410
+ ForStatement(node) {
411
+ prepareCheck(node, node.body, "for", {
412
+ condition: true,
413
+ }).check();
414
+ },
415
+
416
+ ForInStatement(node) {
417
+ prepareCheck(node, node.body, "for-in").check();
418
+ },
419
+
420
+ ForOfStatement(node) {
421
+ prepareCheck(node, node.body, "for-of").check();
422
+ },
423
+ };
424
+ },
486
425
  };