eslint 9.22.0 → 9.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/README.md +48 -46
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +830 -810
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +638 -457
  21. package/lib/config/config-loader.js +726 -622
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +72 -72
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +756 -681
  30. package/lib/eslint/eslint.js +934 -912
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +577 -533
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2403 -2045
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +36 -36
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +404 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1308 -1046
  73. package/lib/rules/accessor-pairs.js +298 -263
  74. package/lib/rules/array-bracket-newline.js +250 -238
  75. package/lib/rules/array-bracket-spacing.js +263 -224
  76. package/lib/rules/array-callback-return.js +402 -356
  77. package/lib/rules/array-element-newline.js +358 -313
  78. package/lib/rules/arrow-body-style.js +400 -281
  79. package/lib/rules/arrow-parens.js +206 -173
  80. package/lib/rules/arrow-spacing.js +169 -163
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -176
  83. package/lib/rules/brace-style.js +262 -199
  84. package/lib/rules/callback-return.js +203 -190
  85. package/lib/rules/camelcase.js +403 -392
  86. package/lib/rules/capitalized-comments.js +253 -232
  87. package/lib/rules/class-methods-use-this.js +224 -172
  88. package/lib/rules/comma-dangle.js +379 -346
  89. package/lib/rules/comma-spacing.js +193 -195
  90. package/lib/rules/comma-style.js +375 -316
  91. package/lib/rules/complexity.js +173 -169
  92. package/lib/rules/computed-property-spacing.js +236 -211
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -147
  95. package/lib/rules/constructor-super.js +412 -404
  96. package/lib/rules/curly.js +407 -332
  97. package/lib/rules/default-case-last.js +38 -31
  98. package/lib/rules/default-case.js +89 -85
  99. package/lib/rules/default-param-last.js +69 -54
  100. package/lib/rules/dot-location.js +122 -110
  101. package/lib/rules/dot-notation.js +192 -156
  102. package/lib/rules/eol-last.js +122 -120
  103. package/lib/rules/eqeqeq.js +168 -155
  104. package/lib/rules/for-direction.js +146 -121
  105. package/lib/rules/func-call-spacing.js +261 -231
  106. package/lib/rules/func-name-matching.js +293 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +159 -127
  109. package/lib/rules/function-call-argument-newline.js +152 -129
  110. package/lib/rules/function-paren-newline.js +349 -291
  111. package/lib/rules/generator-star-spacing.js +229 -210
  112. package/lib/rules/getter-return.js +208 -172
  113. package/lib/rules/global-require.js +85 -74
  114. package/lib/rules/grouped-accessor-pairs.js +170 -150
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -103
  117. package/lib/rules/id-blacklist.js +182 -199
  118. package/lib/rules/id-denylist.js +168 -187
  119. package/lib/rules/id-length.js +197 -171
  120. package/lib/rules/id-match.js +344 -289
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -79
  122. package/lib/rules/indent-legacy.js +1344 -1118
  123. package/lib/rules/indent.js +2272 -1759
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +137 -107
  126. package/lib/rules/jsx-quotes.js +94 -82
  127. package/lib/rules/key-spacing.js +750 -633
  128. package/lib/rules/keyword-spacing.js +648 -605
  129. package/lib/rules/line-comment-position.js +142 -128
  130. package/lib/rules/linebreak-style.js +107 -106
  131. package/lib/rules/lines-around-comment.js +540 -448
  132. package/lib/rules/lines-around-directive.js +233 -203
  133. package/lib/rules/lines-between-class-members.js +305 -234
  134. package/lib/rules/logical-assignment-operators.js +582 -399
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -434
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +78 -76
  142. package/lib/rules/max-statements-per-line.js +205 -198
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +637 -479
  145. package/lib/rules/multiline-ternary.js +241 -176
  146. package/lib/rules/new-cap.js +233 -213
  147. package/lib/rules/new-parens.js +88 -79
  148. package/lib/rules/newline-after-var.js +287 -250
  149. package/lib/rules/newline-before-return.js +229 -222
  150. package/lib/rules/newline-per-chained-call.js +142 -127
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +125 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +69 -71
  155. package/lib/rules/no-bitwise.js +124 -100
  156. package/lib/rules/no-buffer-constructor.js +55 -47
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -57
  159. package/lib/rules/no-catch-shadow.js +76 -73
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -81
  164. package/lib/rules/no-console.js +202 -199
  165. package/lib/rules/no-const-assign.js +47 -41
  166. package/lib/rules/no-constant-binary-expression.js +500 -405
  167. package/lib/rules/no-constant-condition.js +158 -143
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -27
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -41
  174. package/lib/rules/no-dupe-args.js +68 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +179 -176
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +127 -128
  183. package/lib/rules/no-empty-pattern.js +63 -58
  184. package/lib/rules/no-empty-static-block.js +37 -35
  185. package/lib/rules/no-empty.js +98 -86
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +256 -250
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -159
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -348
  192. package/lib/rules/no-extra-label.js +150 -131
  193. package/lib/rules/no-extra-parens.js +1654 -1325
  194. package/lib/rules/no-extra-semi.js +146 -144
  195. package/lib/rules/no-fallthrough.js +199 -157
  196. package/lib/rules/no-floating-decimal.js +74 -66
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -73
  199. package/lib/rules/no-implicit-coercion.js +349 -293
  200. package/lib/rules/no-implicit-globals.js +158 -135
  201. package/lib/rules/no-implied-eval.js +140 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -95
  204. package/lib/rules/no-inner-declarations.js +115 -101
  205. package/lib/rules/no-invalid-regexp.js +222 -190
  206. package/lib/rules/no-invalid-this.js +123 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -252
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -62
  210. package/lib/rules/no-labels.js +138 -133
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +108 -77
  213. package/lib/rules/no-loop-func.js +238 -213
  214. package/lib/rules/no-loss-of-precision.js +218 -201
  215. package/lib/rules/no-magic-numbers.js +246 -218
  216. package/lib/rules/no-misleading-character-class.js +499 -446
  217. package/lib/rules/no-mixed-operators.js +188 -182
  218. package/lib/rules/no-mixed-requires.js +253 -240
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +134 -121
  220. package/lib/rules/no-multi-assign.js +46 -44
  221. package/lib/rules/no-multi-spaces.js +163 -143
  222. package/lib/rules/no-multi-str.js +42 -41
  223. package/lib/rules/no-multiple-empty-lines.js +196 -158
  224. package/lib/rules/no-native-reassign.js +90 -85
  225. package/lib/rules/no-negated-condition.js +79 -75
  226. package/lib/rules/no-negated-in-lhs.js +45 -43
  227. package/lib/rules/no-nested-ternary.js +33 -32
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -48
  231. package/lib/rules/no-new-require.js +48 -47
  232. package/lib/rules/no-new-symbol.js +52 -50
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +141 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +32 -32
  240. package/lib/rules/no-param-reassign.js +235 -217
  241. package/lib/rules/no-path-concat.js +66 -67
  242. package/lib/rules/no-plusplus.js +60 -61
  243. package/lib/rules/no-process-env.js +49 -48
  244. package/lib/rules/no-process-exit.js +54 -50
  245. package/lib/rules/no-promise-executor-return.js +214 -182
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -152
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -185
  251. package/lib/rules/no-restricted-globals.js +111 -112
  252. package/lib/rules/no-restricted-imports.js +657 -537
  253. package/lib/rules/no-restricted-modules.js +222 -202
  254. package/lib/rules/no-restricted-properties.js +181 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +55 -50
  257. package/lib/rules/no-return-await.js +148 -124
  258. package/lib/rules/no-script-url.js +52 -45
  259. package/lib/rules/no-self-assign.js +148 -146
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -116
  262. package/lib/rules/no-setter-return.js +185 -152
  263. package/lib/rules/no-shadow-restricted-names.js +61 -46
  264. package/lib/rules/no-shadow.js +342 -316
  265. package/lib/rules/no-spaced-func.js +82 -77
  266. package/lib/rules/no-sparse-arrays.js +54 -59
  267. package/lib/rules/no-sync.js +61 -60
  268. package/lib/rules/no-tabs.js +83 -72
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -29
  271. package/lib/rules/no-this-before-super.js +321 -319
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +199 -191
  274. package/lib/rules/no-undef-init.js +76 -61
  275. package/lib/rules/no-undef.js +51 -48
  276. package/lib/rules/no-undefined.js +73 -75
  277. package/lib/rules/no-underscore-dangle.js +370 -327
  278. package/lib/rules/no-unexpected-multiline.js +112 -102
  279. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  280. package/lib/rules/no-unneeded-ternary.js +212 -147
  281. package/lib/rules/no-unreachable-loop.js +145 -142
  282. package/lib/rules/no-unreachable.js +255 -248
  283. package/lib/rules/no-unsafe-finally.js +93 -85
  284. package/lib/rules/no-unsafe-negation.js +105 -83
  285. package/lib/rules/no-unsafe-optional-chaining.js +192 -178
  286. package/lib/rules/no-unused-expressions.js +178 -162
  287. package/lib/rules/no-unused-labels.js +139 -124
  288. package/lib/rules/no-unused-private-class-members.js +206 -182
  289. package/lib/rules/no-unused-vars.js +1669 -1449
  290. package/lib/rules/no-use-before-define.js +229 -231
  291. package/lib/rules/no-useless-assignment.js +590 -511
  292. package/lib/rules/no-useless-backreference.js +212 -193
  293. package/lib/rules/no-useless-call.js +58 -53
  294. package/lib/rules/no-useless-catch.js +40 -40
  295. package/lib/rules/no-useless-computed-key.js +144 -115
  296. package/lib/rules/no-useless-concat.js +65 -60
  297. package/lib/rules/no-useless-constructor.js +158 -111
  298. package/lib/rules/no-useless-escape.js +342 -291
  299. package/lib/rules/no-useless-rename.js +183 -156
  300. package/lib/rules/no-useless-return.js +344 -312
  301. package/lib/rules/no-var.js +233 -212
  302. package/lib/rules/no-void.js +50 -48
  303. package/lib/rules/no-warning-comments.js +191 -186
  304. package/lib/rules/no-whitespace-before-property.js +131 -115
  305. package/lib/rules/no-with.js +24 -26
  306. package/lib/rules/nonblock-statement-body-position.js +149 -130
  307. package/lib/rules/object-curly-newline.js +306 -265
  308. package/lib/rules/object-curly-spacing.js +360 -314
  309. package/lib/rules/object-property-newline.js +137 -106
  310. package/lib/rules/object-shorthand.js +607 -502
  311. package/lib/rules/one-var-declaration-per-line.js +104 -100
  312. package/lib/rules/one-var.js +653 -537
  313. package/lib/rules/operator-assignment.js +219 -161
  314. package/lib/rules/operator-linebreak.js +295 -251
  315. package/lib/rules/padded-blocks.js +346 -308
  316. package/lib/rules/padding-line-between-statements.js +443 -439
  317. package/lib/rules/prefer-arrow-callback.js +362 -313
  318. package/lib/rules/prefer-const.js +418 -377
  319. package/lib/rules/prefer-destructuring.js +301 -279
  320. package/lib/rules/prefer-exponentiation-operator.js +176 -133
  321. package/lib/rules/prefer-named-capture-group.js +153 -140
  322. package/lib/rules/prefer-numeric-literals.js +121 -113
  323. package/lib/rules/prefer-object-has-own.js +116 -82
  324. package/lib/rules/prefer-object-spread.js +213 -193
  325. package/lib/rules/prefer-promise-reject-errors.js +140 -122
  326. package/lib/rules/prefer-reflect.js +127 -107
  327. package/lib/rules/prefer-regex-literals.js +578 -466
  328. package/lib/rules/prefer-rest-params.js +79 -80
  329. package/lib/rules/prefer-spread.js +47 -44
  330. package/lib/rules/prefer-template.js +266 -195
  331. package/lib/rules/quote-props.js +373 -307
  332. package/lib/rules/quotes.js +374 -326
  333. package/lib/rules/radix.js +152 -136
  334. package/lib/rules/require-atomic-updates.js +316 -285
  335. package/lib/rules/require-await.js +144 -116
  336. package/lib/rules/require-unicode-regexp.js +282 -177
  337. package/lib/rules/require-yield.js +53 -54
  338. package/lib/rules/rest-spread-spacing.js +128 -116
  339. package/lib/rules/semi-spacing.js +281 -250
  340. package/lib/rules/semi-style.js +176 -134
  341. package/lib/rules/semi.js +456 -436
  342. package/lib/rules/sort-imports.js +306 -233
  343. package/lib/rules/sort-keys.js +219 -188
  344. package/lib/rules/sort-vars.js +127 -93
  345. package/lib/rules/space-before-blocks.js +199 -189
  346. package/lib/rules/space-before-function-paren.js +186 -166
  347. package/lib/rules/space-in-parens.js +359 -288
  348. package/lib/rules/space-infix-ops.js +237 -201
  349. package/lib/rules/space-unary-ops.js +356 -298
  350. package/lib/rules/spaced-comment.js +363 -319
  351. package/lib/rules/strict.js +265 -230
  352. package/lib/rules/switch-colon-spacing.js +130 -122
  353. package/lib/rules/symbol-description.js +45 -48
  354. package/lib/rules/template-curly-spacing.js +148 -142
  355. package/lib/rules/template-tag-spacing.js +98 -88
  356. package/lib/rules/unicode-bom.js +54 -56
  357. package/lib/rules/use-isnan.js +237 -206
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +153 -111
  370. package/lib/rules/vars-on-top.js +152 -145
  371. package/lib/rules/wrap-iife.js +204 -191
  372. package/lib/rules/wrap-regex.js +70 -58
  373. package/lib/rules/yield-star-spacing.js +145 -134
  374. package/lib/rules/yoda.js +283 -272
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/services/suppressions-service.js +289 -0
  378. package/lib/shared/ajv.js +14 -14
  379. package/lib/shared/assert.js +3 -4
  380. package/lib/shared/ast-utils.js +7 -6
  381. package/lib/shared/deep-merge-arrays.js +24 -22
  382. package/lib/shared/directives.js +3 -2
  383. package/lib/shared/flags.js +50 -17
  384. package/lib/shared/logging.js +24 -25
  385. package/lib/shared/option-utils.js +43 -36
  386. package/lib/shared/runtime-info.js +136 -127
  387. package/lib/shared/serialization.js +27 -27
  388. package/lib/shared/severity.js +22 -22
  389. package/lib/shared/stats.js +5 -5
  390. package/lib/shared/string-utils.js +16 -16
  391. package/lib/shared/text-table.js +28 -27
  392. package/lib/shared/traverser.js +153 -146
  393. package/lib/shared/types.js +4 -27
  394. package/lib/types/index.d.ts +2010 -1559
  395. package/lib/types/rules.d.ts +5253 -5140
  396. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  397. package/lib/unsupported-api.js +5 -5
  398. package/messages/all-files-ignored.js +3 -3
  399. package/messages/all-matched-files-ignored.js +3 -3
  400. package/messages/config-file-missing.js +2 -2
  401. package/messages/config-plugin-missing.js +3 -3
  402. package/messages/config-serialize-function.js +9 -7
  403. package/messages/eslintrc-incompat.js +13 -15
  404. package/messages/eslintrc-plugins.js +3 -4
  405. package/messages/extend-config-missing.js +3 -3
  406. package/messages/failed-to-read-json.js +3 -3
  407. package/messages/file-not-found.js +3 -3
  408. package/messages/invalid-rule-options.js +2 -2
  409. package/messages/invalid-rule-severity.js +2 -2
  410. package/messages/no-config-found.js +3 -3
  411. package/messages/plugin-conflict.js +8 -8
  412. package/messages/plugin-invalid.js +3 -3
  413. package/messages/plugin-missing.js +3 -3
  414. package/messages/print-config-with-directory-path.js +2 -2
  415. package/messages/shared.js +6 -1
  416. package/messages/whitespace-found.js +3 -3
  417. package/package.json +14 -20
@@ -6,12 +6,12 @@
6
6
  "use strict";
7
7
 
8
8
  const OPTIONS = {
9
- always: "always",
10
- never: "never",
11
- methods: "methods",
12
- properties: "properties",
13
- consistent: "consistent",
14
- consistentAsNeeded: "consistent-as-needed"
9
+ always: "always",
10
+ never: "never",
11
+ methods: "methods",
12
+ properties: "properties",
13
+ consistent: "consistent",
14
+ consistentAsNeeded: "consistent-as-needed",
15
15
  };
16
16
 
17
17
  //------------------------------------------------------------------------------
@@ -22,501 +22,606 @@ const astUtils = require("./utils/ast-utils");
22
22
  //------------------------------------------------------------------------------
23
23
  // Rule Definition
24
24
  //------------------------------------------------------------------------------
25
- /** @type {import('../shared/types').Rule} */
25
+ /** @type {import('../types').Rule.RuleModule} */
26
26
  module.exports = {
27
- meta: {
28
- type: "suggestion",
29
-
30
- docs: {
31
- description: "Require or disallow method and property shorthand syntax for object literals",
32
- recommended: false,
33
- frozen: true,
34
- url: "https://eslint.org/docs/latest/rules/object-shorthand"
35
- },
36
-
37
- fixable: "code",
38
-
39
- schema: {
40
- anyOf: [
41
- {
42
- type: "array",
43
- items: [
44
- {
45
- enum: ["always", "methods", "properties", "never", "consistent", "consistent-as-needed"]
46
- }
47
- ],
48
- minItems: 0,
49
- maxItems: 1
50
- },
51
- {
52
- type: "array",
53
- items: [
54
- {
55
- enum: ["always", "methods", "properties"]
56
- },
57
- {
58
- type: "object",
59
- properties: {
60
- avoidQuotes: {
61
- type: "boolean"
62
- }
63
- },
64
- additionalProperties: false
65
- }
66
- ],
67
- minItems: 0,
68
- maxItems: 2
69
- },
70
- {
71
- type: "array",
72
- items: [
73
- {
74
- enum: ["always", "methods"]
75
- },
76
- {
77
- type: "object",
78
- properties: {
79
- ignoreConstructors: {
80
- type: "boolean"
81
- },
82
- methodsIgnorePattern: {
83
- type: "string"
84
- },
85
- avoidQuotes: {
86
- type: "boolean"
87
- },
88
- avoidExplicitReturnArrows: {
89
- type: "boolean"
90
- }
91
- },
92
- additionalProperties: false
93
- }
94
- ],
95
- minItems: 0,
96
- maxItems: 2
97
- }
98
- ]
99
- },
100
-
101
- messages: {
102
- expectedAllPropertiesShorthanded: "Expected shorthand for all properties.",
103
- expectedLiteralMethodLongform: "Expected longform method syntax for string literal keys.",
104
- expectedPropertyShorthand: "Expected property shorthand.",
105
- expectedPropertyLongform: "Expected longform property syntax.",
106
- expectedMethodShorthand: "Expected method shorthand.",
107
- expectedMethodLongform: "Expected longform method syntax.",
108
- unexpectedMix: "Unexpected mix of shorthand and non-shorthand properties."
109
- }
110
- },
111
-
112
- create(context) {
113
- const APPLY = context.options[0] || OPTIONS.always;
114
- const APPLY_TO_METHODS = APPLY === OPTIONS.methods || APPLY === OPTIONS.always;
115
- const APPLY_TO_PROPS = APPLY === OPTIONS.properties || APPLY === OPTIONS.always;
116
- const APPLY_NEVER = APPLY === OPTIONS.never;
117
- const APPLY_CONSISTENT = APPLY === OPTIONS.consistent;
118
- const APPLY_CONSISTENT_AS_NEEDED = APPLY === OPTIONS.consistentAsNeeded;
119
-
120
- const PARAMS = context.options[1] || {};
121
- const IGNORE_CONSTRUCTORS = PARAMS.ignoreConstructors;
122
- const METHODS_IGNORE_PATTERN = PARAMS.methodsIgnorePattern
123
- ? new RegExp(PARAMS.methodsIgnorePattern, "u")
124
- : null;
125
- const AVOID_QUOTES = PARAMS.avoidQuotes;
126
- const AVOID_EXPLICIT_RETURN_ARROWS = !!PARAMS.avoidExplicitReturnArrows;
127
- const sourceCode = context.sourceCode;
128
-
129
- //--------------------------------------------------------------------------
130
- // Helpers
131
- //--------------------------------------------------------------------------
132
-
133
- const CTOR_PREFIX_REGEX = /[^_$0-9]/u;
134
-
135
- /**
136
- * Determines if the first character of the name is a capital letter.
137
- * @param {string} name The name of the node to evaluate.
138
- * @returns {boolean} True if the first character of the property name is a capital letter, false if not.
139
- * @private
140
- */
141
- function isConstructor(name) {
142
- const match = CTOR_PREFIX_REGEX.exec(name);
143
-
144
- // Not a constructor if name has no characters apart from '_', '$' and digits e.g. '_', '$$', '_8'
145
- if (!match) {
146
- return false;
147
- }
148
-
149
- const firstChar = name.charAt(match.index);
150
-
151
- return firstChar === firstChar.toUpperCase();
152
- }
153
-
154
- /**
155
- * Determines if the property can have a shorthand form.
156
- * @param {ASTNode} property Property AST node
157
- * @returns {boolean} True if the property can have a shorthand form
158
- * @private
159
- */
160
- function canHaveShorthand(property) {
161
- return (property.kind !== "set" && property.kind !== "get" && property.type !== "SpreadElement" && property.type !== "SpreadProperty" && property.type !== "ExperimentalSpreadProperty");
162
- }
163
-
164
- /**
165
- * Checks whether a node is a string literal.
166
- * @param {ASTNode} node Any AST node.
167
- * @returns {boolean} `true` if it is a string literal.
168
- */
169
- function isStringLiteral(node) {
170
- return node.type === "Literal" && typeof node.value === "string";
171
- }
172
-
173
- /**
174
- * Determines if the property is a shorthand or not.
175
- * @param {ASTNode} property Property AST node
176
- * @returns {boolean} True if the property is considered shorthand, false if not.
177
- * @private
178
- */
179
- function isShorthand(property) {
180
-
181
- // property.method is true when `{a(){}}`.
182
- return (property.shorthand || property.method);
183
- }
184
-
185
- /**
186
- * Determines if the property's key and method or value are named equally.
187
- * @param {ASTNode} property Property AST node
188
- * @returns {boolean} True if the key and value are named equally, false if not.
189
- * @private
190
- */
191
- function isRedundant(property) {
192
- const value = property.value;
193
-
194
- if (value.type === "FunctionExpression") {
195
- return !value.id; // Only anonymous should be shorthand method.
196
- }
197
- if (value.type === "Identifier") {
198
- return astUtils.getStaticPropertyName(property) === value.name;
199
- }
200
-
201
- return false;
202
- }
203
-
204
- /**
205
- * Ensures that an object's properties are consistently shorthand, or not shorthand at all.
206
- * @param {ASTNode} node Property AST node
207
- * @param {boolean} checkRedundancy Whether to check longform redundancy
208
- * @returns {void}
209
- */
210
- function checkConsistency(node, checkRedundancy) {
211
-
212
- // We are excluding getters/setters and spread properties as they are considered neither longform nor shorthand.
213
- const properties = node.properties.filter(canHaveShorthand);
214
-
215
- // Do we still have properties left after filtering the getters and setters?
216
- if (properties.length > 0) {
217
- const shorthandProperties = properties.filter(isShorthand);
218
-
219
- /*
220
- * If we do not have an equal number of longform properties as
221
- * shorthand properties, we are using the annotations inconsistently
222
- */
223
- if (shorthandProperties.length !== properties.length) {
224
-
225
- // We have at least 1 shorthand property
226
- if (shorthandProperties.length > 0) {
227
- context.report({ node, messageId: "unexpectedMix" });
228
- } else if (checkRedundancy) {
229
-
230
- /*
231
- * If all properties of the object contain a method or value with a name matching it's key,
232
- * all the keys are redundant.
233
- */
234
- const canAlwaysUseShorthand = properties.every(isRedundant);
235
-
236
- if (canAlwaysUseShorthand) {
237
- context.report({ node, messageId: "expectedAllPropertiesShorthanded" });
238
- }
239
- }
240
- }
241
- }
242
- }
243
-
244
- /**
245
- * Fixes a FunctionExpression node by making it into a shorthand property.
246
- * @param {SourceCodeFixer} fixer The fixer object
247
- * @param {ASTNode} node A `Property` node that has a `FunctionExpression` or `ArrowFunctionExpression` as its value
248
- * @returns {Object} A fix for this node
249
- */
250
- function makeFunctionShorthand(fixer, node) {
251
- const firstKeyToken = node.computed
252
- ? sourceCode.getFirstToken(node, astUtils.isOpeningBracketToken)
253
- : sourceCode.getFirstToken(node.key);
254
- const lastKeyToken = node.computed
255
- ? sourceCode.getFirstTokenBetween(node.key, node.value, astUtils.isClosingBracketToken)
256
- : sourceCode.getLastToken(node.key);
257
- const keyText = sourceCode.text.slice(firstKeyToken.range[0], lastKeyToken.range[1]);
258
- let keyPrefix = "";
259
-
260
- // key: /* */ () => {}
261
- if (sourceCode.commentsExistBetween(lastKeyToken, node.value)) {
262
- return null;
263
- }
264
-
265
- if (node.value.async) {
266
- keyPrefix += "async ";
267
- }
268
- if (node.value.generator) {
269
- keyPrefix += "*";
270
- }
271
-
272
- const fixRange = [firstKeyToken.range[0], node.range[1]];
273
- const methodPrefix = keyPrefix + keyText;
274
-
275
- if (node.value.type === "FunctionExpression") {
276
- const functionToken = sourceCode.getTokens(node.value).find(token => token.type === "Keyword" && token.value === "function");
277
- const tokenBeforeParams = node.value.generator ? sourceCode.getTokenAfter(functionToken) : functionToken;
278
-
279
- return fixer.replaceTextRange(
280
- fixRange,
281
- methodPrefix + sourceCode.text.slice(tokenBeforeParams.range[1], node.value.range[1])
282
- );
283
- }
284
-
285
- const arrowToken = sourceCode.getTokenBefore(node.value.body, astUtils.isArrowToken);
286
- const fnBody = sourceCode.text.slice(arrowToken.range[1], node.value.range[1]);
287
-
288
- // First token should not be `async`
289
- const firstValueToken = sourceCode.getFirstToken(node.value, {
290
- skip: node.value.async ? 1 : 0
291
- });
292
-
293
- const sliceStart = firstValueToken.range[0];
294
- const sliceEnd = sourceCode.getTokenBefore(arrowToken).range[1];
295
- const shouldAddParens = node.value.params.length === 1 && node.value.params[0].range[0] === sliceStart;
296
-
297
- const oldParamText = sourceCode.text.slice(sliceStart, sliceEnd);
298
- const newParamText = shouldAddParens ? `(${oldParamText})` : oldParamText;
299
-
300
- return fixer.replaceTextRange(
301
- fixRange,
302
- methodPrefix + newParamText + fnBody
303
- );
304
- }
305
-
306
- /**
307
- * Fixes a FunctionExpression node by making it into a longform property.
308
- * @param {SourceCodeFixer} fixer The fixer object
309
- * @param {ASTNode} node A `Property` node that has a `FunctionExpression` as its value
310
- * @returns {Object} A fix for this node
311
- */
312
- function makeFunctionLongform(fixer, node) {
313
- const firstKeyToken = node.computed ? sourceCode.getTokens(node).find(token => token.value === "[") : sourceCode.getFirstToken(node.key);
314
- const lastKeyToken = node.computed ? sourceCode.getTokensBetween(node.key, node.value).find(token => token.value === "]") : sourceCode.getLastToken(node.key);
315
- const keyText = sourceCode.text.slice(firstKeyToken.range[0], lastKeyToken.range[1]);
316
- let functionHeader = "function";
317
-
318
- if (node.value.async) {
319
- functionHeader = `async ${functionHeader}`;
320
- }
321
- if (node.value.generator) {
322
- functionHeader = `${functionHeader}*`;
323
- }
324
-
325
- return fixer.replaceTextRange([node.range[0], lastKeyToken.range[1]], `${keyText}: ${functionHeader}`);
326
- }
327
-
328
- /*
329
- * To determine whether a given arrow function has a lexical identifier (`this`, `arguments`, `super`, or `new.target`),
330
- * create a stack of functions that define these identifiers (i.e. all functions except arrow functions) as the AST is
331
- * traversed. Whenever a new function is encountered, create a new entry on the stack (corresponding to a different lexical
332
- * scope of `this`), and whenever a function is exited, pop that entry off the stack. When an arrow function is entered,
333
- * keep a reference to it on the current stack entry, and remove that reference when the arrow function is exited.
334
- * When a lexical identifier is encountered, mark all the arrow functions on the current stack entry by adding them
335
- * to an `arrowsWithLexicalIdentifiers` set. Any arrow function in that set will not be reported by this rule,
336
- * because converting it into a method would change the value of one of the lexical identifiers.
337
- */
338
- const lexicalScopeStack = [];
339
- const arrowsWithLexicalIdentifiers = new WeakSet();
340
- const argumentsIdentifiers = new WeakSet();
341
-
342
- /**
343
- * Enters a function. This creates a new lexical identifier scope, so a new Set of arrow functions is pushed onto the stack.
344
- * Also, this marks all `arguments` identifiers so that they can be detected later.
345
- * @param {ASTNode} node The node representing the function.
346
- * @returns {void}
347
- */
348
- function enterFunction(node) {
349
- lexicalScopeStack.unshift(new Set());
350
- sourceCode.getScope(node).variables.filter(variable => variable.name === "arguments").forEach(variable => {
351
- variable.references.map(ref => ref.identifier).forEach(identifier => argumentsIdentifiers.add(identifier));
352
- });
353
- }
354
-
355
- /**
356
- * Exits a function. This pops the current set of arrow functions off the lexical scope stack.
357
- * @returns {void}
358
- */
359
- function exitFunction() {
360
- lexicalScopeStack.shift();
361
- }
362
-
363
- /**
364
- * Marks the current function as having a lexical keyword. This implies that all arrow functions
365
- * in the current lexical scope contain a reference to this lexical keyword.
366
- * @returns {void}
367
- */
368
- function reportLexicalIdentifier() {
369
- lexicalScopeStack[0].forEach(arrowFunction => arrowsWithLexicalIdentifiers.add(arrowFunction));
370
- }
371
-
372
- //--------------------------------------------------------------------------
373
- // Public
374
- //--------------------------------------------------------------------------
375
-
376
- return {
377
- Program: enterFunction,
378
- FunctionDeclaration: enterFunction,
379
- FunctionExpression: enterFunction,
380
- "Program:exit": exitFunction,
381
- "FunctionDeclaration:exit": exitFunction,
382
- "FunctionExpression:exit": exitFunction,
383
-
384
- ArrowFunctionExpression(node) {
385
- lexicalScopeStack[0].add(node);
386
- },
387
- "ArrowFunctionExpression:exit"(node) {
388
- lexicalScopeStack[0].delete(node);
389
- },
390
-
391
- ThisExpression: reportLexicalIdentifier,
392
- Super: reportLexicalIdentifier,
393
- MetaProperty(node) {
394
- if (node.meta.name === "new" && node.property.name === "target") {
395
- reportLexicalIdentifier();
396
- }
397
- },
398
- Identifier(node) {
399
- if (argumentsIdentifiers.has(node)) {
400
- reportLexicalIdentifier();
401
- }
402
- },
403
-
404
- ObjectExpression(node) {
405
- if (APPLY_CONSISTENT) {
406
- checkConsistency(node, false);
407
- } else if (APPLY_CONSISTENT_AS_NEEDED) {
408
- checkConsistency(node, true);
409
- }
410
- },
411
-
412
- "Property:exit"(node) {
413
- const isConciseProperty = node.method || node.shorthand;
414
-
415
- // Ignore destructuring assignment
416
- if (node.parent.type === "ObjectPattern") {
417
- return;
418
- }
419
-
420
- // getters and setters are ignored
421
- if (node.kind === "get" || node.kind === "set") {
422
- return;
423
- }
424
-
425
- // only computed methods can fail the following checks
426
- if (node.computed && node.value.type !== "FunctionExpression" && node.value.type !== "ArrowFunctionExpression") {
427
- return;
428
- }
429
-
430
- //--------------------------------------------------------------
431
- // Checks for property/method shorthand.
432
- if (isConciseProperty) {
433
- if (node.method && (APPLY_NEVER || AVOID_QUOTES && isStringLiteral(node.key))) {
434
- const messageId = APPLY_NEVER ? "expectedMethodLongform" : "expectedLiteralMethodLongform";
435
-
436
- // { x() {} } should be written as { x: function() {} }
437
- context.report({
438
- node,
439
- messageId,
440
- fix: fixer => makeFunctionLongform(fixer, node)
441
- });
442
- } else if (APPLY_NEVER) {
443
-
444
- // { x } should be written as { x: x }
445
- context.report({
446
- node,
447
- messageId: "expectedPropertyLongform",
448
- fix: fixer => fixer.insertTextAfter(node.key, `: ${node.key.name}`)
449
- });
450
- }
451
- } else if (APPLY_TO_METHODS && !node.value.id && (node.value.type === "FunctionExpression" || node.value.type === "ArrowFunctionExpression")) {
452
- if (IGNORE_CONSTRUCTORS && node.key.type === "Identifier" && isConstructor(node.key.name)) {
453
- return;
454
- }
455
-
456
- if (METHODS_IGNORE_PATTERN) {
457
- const propertyName = astUtils.getStaticPropertyName(node);
458
-
459
- if (propertyName !== null && METHODS_IGNORE_PATTERN.test(propertyName)) {
460
- return;
461
- }
462
- }
463
-
464
- if (AVOID_QUOTES && isStringLiteral(node.key)) {
465
- return;
466
- }
467
-
468
- // {[x]: function(){}} should be written as {[x]() {}}
469
- if (node.value.type === "FunctionExpression" ||
470
- node.value.type === "ArrowFunctionExpression" &&
471
- node.value.body.type === "BlockStatement" &&
472
- AVOID_EXPLICIT_RETURN_ARROWS &&
473
- !arrowsWithLexicalIdentifiers.has(node.value)
474
- ) {
475
- context.report({
476
- node,
477
- messageId: "expectedMethodShorthand",
478
- fix: fixer => makeFunctionShorthand(fixer, node)
479
- });
480
- }
481
- } else if (node.value.type === "Identifier" && node.key.name === node.value.name && APPLY_TO_PROPS) {
482
-
483
- // {x: x} should be written as {x}
484
- context.report({
485
- node,
486
- messageId: "expectedPropertyShorthand",
487
- fix(fixer) {
488
-
489
- // x: /* */ x
490
- // x: (/* */ x)
491
- if (sourceCode.getCommentsInside(node).length > 0) {
492
- return null;
493
- }
494
-
495
- return fixer.replaceText(node, node.value.name);
496
- }
497
- });
498
- } else if (node.value.type === "Identifier" && node.key.type === "Literal" && node.key.value === node.value.name && APPLY_TO_PROPS) {
499
- if (AVOID_QUOTES) {
500
- return;
501
- }
502
-
503
- // {"x": x} should be written as {x}
504
- context.report({
505
- node,
506
- messageId: "expectedPropertyShorthand",
507
- fix(fixer) {
508
-
509
- // "x": /* */ x
510
- // "x": (/* */ x)
511
- if (sourceCode.getCommentsInside(node).length > 0) {
512
- return null;
513
- }
514
-
515
- return fixer.replaceText(node, node.value.name);
516
- }
517
- });
518
- }
519
- }
520
- };
521
- }
27
+ meta: {
28
+ type: "suggestion",
29
+
30
+ docs: {
31
+ description:
32
+ "Require or disallow method and property shorthand syntax for object literals",
33
+ recommended: false,
34
+ frozen: true,
35
+ url: "https://eslint.org/docs/latest/rules/object-shorthand",
36
+ },
37
+
38
+ fixable: "code",
39
+
40
+ schema: {
41
+ anyOf: [
42
+ {
43
+ type: "array",
44
+ items: [
45
+ {
46
+ enum: [
47
+ "always",
48
+ "methods",
49
+ "properties",
50
+ "never",
51
+ "consistent",
52
+ "consistent-as-needed",
53
+ ],
54
+ },
55
+ ],
56
+ minItems: 0,
57
+ maxItems: 1,
58
+ },
59
+ {
60
+ type: "array",
61
+ items: [
62
+ {
63
+ enum: ["always", "methods", "properties"],
64
+ },
65
+ {
66
+ type: "object",
67
+ properties: {
68
+ avoidQuotes: {
69
+ type: "boolean",
70
+ },
71
+ },
72
+ additionalProperties: false,
73
+ },
74
+ ],
75
+ minItems: 0,
76
+ maxItems: 2,
77
+ },
78
+ {
79
+ type: "array",
80
+ items: [
81
+ {
82
+ enum: ["always", "methods"],
83
+ },
84
+ {
85
+ type: "object",
86
+ properties: {
87
+ ignoreConstructors: {
88
+ type: "boolean",
89
+ },
90
+ methodsIgnorePattern: {
91
+ type: "string",
92
+ },
93
+ avoidQuotes: {
94
+ type: "boolean",
95
+ },
96
+ avoidExplicitReturnArrows: {
97
+ type: "boolean",
98
+ },
99
+ },
100
+ additionalProperties: false,
101
+ },
102
+ ],
103
+ minItems: 0,
104
+ maxItems: 2,
105
+ },
106
+ ],
107
+ },
108
+
109
+ messages: {
110
+ expectedAllPropertiesShorthanded:
111
+ "Expected shorthand for all properties.",
112
+ expectedLiteralMethodLongform:
113
+ "Expected longform method syntax for string literal keys.",
114
+ expectedPropertyShorthand: "Expected property shorthand.",
115
+ expectedPropertyLongform: "Expected longform property syntax.",
116
+ expectedMethodShorthand: "Expected method shorthand.",
117
+ expectedMethodLongform: "Expected longform method syntax.",
118
+ unexpectedMix:
119
+ "Unexpected mix of shorthand and non-shorthand properties.",
120
+ },
121
+ },
122
+
123
+ create(context) {
124
+ const APPLY = context.options[0] || OPTIONS.always;
125
+ const APPLY_TO_METHODS =
126
+ APPLY === OPTIONS.methods || APPLY === OPTIONS.always;
127
+ const APPLY_TO_PROPS =
128
+ APPLY === OPTIONS.properties || APPLY === OPTIONS.always;
129
+ const APPLY_NEVER = APPLY === OPTIONS.never;
130
+ const APPLY_CONSISTENT = APPLY === OPTIONS.consistent;
131
+ const APPLY_CONSISTENT_AS_NEEDED = APPLY === OPTIONS.consistentAsNeeded;
132
+
133
+ const PARAMS = context.options[1] || {};
134
+ const IGNORE_CONSTRUCTORS = PARAMS.ignoreConstructors;
135
+ const METHODS_IGNORE_PATTERN = PARAMS.methodsIgnorePattern
136
+ ? new RegExp(PARAMS.methodsIgnorePattern, "u")
137
+ : null;
138
+ const AVOID_QUOTES = PARAMS.avoidQuotes;
139
+ const AVOID_EXPLICIT_RETURN_ARROWS = !!PARAMS.avoidExplicitReturnArrows;
140
+ const sourceCode = context.sourceCode;
141
+
142
+ //--------------------------------------------------------------------------
143
+ // Helpers
144
+ //--------------------------------------------------------------------------
145
+
146
+ const CTOR_PREFIX_REGEX = /[^_$0-9]/u;
147
+
148
+ /**
149
+ * Determines if the first character of the name is a capital letter.
150
+ * @param {string} name The name of the node to evaluate.
151
+ * @returns {boolean} True if the first character of the property name is a capital letter, false if not.
152
+ * @private
153
+ */
154
+ function isConstructor(name) {
155
+ const match = CTOR_PREFIX_REGEX.exec(name);
156
+
157
+ // Not a constructor if name has no characters apart from '_', '$' and digits e.g. '_', '$$', '_8'
158
+ if (!match) {
159
+ return false;
160
+ }
161
+
162
+ const firstChar = name.charAt(match.index);
163
+
164
+ return firstChar === firstChar.toUpperCase();
165
+ }
166
+
167
+ /**
168
+ * Determines if the property can have a shorthand form.
169
+ * @param {ASTNode} property Property AST node
170
+ * @returns {boolean} True if the property can have a shorthand form
171
+ * @private
172
+ */
173
+ function canHaveShorthand(property) {
174
+ return (
175
+ property.kind !== "set" &&
176
+ property.kind !== "get" &&
177
+ property.type !== "SpreadElement" &&
178
+ property.type !== "SpreadProperty" &&
179
+ property.type !== "ExperimentalSpreadProperty"
180
+ );
181
+ }
182
+
183
+ /**
184
+ * Checks whether a node is a string literal.
185
+ * @param {ASTNode} node Any AST node.
186
+ * @returns {boolean} `true` if it is a string literal.
187
+ */
188
+ function isStringLiteral(node) {
189
+ return node.type === "Literal" && typeof node.value === "string";
190
+ }
191
+
192
+ /**
193
+ * Determines if the property is a shorthand or not.
194
+ * @param {ASTNode} property Property AST node
195
+ * @returns {boolean} True if the property is considered shorthand, false if not.
196
+ * @private
197
+ */
198
+ function isShorthand(property) {
199
+ // property.method is true when `{a(){}}`.
200
+ return property.shorthand || property.method;
201
+ }
202
+
203
+ /**
204
+ * Determines if the property's key and method or value are named equally.
205
+ * @param {ASTNode} property Property AST node
206
+ * @returns {boolean} True if the key and value are named equally, false if not.
207
+ * @private
208
+ */
209
+ function isRedundant(property) {
210
+ const value = property.value;
211
+
212
+ if (value.type === "FunctionExpression") {
213
+ return !value.id; // Only anonymous should be shorthand method.
214
+ }
215
+ if (value.type === "Identifier") {
216
+ return astUtils.getStaticPropertyName(property) === value.name;
217
+ }
218
+
219
+ return false;
220
+ }
221
+
222
+ /**
223
+ * Ensures that an object's properties are consistently shorthand, or not shorthand at all.
224
+ * @param {ASTNode} node Property AST node
225
+ * @param {boolean} checkRedundancy Whether to check longform redundancy
226
+ * @returns {void}
227
+ */
228
+ function checkConsistency(node, checkRedundancy) {
229
+ // We are excluding getters/setters and spread properties as they are considered neither longform nor shorthand.
230
+ const properties = node.properties.filter(canHaveShorthand);
231
+
232
+ // Do we still have properties left after filtering the getters and setters?
233
+ if (properties.length > 0) {
234
+ const shorthandProperties = properties.filter(isShorthand);
235
+
236
+ /*
237
+ * If we do not have an equal number of longform properties as
238
+ * shorthand properties, we are using the annotations inconsistently
239
+ */
240
+ if (shorthandProperties.length !== properties.length) {
241
+ // We have at least 1 shorthand property
242
+ if (shorthandProperties.length > 0) {
243
+ context.report({ node, messageId: "unexpectedMix" });
244
+ } else if (checkRedundancy) {
245
+ /*
246
+ * If all properties of the object contain a method or value with a name matching it's key,
247
+ * all the keys are redundant.
248
+ */
249
+ const canAlwaysUseShorthand =
250
+ properties.every(isRedundant);
251
+
252
+ if (canAlwaysUseShorthand) {
253
+ context.report({
254
+ node,
255
+ messageId: "expectedAllPropertiesShorthanded",
256
+ });
257
+ }
258
+ }
259
+ }
260
+ }
261
+ }
262
+
263
+ /**
264
+ * Fixes a FunctionExpression node by making it into a shorthand property.
265
+ * @param {SourceCodeFixer} fixer The fixer object
266
+ * @param {ASTNode} node A `Property` node that has a `FunctionExpression` or `ArrowFunctionExpression` as its value
267
+ * @returns {Object} A fix for this node
268
+ */
269
+ function makeFunctionShorthand(fixer, node) {
270
+ const firstKeyToken = node.computed
271
+ ? sourceCode.getFirstToken(node, astUtils.isOpeningBracketToken)
272
+ : sourceCode.getFirstToken(node.key);
273
+ const lastKeyToken = node.computed
274
+ ? sourceCode.getFirstTokenBetween(
275
+ node.key,
276
+ node.value,
277
+ astUtils.isClosingBracketToken,
278
+ )
279
+ : sourceCode.getLastToken(node.key);
280
+ const keyText = sourceCode.text.slice(
281
+ firstKeyToken.range[0],
282
+ lastKeyToken.range[1],
283
+ );
284
+ let keyPrefix = "";
285
+
286
+ // key: /* */ () => {}
287
+ if (sourceCode.commentsExistBetween(lastKeyToken, node.value)) {
288
+ return null;
289
+ }
290
+
291
+ if (node.value.async) {
292
+ keyPrefix += "async ";
293
+ }
294
+ if (node.value.generator) {
295
+ keyPrefix += "*";
296
+ }
297
+
298
+ const fixRange = [firstKeyToken.range[0], node.range[1]];
299
+ const methodPrefix = keyPrefix + keyText;
300
+
301
+ if (node.value.type === "FunctionExpression") {
302
+ const functionToken = sourceCode
303
+ .getTokens(node.value)
304
+ .find(
305
+ token =>
306
+ token.type === "Keyword" &&
307
+ token.value === "function",
308
+ );
309
+ const tokenBeforeParams = node.value.generator
310
+ ? sourceCode.getTokenAfter(functionToken)
311
+ : functionToken;
312
+
313
+ return fixer.replaceTextRange(
314
+ fixRange,
315
+ methodPrefix +
316
+ sourceCode.text.slice(
317
+ tokenBeforeParams.range[1],
318
+ node.value.range[1],
319
+ ),
320
+ );
321
+ }
322
+
323
+ const arrowToken = sourceCode.getTokenBefore(
324
+ node.value.body,
325
+ astUtils.isArrowToken,
326
+ );
327
+ const fnBody = sourceCode.text.slice(
328
+ arrowToken.range[1],
329
+ node.value.range[1],
330
+ );
331
+
332
+ // First token should not be `async`
333
+ const firstValueToken = sourceCode.getFirstToken(node.value, {
334
+ skip: node.value.async ? 1 : 0,
335
+ });
336
+
337
+ const sliceStart = firstValueToken.range[0];
338
+ const sliceEnd = sourceCode.getTokenBefore(arrowToken).range[1];
339
+ const shouldAddParens =
340
+ node.value.params.length === 1 &&
341
+ node.value.params[0].range[0] === sliceStart;
342
+
343
+ const oldParamText = sourceCode.text.slice(sliceStart, sliceEnd);
344
+ const newParamText = shouldAddParens
345
+ ? `(${oldParamText})`
346
+ : oldParamText;
347
+
348
+ return fixer.replaceTextRange(
349
+ fixRange,
350
+ methodPrefix + newParamText + fnBody,
351
+ );
352
+ }
353
+
354
+ /**
355
+ * Fixes a FunctionExpression node by making it into a longform property.
356
+ * @param {SourceCodeFixer} fixer The fixer object
357
+ * @param {ASTNode} node A `Property` node that has a `FunctionExpression` as its value
358
+ * @returns {Object} A fix for this node
359
+ */
360
+ function makeFunctionLongform(fixer, node) {
361
+ const firstKeyToken = node.computed
362
+ ? sourceCode.getTokens(node).find(token => token.value === "[")
363
+ : sourceCode.getFirstToken(node.key);
364
+ const lastKeyToken = node.computed
365
+ ? sourceCode
366
+ .getTokensBetween(node.key, node.value)
367
+ .find(token => token.value === "]")
368
+ : sourceCode.getLastToken(node.key);
369
+ const keyText = sourceCode.text.slice(
370
+ firstKeyToken.range[0],
371
+ lastKeyToken.range[1],
372
+ );
373
+ let functionHeader = "function";
374
+
375
+ if (node.value.async) {
376
+ functionHeader = `async ${functionHeader}`;
377
+ }
378
+ if (node.value.generator) {
379
+ functionHeader = `${functionHeader}*`;
380
+ }
381
+
382
+ return fixer.replaceTextRange(
383
+ [node.range[0], lastKeyToken.range[1]],
384
+ `${keyText}: ${functionHeader}`,
385
+ );
386
+ }
387
+
388
+ /*
389
+ * To determine whether a given arrow function has a lexical identifier (`this`, `arguments`, `super`, or `new.target`),
390
+ * create a stack of functions that define these identifiers (i.e. all functions except arrow functions) as the AST is
391
+ * traversed. Whenever a new function is encountered, create a new entry on the stack (corresponding to a different lexical
392
+ * scope of `this`), and whenever a function is exited, pop that entry off the stack. When an arrow function is entered,
393
+ * keep a reference to it on the current stack entry, and remove that reference when the arrow function is exited.
394
+ * When a lexical identifier is encountered, mark all the arrow functions on the current stack entry by adding them
395
+ * to an `arrowsWithLexicalIdentifiers` set. Any arrow function in that set will not be reported by this rule,
396
+ * because converting it into a method would change the value of one of the lexical identifiers.
397
+ */
398
+ const lexicalScopeStack = [];
399
+ const arrowsWithLexicalIdentifiers = new WeakSet();
400
+ const argumentsIdentifiers = new WeakSet();
401
+
402
+ /**
403
+ * Enters a function. This creates a new lexical identifier scope, so a new Set of arrow functions is pushed onto the stack.
404
+ * Also, this marks all `arguments` identifiers so that they can be detected later.
405
+ * @param {ASTNode} node The node representing the function.
406
+ * @returns {void}
407
+ */
408
+ function enterFunction(node) {
409
+ lexicalScopeStack.unshift(new Set());
410
+ sourceCode
411
+ .getScope(node)
412
+ .variables.filter(variable => variable.name === "arguments")
413
+ .forEach(variable => {
414
+ variable.references
415
+ .map(ref => ref.identifier)
416
+ .forEach(identifier =>
417
+ argumentsIdentifiers.add(identifier),
418
+ );
419
+ });
420
+ }
421
+
422
+ /**
423
+ * Exits a function. This pops the current set of arrow functions off the lexical scope stack.
424
+ * @returns {void}
425
+ */
426
+ function exitFunction() {
427
+ lexicalScopeStack.shift();
428
+ }
429
+
430
+ /**
431
+ * Marks the current function as having a lexical keyword. This implies that all arrow functions
432
+ * in the current lexical scope contain a reference to this lexical keyword.
433
+ * @returns {void}
434
+ */
435
+ function reportLexicalIdentifier() {
436
+ lexicalScopeStack[0].forEach(arrowFunction =>
437
+ arrowsWithLexicalIdentifiers.add(arrowFunction),
438
+ );
439
+ }
440
+
441
+ //--------------------------------------------------------------------------
442
+ // Public
443
+ //--------------------------------------------------------------------------
444
+
445
+ return {
446
+ Program: enterFunction,
447
+ FunctionDeclaration: enterFunction,
448
+ FunctionExpression: enterFunction,
449
+ "Program:exit": exitFunction,
450
+ "FunctionDeclaration:exit": exitFunction,
451
+ "FunctionExpression:exit": exitFunction,
452
+
453
+ ArrowFunctionExpression(node) {
454
+ lexicalScopeStack[0].add(node);
455
+ },
456
+ "ArrowFunctionExpression:exit"(node) {
457
+ lexicalScopeStack[0].delete(node);
458
+ },
459
+
460
+ ThisExpression: reportLexicalIdentifier,
461
+ Super: reportLexicalIdentifier,
462
+ MetaProperty(node) {
463
+ if (
464
+ node.meta.name === "new" &&
465
+ node.property.name === "target"
466
+ ) {
467
+ reportLexicalIdentifier();
468
+ }
469
+ },
470
+ Identifier(node) {
471
+ if (argumentsIdentifiers.has(node)) {
472
+ reportLexicalIdentifier();
473
+ }
474
+ },
475
+
476
+ ObjectExpression(node) {
477
+ if (APPLY_CONSISTENT) {
478
+ checkConsistency(node, false);
479
+ } else if (APPLY_CONSISTENT_AS_NEEDED) {
480
+ checkConsistency(node, true);
481
+ }
482
+ },
483
+
484
+ "Property:exit"(node) {
485
+ const isConciseProperty = node.method || node.shorthand;
486
+
487
+ // Ignore destructuring assignment
488
+ if (node.parent.type === "ObjectPattern") {
489
+ return;
490
+ }
491
+
492
+ // getters and setters are ignored
493
+ if (node.kind === "get" || node.kind === "set") {
494
+ return;
495
+ }
496
+
497
+ // only computed methods can fail the following checks
498
+ if (
499
+ node.computed &&
500
+ node.value.type !== "FunctionExpression" &&
501
+ node.value.type !== "ArrowFunctionExpression"
502
+ ) {
503
+ return;
504
+ }
505
+
506
+ //--------------------------------------------------------------
507
+ // Checks for property/method shorthand.
508
+ if (isConciseProperty) {
509
+ if (
510
+ node.method &&
511
+ (APPLY_NEVER ||
512
+ (AVOID_QUOTES && isStringLiteral(node.key)))
513
+ ) {
514
+ const messageId = APPLY_NEVER
515
+ ? "expectedMethodLongform"
516
+ : "expectedLiteralMethodLongform";
517
+
518
+ // { x() {} } should be written as { x: function() {} }
519
+ context.report({
520
+ node,
521
+ messageId,
522
+ fix: fixer => makeFunctionLongform(fixer, node),
523
+ });
524
+ } else if (APPLY_NEVER) {
525
+ // { x } should be written as { x: x }
526
+ context.report({
527
+ node,
528
+ messageId: "expectedPropertyLongform",
529
+ fix: fixer =>
530
+ fixer.insertTextAfter(
531
+ node.key,
532
+ `: ${node.key.name}`,
533
+ ),
534
+ });
535
+ }
536
+ } else if (
537
+ APPLY_TO_METHODS &&
538
+ !node.value.id &&
539
+ (node.value.type === "FunctionExpression" ||
540
+ node.value.type === "ArrowFunctionExpression")
541
+ ) {
542
+ if (
543
+ IGNORE_CONSTRUCTORS &&
544
+ node.key.type === "Identifier" &&
545
+ isConstructor(node.key.name)
546
+ ) {
547
+ return;
548
+ }
549
+
550
+ if (METHODS_IGNORE_PATTERN) {
551
+ const propertyName =
552
+ astUtils.getStaticPropertyName(node);
553
+
554
+ if (
555
+ propertyName !== null &&
556
+ METHODS_IGNORE_PATTERN.test(propertyName)
557
+ ) {
558
+ return;
559
+ }
560
+ }
561
+
562
+ if (AVOID_QUOTES && isStringLiteral(node.key)) {
563
+ return;
564
+ }
565
+
566
+ // {[x]: function(){}} should be written as {[x]() {}}
567
+ if (
568
+ node.value.type === "FunctionExpression" ||
569
+ (node.value.type === "ArrowFunctionExpression" &&
570
+ node.value.body.type === "BlockStatement" &&
571
+ AVOID_EXPLICIT_RETURN_ARROWS &&
572
+ !arrowsWithLexicalIdentifiers.has(node.value))
573
+ ) {
574
+ context.report({
575
+ node,
576
+ messageId: "expectedMethodShorthand",
577
+ fix: fixer => makeFunctionShorthand(fixer, node),
578
+ });
579
+ }
580
+ } else if (
581
+ node.value.type === "Identifier" &&
582
+ node.key.name === node.value.name &&
583
+ APPLY_TO_PROPS
584
+ ) {
585
+ // {x: x} should be written as {x}
586
+ context.report({
587
+ node,
588
+ messageId: "expectedPropertyShorthand",
589
+ fix(fixer) {
590
+ // x: /* */ x
591
+ // x: (/* */ x)
592
+ if (sourceCode.getCommentsInside(node).length > 0) {
593
+ return null;
594
+ }
595
+
596
+ return fixer.replaceText(node, node.value.name);
597
+ },
598
+ });
599
+ } else if (
600
+ node.value.type === "Identifier" &&
601
+ node.key.type === "Literal" &&
602
+ node.key.value === node.value.name &&
603
+ APPLY_TO_PROPS
604
+ ) {
605
+ if (AVOID_QUOTES) {
606
+ return;
607
+ }
608
+
609
+ // {"x": x} should be written as {x}
610
+ context.report({
611
+ node,
612
+ messageId: "expectedPropertyShorthand",
613
+ fix(fixer) {
614
+ // "x": /* */ x
615
+ // "x": (/* */ x)
616
+ if (sourceCode.getCommentsInside(node).length > 0) {
617
+ return null;
618
+ }
619
+
620
+ return fixer.replaceText(node, node.value.name);
621
+ },
622
+ });
623
+ }
624
+ },
625
+ };
626
+ },
522
627
  };