eslint 9.21.0 → 9.23.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.
- package/README.md +52 -48
- package/bin/eslint.js +92 -90
- package/conf/default-cli-options.js +22 -22
- package/conf/ecma-version.js +1 -1
- package/conf/globals.js +97 -98
- package/conf/replacements.json +24 -20
- package/conf/rule-type-list.json +88 -92
- package/lib/api.js +12 -12
- package/lib/cli-engine/cli-engine.js +828 -808
- package/lib/cli-engine/file-enumerator.js +381 -387
- package/lib/cli-engine/formatters/formatters-meta.json +16 -16
- package/lib/cli-engine/formatters/html.js +107 -99
- package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
- package/lib/cli-engine/formatters/json.js +2 -2
- package/lib/cli-engine/formatters/stylish.js +96 -75
- package/lib/cli-engine/hash.js +1 -1
- package/lib/cli-engine/index.js +1 -1
- package/lib/cli-engine/lint-result-cache.js +144 -145
- package/lib/cli-engine/load-rules.js +16 -16
- package/lib/cli.js +541 -457
- package/lib/config/config-loader.js +648 -618
- package/lib/config/config.js +247 -221
- package/lib/config/default-config.js +54 -45
- package/lib/config/flat-config-array.js +167 -172
- package/lib/config/flat-config-helpers.js +65 -68
- package/lib/config/flat-config-schema.js +375 -368
- package/lib/config/rule-validator.js +139 -144
- package/lib/config-api.js +12 -0
- package/lib/eslint/eslint-helpers.js +709 -679
- package/lib/eslint/eslint.js +944 -886
- package/lib/eslint/index.js +2 -2
- package/lib/eslint/legacy-eslint.js +576 -532
- package/lib/languages/js/index.js +263 -264
- package/lib/languages/js/source-code/index.js +1 -1
- package/lib/languages/js/source-code/source-code.js +1129 -1054
- package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
- package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
- package/lib/languages/js/source-code/token-store/cursor.js +36 -36
- package/lib/languages/js/source-code/token-store/cursors.js +80 -52
- package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
- package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
- package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
- package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
- package/lib/languages/js/source-code/token-store/index.js +592 -498
- package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
- package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
- package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
- package/lib/languages/js/source-code/token-store/utils.js +63 -60
- package/lib/languages/js/validate-language-options.js +104 -89
- package/lib/linter/apply-disable-directives.js +467 -383
- package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
- package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
- package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
- package/lib/linter/code-path-analysis/code-path.js +307 -319
- package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
- package/lib/linter/code-path-analysis/fork-context.js +296 -271
- package/lib/linter/code-path-analysis/id-generator.js +22 -23
- package/lib/linter/file-context.js +119 -120
- package/lib/linter/index.js +3 -3
- package/lib/linter/interpolate.js +16 -16
- package/lib/linter/linter.js +2402 -2044
- package/lib/linter/node-event-generator.js +284 -225
- package/lib/linter/report-translator.js +256 -219
- package/lib/linter/rule-fixer.js +122 -124
- package/lib/linter/rules.js +35 -35
- package/lib/linter/safe-emitter.js +18 -18
- package/lib/linter/source-code-fixer.js +94 -92
- package/lib/linter/timing.js +104 -101
- package/lib/linter/vfile.js +70 -73
- package/lib/options.js +375 -361
- package/lib/rule-tester/index.js +1 -1
- package/lib/rule-tester/rule-tester.js +1307 -1045
- package/lib/rules/accessor-pairs.js +297 -262
- package/lib/rules/array-bracket-newline.js +249 -237
- package/lib/rules/array-bracket-spacing.js +262 -223
- package/lib/rules/array-callback-return.js +401 -355
- package/lib/rules/array-element-newline.js +357 -312
- package/lib/rules/arrow-body-style.js +399 -280
- package/lib/rules/arrow-parens.js +205 -172
- package/lib/rules/arrow-spacing.js +168 -162
- package/lib/rules/block-scoped-var.js +124 -122
- package/lib/rules/block-spacing.js +185 -175
- package/lib/rules/brace-style.js +261 -198
- package/lib/rules/callback-return.js +202 -189
- package/lib/rules/camelcase.js +402 -391
- package/lib/rules/capitalized-comments.js +252 -231
- package/lib/rules/class-methods-use-this.js +179 -171
- package/lib/rules/comma-dangle.js +378 -345
- package/lib/rules/comma-spacing.js +192 -194
- package/lib/rules/comma-style.js +374 -315
- package/lib/rules/complexity.js +172 -168
- package/lib/rules/computed-property-spacing.js +235 -210
- package/lib/rules/consistent-return.js +180 -169
- package/lib/rules/consistent-this.js +166 -146
- package/lib/rules/constructor-super.js +411 -403
- package/lib/rules/curly.js +406 -331
- package/lib/rules/default-case-last.js +37 -30
- package/lib/rules/default-case.js +88 -84
- package/lib/rules/default-param-last.js +68 -53
- package/lib/rules/dot-location.js +121 -109
- package/lib/rules/dot-notation.js +191 -155
- package/lib/rules/eol-last.js +121 -119
- package/lib/rules/eqeqeq.js +167 -154
- package/lib/rules/for-direction.js +145 -120
- package/lib/rules/func-call-spacing.js +260 -230
- package/lib/rules/func-name-matching.js +292 -208
- package/lib/rules/func-names.js +164 -163
- package/lib/rules/func-style.js +158 -126
- package/lib/rules/function-call-argument-newline.js +151 -128
- package/lib/rules/function-paren-newline.js +348 -290
- package/lib/rules/generator-star-spacing.js +228 -209
- package/lib/rules/getter-return.js +207 -171
- package/lib/rules/global-require.js +84 -73
- package/lib/rules/grouped-accessor-pairs.js +169 -149
- package/lib/rules/guard-for-in.js +71 -62
- package/lib/rules/handle-callback-err.js +107 -102
- package/lib/rules/id-blacklist.js +181 -198
- package/lib/rules/id-denylist.js +167 -186
- package/lib/rules/id-length.js +196 -170
- package/lib/rules/id-match.js +343 -288
- package/lib/rules/implicit-arrow-linebreak.js +101 -78
- package/lib/rules/indent-legacy.js +1343 -1117
- package/lib/rules/indent.js +2271 -1758
- package/lib/rules/index.js +317 -292
- package/lib/rules/init-declarations.js +115 -106
- package/lib/rules/jsx-quotes.js +93 -81
- package/lib/rules/key-spacing.js +749 -632
- package/lib/rules/keyword-spacing.js +647 -604
- package/lib/rules/line-comment-position.js +141 -127
- package/lib/rules/linebreak-style.js +106 -105
- package/lib/rules/lines-around-comment.js +539 -447
- package/lib/rules/lines-around-directive.js +232 -202
- package/lib/rules/lines-between-class-members.js +304 -233
- package/lib/rules/logical-assignment-operators.js +581 -398
- package/lib/rules/max-classes-per-file.js +68 -67
- package/lib/rules/max-depth.js +145 -142
- package/lib/rules/max-len.js +472 -433
- package/lib/rules/max-lines-per-function.js +200 -175
- package/lib/rules/max-lines.js +157 -161
- package/lib/rules/max-nested-callbacks.js +101 -103
- package/lib/rules/max-params.js +77 -75
- package/lib/rules/max-statements-per-line.js +204 -197
- package/lib/rules/max-statements.js +167 -163
- package/lib/rules/multiline-comment-style.js +636 -478
- package/lib/rules/multiline-ternary.js +240 -175
- package/lib/rules/new-cap.js +232 -212
- package/lib/rules/new-parens.js +87 -78
- package/lib/rules/newline-after-var.js +286 -249
- package/lib/rules/newline-before-return.js +228 -221
- package/lib/rules/newline-per-chained-call.js +141 -126
- package/lib/rules/no-alert.js +89 -78
- package/lib/rules/no-array-constructor.js +121 -112
- package/lib/rules/no-async-promise-executor.js +29 -23
- package/lib/rules/no-await-in-loop.js +68 -70
- package/lib/rules/no-bitwise.js +123 -99
- package/lib/rules/no-buffer-constructor.js +54 -46
- package/lib/rules/no-caller.js +38 -32
- package/lib/rules/no-case-declarations.js +60 -56
- package/lib/rules/no-catch-shadow.js +75 -72
- package/lib/rules/no-class-assign.js +50 -47
- package/lib/rules/no-compare-neg-zero.js +61 -47
- package/lib/rules/no-cond-assign.js +147 -131
- package/lib/rules/no-confusing-arrow.js +97 -80
- package/lib/rules/no-console.js +201 -190
- package/lib/rules/no-const-assign.js +46 -40
- package/lib/rules/no-constant-binary-expression.js +499 -404
- package/lib/rules/no-constant-condition.js +157 -142
- package/lib/rules/no-constructor-return.js +48 -48
- package/lib/rules/no-continue.js +24 -26
- package/lib/rules/no-control-regex.js +124 -120
- package/lib/rules/no-debugger.js +27 -29
- package/lib/rules/no-delete-var.js +28 -28
- package/lib/rules/no-div-regex.js +46 -40
- package/lib/rules/no-dupe-args.js +67 -68
- package/lib/rules/no-dupe-class-members.js +92 -88
- package/lib/rules/no-dupe-else-if.js +99 -76
- package/lib/rules/no-dupe-keys.js +132 -109
- package/lib/rules/no-duplicate-case.js +49 -42
- package/lib/rules/no-duplicate-imports.js +178 -175
- package/lib/rules/no-else-return.js +429 -384
- package/lib/rules/no-empty-character-class.js +56 -49
- package/lib/rules/no-empty-function.js +126 -127
- package/lib/rules/no-empty-pattern.js +62 -57
- package/lib/rules/no-empty-static-block.js +36 -34
- package/lib/rules/no-empty.js +97 -85
- package/lib/rules/no-eq-null.js +36 -31
- package/lib/rules/no-eval.js +255 -249
- package/lib/rules/no-ex-assign.js +41 -38
- package/lib/rules/no-extend-native.js +160 -158
- package/lib/rules/no-extra-bind.js +200 -189
- package/lib/rules/no-extra-boolean-cast.js +397 -347
- package/lib/rules/no-extra-label.js +149 -130
- package/lib/rules/no-extra-parens.js +1653 -1324
- package/lib/rules/no-extra-semi.js +145 -143
- package/lib/rules/no-fallthrough.js +198 -156
- package/lib/rules/no-floating-decimal.js +73 -65
- package/lib/rules/no-func-assign.js +53 -54
- package/lib/rules/no-global-assign.js +77 -72
- package/lib/rules/no-implicit-coercion.js +348 -292
- package/lib/rules/no-implicit-globals.js +157 -134
- package/lib/rules/no-implied-eval.js +139 -111
- package/lib/rules/no-import-assign.js +144 -158
- package/lib/rules/no-inline-comments.js +100 -94
- package/lib/rules/no-inner-declarations.js +114 -100
- package/lib/rules/no-invalid-regexp.js +221 -189
- package/lib/rules/no-invalid-this.js +122 -116
- package/lib/rules/no-irregular-whitespace.js +265 -251
- package/lib/rules/no-iterator.js +28 -32
- package/lib/rules/no-label-var.js +58 -61
- package/lib/rules/no-labels.js +137 -132
- package/lib/rules/no-lone-blocks.js +126 -122
- package/lib/rules/no-lonely-if.js +107 -76
- package/lib/rules/no-loop-func.js +233 -212
- package/lib/rules/no-loss-of-precision.js +215 -200
- package/lib/rules/no-magic-numbers.js +245 -217
- package/lib/rules/no-misleading-character-class.js +498 -445
- package/lib/rules/no-mixed-operators.js +187 -181
- package/lib/rules/no-mixed-requires.js +252 -239
- package/lib/rules/no-mixed-spaces-and-tabs.js +133 -120
- package/lib/rules/no-multi-assign.js +45 -43
- package/lib/rules/no-multi-spaces.js +162 -142
- package/lib/rules/no-multi-str.js +41 -40
- package/lib/rules/no-multiple-empty-lines.js +195 -157
- package/lib/rules/no-native-reassign.js +89 -84
- package/lib/rules/no-negated-condition.js +78 -74
- package/lib/rules/no-negated-in-lhs.js +44 -42
- package/lib/rules/no-nested-ternary.js +32 -31
- package/lib/rules/no-new-func.js +70 -61
- package/lib/rules/no-new-native-nonconstructor.js +42 -38
- package/lib/rules/no-new-object.js +47 -47
- package/lib/rules/no-new-require.js +47 -46
- package/lib/rules/no-new-symbol.js +51 -49
- package/lib/rules/no-new-wrappers.js +42 -40
- package/lib/rules/no-new.js +27 -28
- package/lib/rules/no-nonoctal-decimal-escape.js +140 -120
- package/lib/rules/no-obj-calls.js +65 -52
- package/lib/rules/no-object-constructor.js +103 -96
- package/lib/rules/no-octal-escape.js +39 -42
- package/lib/rules/no-octal.js +31 -31
- package/lib/rules/no-param-reassign.js +234 -216
- package/lib/rules/no-path-concat.js +65 -66
- package/lib/rules/no-plusplus.js +59 -60
- package/lib/rules/no-process-env.js +48 -47
- package/lib/rules/no-process-exit.js +53 -49
- package/lib/rules/no-promise-executor-return.js +213 -181
- package/lib/rules/no-proto.js +25 -28
- package/lib/rules/no-prototype-builtins.js +145 -123
- package/lib/rules/no-redeclare.js +153 -151
- package/lib/rules/no-regex-spaces.js +182 -160
- package/lib/rules/no-restricted-exports.js +207 -184
- package/lib/rules/no-restricted-globals.js +110 -111
- package/lib/rules/no-restricted-imports.js +656 -536
- package/lib/rules/no-restricted-modules.js +221 -201
- package/lib/rules/no-restricted-properties.js +180 -152
- package/lib/rules/no-restricted-syntax.js +55 -51
- package/lib/rules/no-return-assign.js +54 -49
- package/lib/rules/no-return-await.js +147 -123
- package/lib/rules/no-script-url.js +51 -44
- package/lib/rules/no-self-assign.js +147 -145
- package/lib/rules/no-self-compare.js +62 -45
- package/lib/rules/no-sequences.js +134 -115
- package/lib/rules/no-setter-return.js +184 -151
- package/lib/rules/no-shadow-restricted-names.js +60 -45
- package/lib/rules/no-shadow.js +341 -315
- package/lib/rules/no-spaced-func.js +81 -76
- package/lib/rules/no-sparse-arrays.js +53 -58
- package/lib/rules/no-sync.js +60 -59
- package/lib/rules/no-tabs.js +82 -71
- package/lib/rules/no-template-curly-in-string.js +32 -31
- package/lib/rules/no-ternary.js +24 -28
- package/lib/rules/no-this-before-super.js +320 -318
- package/lib/rules/no-throw-literal.js +30 -35
- package/lib/rules/no-trailing-spaces.js +198 -190
- package/lib/rules/no-undef-init.js +75 -60
- package/lib/rules/no-undef.js +50 -47
- package/lib/rules/no-undefined.js +72 -74
- package/lib/rules/no-underscore-dangle.js +369 -326
- package/lib/rules/no-unexpected-multiline.js +111 -101
- package/lib/rules/no-unmodified-loop-condition.js +253 -253
- package/lib/rules/no-unneeded-ternary.js +211 -146
- package/lib/rules/no-unreachable-loop.js +144 -141
- package/lib/rules/no-unreachable.js +254 -247
- package/lib/rules/no-unsafe-finally.js +92 -84
- package/lib/rules/no-unsafe-negation.js +104 -82
- package/lib/rules/no-unsafe-optional-chaining.js +191 -177
- package/lib/rules/no-unused-expressions.js +177 -161
- package/lib/rules/no-unused-labels.js +138 -123
- package/lib/rules/no-unused-private-class-members.js +205 -181
- package/lib/rules/no-unused-vars.js +1668 -1448
- package/lib/rules/no-use-before-define.js +228 -230
- package/lib/rules/no-useless-assignment.js +589 -510
- package/lib/rules/no-useless-backreference.js +211 -192
- package/lib/rules/no-useless-call.js +57 -52
- package/lib/rules/no-useless-catch.js +39 -39
- package/lib/rules/no-useless-computed-key.js +143 -114
- package/lib/rules/no-useless-concat.js +64 -59
- package/lib/rules/no-useless-constructor.js +157 -110
- package/lib/rules/no-useless-escape.js +341 -290
- package/lib/rules/no-useless-rename.js +182 -155
- package/lib/rules/no-useless-return.js +343 -311
- package/lib/rules/no-var.js +232 -211
- package/lib/rules/no-void.js +49 -47
- package/lib/rules/no-warning-comments.js +190 -185
- package/lib/rules/no-whitespace-before-property.js +130 -114
- package/lib/rules/no-with.js +23 -25
- package/lib/rules/nonblock-statement-body-position.js +148 -129
- package/lib/rules/object-curly-newline.js +305 -264
- package/lib/rules/object-curly-spacing.js +359 -313
- package/lib/rules/object-property-newline.js +136 -105
- package/lib/rules/object-shorthand.js +606 -501
- package/lib/rules/one-var-declaration-per-line.js +103 -99
- package/lib/rules/one-var.js +652 -536
- package/lib/rules/operator-assignment.js +218 -160
- package/lib/rules/operator-linebreak.js +294 -250
- package/lib/rules/padded-blocks.js +345 -307
- package/lib/rules/padding-line-between-statements.js +442 -438
- package/lib/rules/prefer-arrow-callback.js +361 -312
- package/lib/rules/prefer-const.js +417 -376
- package/lib/rules/prefer-destructuring.js +300 -278
- package/lib/rules/prefer-exponentiation-operator.js +175 -132
- package/lib/rules/prefer-named-capture-group.js +152 -139
- package/lib/rules/prefer-numeric-literals.js +120 -112
- package/lib/rules/prefer-object-has-own.js +115 -81
- package/lib/rules/prefer-object-spread.js +212 -192
- package/lib/rules/prefer-promise-reject-errors.js +139 -121
- package/lib/rules/prefer-reflect.js +126 -106
- package/lib/rules/prefer-regex-literals.js +577 -465
- package/lib/rules/prefer-rest-params.js +78 -79
- package/lib/rules/prefer-spread.js +46 -43
- package/lib/rules/prefer-template.js +265 -194
- package/lib/rules/quote-props.js +372 -306
- package/lib/rules/quotes.js +373 -325
- package/lib/rules/radix.js +151 -135
- package/lib/rules/require-atomic-updates.js +315 -284
- package/lib/rules/require-await.js +143 -115
- package/lib/rules/require-unicode-regexp.js +281 -176
- package/lib/rules/require-yield.js +52 -53
- package/lib/rules/rest-spread-spacing.js +127 -115
- package/lib/rules/semi-spacing.js +280 -249
- package/lib/rules/semi-style.js +175 -133
- package/lib/rules/semi.js +455 -435
- package/lib/rules/sort-imports.js +305 -232
- package/lib/rules/sort-keys.js +218 -187
- package/lib/rules/sort-vars.js +126 -92
- package/lib/rules/space-before-blocks.js +198 -188
- package/lib/rules/space-before-function-paren.js +185 -165
- package/lib/rules/space-in-parens.js +358 -287
- package/lib/rules/space-infix-ops.js +236 -200
- package/lib/rules/space-unary-ops.js +355 -297
- package/lib/rules/spaced-comment.js +362 -318
- package/lib/rules/strict.js +264 -229
- package/lib/rules/switch-colon-spacing.js +129 -121
- package/lib/rules/symbol-description.js +44 -47
- package/lib/rules/template-curly-spacing.js +147 -141
- package/lib/rules/template-tag-spacing.js +97 -87
- package/lib/rules/unicode-bom.js +53 -55
- package/lib/rules/use-isnan.js +236 -205
- package/lib/rules/utils/ast-utils.js +2039 -1860
- package/lib/rules/utils/char-source.js +162 -155
- package/lib/rules/utils/fix-tracker.js +83 -80
- package/lib/rules/utils/keywords.js +59 -59
- package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
- package/lib/rules/utils/regular-expressions.js +32 -24
- package/lib/rules/utils/unicode/index.js +4 -4
- package/lib/rules/utils/unicode/is-combining-character.js +1 -1
- package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
- package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
- package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
- package/lib/rules/valid-typeof.js +152 -110
- package/lib/rules/vars-on-top.js +151 -144
- package/lib/rules/wrap-iife.js +203 -190
- package/lib/rules/wrap-regex.js +69 -57
- package/lib/rules/yield-star-spacing.js +144 -133
- package/lib/rules/yoda.js +282 -271
- package/lib/services/parser-service.js +35 -35
- package/lib/services/processor-service.js +66 -73
- package/lib/shared/ajv.js +14 -14
- package/lib/shared/assert.js +3 -4
- package/lib/shared/ast-utils.js +7 -6
- package/lib/shared/deep-merge-arrays.js +24 -22
- package/lib/shared/directives.js +3 -2
- package/lib/shared/flags.js +46 -17
- package/lib/shared/logging.js +24 -25
- package/lib/shared/option-utils.js +43 -36
- package/lib/shared/runtime-info.js +136 -127
- package/lib/shared/serialization.js +27 -27
- package/lib/shared/severity.js +22 -22
- package/lib/shared/stats.js +5 -5
- package/lib/shared/string-utils.js +16 -16
- package/lib/shared/text-table.js +28 -27
- package/lib/shared/traverser.js +153 -146
- package/lib/types/config-api.d.ts +8 -0
- package/lib/types/index.d.ts +2010 -1559
- package/lib/types/rules.d.ts +5312 -0
- package/lib/types/use-at-your-own-risk.d.ts +32 -30
- package/lib/unsupported-api.js +5 -5
- package/messages/all-files-ignored.js +3 -3
- package/messages/all-matched-files-ignored.js +3 -3
- package/messages/config-file-missing.js +2 -2
- package/messages/config-plugin-missing.js +3 -3
- package/messages/config-serialize-function.js +9 -7
- package/messages/eslintrc-incompat.js +13 -15
- package/messages/eslintrc-plugins.js +3 -4
- package/messages/extend-config-missing.js +3 -3
- package/messages/failed-to-read-json.js +3 -3
- package/messages/file-not-found.js +3 -3
- package/messages/invalid-rule-options.js +2 -2
- package/messages/invalid-rule-severity.js +2 -2
- package/messages/no-config-found.js +3 -3
- package/messages/plugin-conflict.js +8 -8
- package/messages/plugin-invalid.js +3 -3
- package/messages/plugin-missing.js +3 -3
- package/messages/print-config-with-directory-path.js +2 -2
- package/messages/shared.js +6 -1
- package/messages/whitespace-found.js +3 -3
- package/package.json +22 -20
- package/lib/types/rules/best-practices.d.ts +0 -1143
- package/lib/types/rules/deprecated.d.ts +0 -252
- package/lib/types/rules/ecmascript-6.d.ts +0 -647
- package/lib/types/rules/index.d.ts +0 -50
- package/lib/types/rules/node-commonjs.d.ts +0 -171
- package/lib/types/rules/possible-errors.d.ts +0 -685
- package/lib/types/rules/strict-mode.d.ts +0 -38
- package/lib/types/rules/stylistic-issues.d.ts +0 -2043
- package/lib/types/rules/variables.d.ts +0 -234
package/lib/rules/one-var.js
CHANGED
@@ -21,7 +21,7 @@ const astUtils = require("./utils/ast-utils");
|
|
21
21
|
* @returns {boolean} `true` if the given node is in a statement list
|
22
22
|
*/
|
23
23
|
function isInStatementList(node) {
|
24
|
-
|
24
|
+
return astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type);
|
25
25
|
}
|
26
26
|
|
27
27
|
//------------------------------------------------------------------------------
|
@@ -30,539 +30,655 @@ function isInStatementList(node) {
|
|
30
30
|
|
31
31
|
/** @type {import('../shared/types').Rule} */
|
32
32
|
module.exports = {
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
33
|
+
meta: {
|
34
|
+
type: "suggestion",
|
35
|
+
|
36
|
+
docs: {
|
37
|
+
description:
|
38
|
+
"Enforce variables to be declared either together or separately in functions",
|
39
|
+
recommended: false,
|
40
|
+
frozen: true,
|
41
|
+
url: "https://eslint.org/docs/latest/rules/one-var",
|
42
|
+
},
|
43
|
+
|
44
|
+
fixable: "code",
|
45
|
+
|
46
|
+
schema: [
|
47
|
+
{
|
48
|
+
oneOf: [
|
49
|
+
{
|
50
|
+
enum: ["always", "never", "consecutive"],
|
51
|
+
},
|
52
|
+
{
|
53
|
+
type: "object",
|
54
|
+
properties: {
|
55
|
+
separateRequires: {
|
56
|
+
type: "boolean",
|
57
|
+
},
|
58
|
+
var: {
|
59
|
+
enum: ["always", "never", "consecutive"],
|
60
|
+
},
|
61
|
+
let: {
|
62
|
+
enum: ["always", "never", "consecutive"],
|
63
|
+
},
|
64
|
+
const: {
|
65
|
+
enum: ["always", "never", "consecutive"],
|
66
|
+
},
|
67
|
+
},
|
68
|
+
additionalProperties: false,
|
69
|
+
},
|
70
|
+
{
|
71
|
+
type: "object",
|
72
|
+
properties: {
|
73
|
+
initialized: {
|
74
|
+
enum: ["always", "never", "consecutive"],
|
75
|
+
},
|
76
|
+
uninitialized: {
|
77
|
+
enum: ["always", "never", "consecutive"],
|
78
|
+
},
|
79
|
+
},
|
80
|
+
additionalProperties: false,
|
81
|
+
},
|
82
|
+
],
|
83
|
+
},
|
84
|
+
],
|
85
|
+
|
86
|
+
messages: {
|
87
|
+
combineUninitialized:
|
88
|
+
"Combine this with the previous '{{type}}' statement with uninitialized variables.",
|
89
|
+
combineInitialized:
|
90
|
+
"Combine this with the previous '{{type}}' statement with initialized variables.",
|
91
|
+
splitUninitialized:
|
92
|
+
"Split uninitialized '{{type}}' declarations into multiple statements.",
|
93
|
+
splitInitialized:
|
94
|
+
"Split initialized '{{type}}' declarations into multiple statements.",
|
95
|
+
splitRequires:
|
96
|
+
"Split requires to be separated into a single block.",
|
97
|
+
combine: "Combine this with the previous '{{type}}' statement.",
|
98
|
+
split: "Split '{{type}}' declarations into multiple statements.",
|
99
|
+
},
|
100
|
+
},
|
101
|
+
|
102
|
+
create(context) {
|
103
|
+
const MODE_ALWAYS = "always";
|
104
|
+
const MODE_NEVER = "never";
|
105
|
+
const MODE_CONSECUTIVE = "consecutive";
|
106
|
+
const mode = context.options[0] || MODE_ALWAYS;
|
107
|
+
|
108
|
+
const options = {};
|
109
|
+
|
110
|
+
if (typeof mode === "string") {
|
111
|
+
// simple options configuration with just a string
|
112
|
+
options.var = { uninitialized: mode, initialized: mode };
|
113
|
+
options.let = { uninitialized: mode, initialized: mode };
|
114
|
+
options.const = { uninitialized: mode, initialized: mode };
|
115
|
+
} else if (typeof mode === "object") {
|
116
|
+
// options configuration is an object
|
117
|
+
options.separateRequires = !!mode.separateRequires;
|
118
|
+
options.var = { uninitialized: mode.var, initialized: mode.var };
|
119
|
+
options.let = { uninitialized: mode.let, initialized: mode.let };
|
120
|
+
options.const = {
|
121
|
+
uninitialized: mode.const,
|
122
|
+
initialized: mode.const,
|
123
|
+
};
|
124
|
+
if (Object.hasOwn(mode, "uninitialized")) {
|
125
|
+
options.var.uninitialized = mode.uninitialized;
|
126
|
+
options.let.uninitialized = mode.uninitialized;
|
127
|
+
options.const.uninitialized = mode.uninitialized;
|
128
|
+
}
|
129
|
+
if (Object.hasOwn(mode, "initialized")) {
|
130
|
+
options.var.initialized = mode.initialized;
|
131
|
+
options.let.initialized = mode.initialized;
|
132
|
+
options.const.initialized = mode.initialized;
|
133
|
+
}
|
134
|
+
}
|
135
|
+
|
136
|
+
const sourceCode = context.sourceCode;
|
137
|
+
|
138
|
+
//--------------------------------------------------------------------------
|
139
|
+
// Helpers
|
140
|
+
//--------------------------------------------------------------------------
|
141
|
+
|
142
|
+
const functionStack = [];
|
143
|
+
const blockStack = [];
|
144
|
+
|
145
|
+
/**
|
146
|
+
* Increments the blockStack counter.
|
147
|
+
* @returns {void}
|
148
|
+
* @private
|
149
|
+
*/
|
150
|
+
function startBlock() {
|
151
|
+
blockStack.push({
|
152
|
+
let: { initialized: false, uninitialized: false },
|
153
|
+
const: { initialized: false, uninitialized: false },
|
154
|
+
});
|
155
|
+
}
|
156
|
+
|
157
|
+
/**
|
158
|
+
* Increments the functionStack counter.
|
159
|
+
* @returns {void}
|
160
|
+
* @private
|
161
|
+
*/
|
162
|
+
function startFunction() {
|
163
|
+
functionStack.push({ initialized: false, uninitialized: false });
|
164
|
+
startBlock();
|
165
|
+
}
|
166
|
+
|
167
|
+
/**
|
168
|
+
* Decrements the blockStack counter.
|
169
|
+
* @returns {void}
|
170
|
+
* @private
|
171
|
+
*/
|
172
|
+
function endBlock() {
|
173
|
+
blockStack.pop();
|
174
|
+
}
|
175
|
+
|
176
|
+
/**
|
177
|
+
* Decrements the functionStack counter.
|
178
|
+
* @returns {void}
|
179
|
+
* @private
|
180
|
+
*/
|
181
|
+
function endFunction() {
|
182
|
+
functionStack.pop();
|
183
|
+
endBlock();
|
184
|
+
}
|
185
|
+
|
186
|
+
/**
|
187
|
+
* Check if a variable declaration is a require.
|
188
|
+
* @param {ASTNode} decl variable declaration Node
|
189
|
+
* @returns {bool} if decl is a require, return true; else return false.
|
190
|
+
* @private
|
191
|
+
*/
|
192
|
+
function isRequire(decl) {
|
193
|
+
return (
|
194
|
+
decl.init &&
|
195
|
+
decl.init.type === "CallExpression" &&
|
196
|
+
decl.init.callee.name === "require"
|
197
|
+
);
|
198
|
+
}
|
199
|
+
|
200
|
+
/**
|
201
|
+
* Records whether initialized/uninitialized/required variables are defined in current scope.
|
202
|
+
* @param {string} statementType node.kind, one of: "var", "let", or "const"
|
203
|
+
* @param {ASTNode[]} declarations List of declarations
|
204
|
+
* @param {Object} currentScope The scope being investigated
|
205
|
+
* @returns {void}
|
206
|
+
* @private
|
207
|
+
*/
|
208
|
+
function recordTypes(statementType, declarations, currentScope) {
|
209
|
+
for (let i = 0; i < declarations.length; i++) {
|
210
|
+
if (declarations[i].init === null) {
|
211
|
+
if (
|
212
|
+
options[statementType] &&
|
213
|
+
options[statementType].uninitialized === MODE_ALWAYS
|
214
|
+
) {
|
215
|
+
currentScope.uninitialized = true;
|
216
|
+
}
|
217
|
+
} else {
|
218
|
+
if (
|
219
|
+
options[statementType] &&
|
220
|
+
options[statementType].initialized === MODE_ALWAYS
|
221
|
+
) {
|
222
|
+
if (
|
223
|
+
options.separateRequires &&
|
224
|
+
isRequire(declarations[i])
|
225
|
+
) {
|
226
|
+
currentScope.required = true;
|
227
|
+
} else {
|
228
|
+
currentScope.initialized = true;
|
229
|
+
}
|
230
|
+
}
|
231
|
+
}
|
232
|
+
}
|
233
|
+
}
|
234
|
+
|
235
|
+
/**
|
236
|
+
* Determines the current scope (function or block)
|
237
|
+
* @param {string} statementType node.kind, one of: "var", "let", or "const"
|
238
|
+
* @returns {Object} The scope associated with statementType
|
239
|
+
*/
|
240
|
+
function getCurrentScope(statementType) {
|
241
|
+
let currentScope;
|
242
|
+
|
243
|
+
if (statementType === "var") {
|
244
|
+
currentScope = functionStack.at(-1);
|
245
|
+
} else if (statementType === "let") {
|
246
|
+
currentScope = blockStack.at(-1).let;
|
247
|
+
} else if (statementType === "const") {
|
248
|
+
currentScope = blockStack.at(-1).const;
|
249
|
+
}
|
250
|
+
return currentScope;
|
251
|
+
}
|
252
|
+
|
253
|
+
/**
|
254
|
+
* Counts the number of initialized and uninitialized declarations in a list of declarations
|
255
|
+
* @param {ASTNode[]} declarations List of declarations
|
256
|
+
* @returns {Object} Counts of 'uninitialized' and 'initialized' declarations
|
257
|
+
* @private
|
258
|
+
*/
|
259
|
+
function countDeclarations(declarations) {
|
260
|
+
const counts = { uninitialized: 0, initialized: 0 };
|
261
|
+
|
262
|
+
for (let i = 0; i < declarations.length; i++) {
|
263
|
+
if (declarations[i].init === null) {
|
264
|
+
counts.uninitialized++;
|
265
|
+
} else {
|
266
|
+
counts.initialized++;
|
267
|
+
}
|
268
|
+
}
|
269
|
+
return counts;
|
270
|
+
}
|
271
|
+
|
272
|
+
/**
|
273
|
+
* Determines if there is more than one var statement in the current scope.
|
274
|
+
* @param {string} statementType node.kind, one of: "var", "let", or "const"
|
275
|
+
* @param {ASTNode[]} declarations List of declarations
|
276
|
+
* @returns {boolean} Returns true if it is the first var declaration, false if not.
|
277
|
+
* @private
|
278
|
+
*/
|
279
|
+
function hasOnlyOneStatement(statementType, declarations) {
|
280
|
+
const declarationCounts = countDeclarations(declarations);
|
281
|
+
const currentOptions = options[statementType] || {};
|
282
|
+
const currentScope = getCurrentScope(statementType);
|
283
|
+
const hasRequires = declarations.some(isRequire);
|
284
|
+
|
285
|
+
if (
|
286
|
+
currentOptions.uninitialized === MODE_ALWAYS &&
|
287
|
+
currentOptions.initialized === MODE_ALWAYS
|
288
|
+
) {
|
289
|
+
if (currentScope.uninitialized || currentScope.initialized) {
|
290
|
+
if (!hasRequires) {
|
291
|
+
return false;
|
292
|
+
}
|
293
|
+
}
|
294
|
+
}
|
295
|
+
|
296
|
+
if (declarationCounts.uninitialized > 0) {
|
297
|
+
if (
|
298
|
+
currentOptions.uninitialized === MODE_ALWAYS &&
|
299
|
+
currentScope.uninitialized
|
300
|
+
) {
|
301
|
+
return false;
|
302
|
+
}
|
303
|
+
}
|
304
|
+
if (declarationCounts.initialized > 0) {
|
305
|
+
if (
|
306
|
+
currentOptions.initialized === MODE_ALWAYS &&
|
307
|
+
currentScope.initialized
|
308
|
+
) {
|
309
|
+
if (!hasRequires) {
|
310
|
+
return false;
|
311
|
+
}
|
312
|
+
}
|
313
|
+
}
|
314
|
+
if (currentScope.required && hasRequires) {
|
315
|
+
return false;
|
316
|
+
}
|
317
|
+
recordTypes(statementType, declarations, currentScope);
|
318
|
+
return true;
|
319
|
+
}
|
320
|
+
|
321
|
+
/**
|
322
|
+
* Fixer to join VariableDeclaration's into a single declaration
|
323
|
+
* @param {VariableDeclarator[]} declarations The `VariableDeclaration` to join
|
324
|
+
* @returns {Function} The fixer function
|
325
|
+
*/
|
326
|
+
function joinDeclarations(declarations) {
|
327
|
+
const declaration = declarations[0];
|
328
|
+
const body = Array.isArray(declaration.parent.parent.body)
|
329
|
+
? declaration.parent.parent.body
|
330
|
+
: [];
|
331
|
+
const currentIndex = body.findIndex(
|
332
|
+
node => node.range[0] === declaration.parent.range[0],
|
333
|
+
);
|
334
|
+
const previousNode = body[currentIndex - 1];
|
335
|
+
|
336
|
+
return fixer => {
|
337
|
+
const type = sourceCode.getTokenBefore(declaration);
|
338
|
+
const prevSemi = sourceCode.getTokenBefore(type);
|
339
|
+
const res = [];
|
340
|
+
|
341
|
+
if (
|
342
|
+
previousNode &&
|
343
|
+
previousNode.kind === sourceCode.getText(type)
|
344
|
+
) {
|
345
|
+
if (prevSemi.value === ";") {
|
346
|
+
res.push(fixer.replaceText(prevSemi, ","));
|
347
|
+
} else {
|
348
|
+
res.push(fixer.insertTextAfter(prevSemi, ","));
|
349
|
+
}
|
350
|
+
res.push(fixer.replaceText(type, ""));
|
351
|
+
}
|
352
|
+
|
353
|
+
return res;
|
354
|
+
};
|
355
|
+
}
|
356
|
+
|
357
|
+
/**
|
358
|
+
* Fixer to split a VariableDeclaration into individual declarations
|
359
|
+
* @param {VariableDeclaration} declaration The `VariableDeclaration` to split
|
360
|
+
* @returns {Function|null} The fixer function
|
361
|
+
*/
|
362
|
+
function splitDeclarations(declaration) {
|
363
|
+
const { parent } = declaration;
|
364
|
+
|
365
|
+
// don't autofix code such as: if (foo) var x, y;
|
366
|
+
if (
|
367
|
+
!isInStatementList(
|
368
|
+
parent.type === "ExportNamedDeclaration"
|
369
|
+
? parent
|
370
|
+
: declaration,
|
371
|
+
)
|
372
|
+
) {
|
373
|
+
return null;
|
374
|
+
}
|
375
|
+
|
376
|
+
return fixer =>
|
377
|
+
declaration.declarations
|
378
|
+
.map(declarator => {
|
379
|
+
const tokenAfterDeclarator =
|
380
|
+
sourceCode.getTokenAfter(declarator);
|
381
|
+
|
382
|
+
if (tokenAfterDeclarator === null) {
|
383
|
+
return null;
|
384
|
+
}
|
385
|
+
|
386
|
+
const afterComma = sourceCode.getTokenAfter(
|
387
|
+
tokenAfterDeclarator,
|
388
|
+
{ includeComments: true },
|
389
|
+
);
|
390
|
+
|
391
|
+
if (tokenAfterDeclarator.value !== ",") {
|
392
|
+
return null;
|
393
|
+
}
|
394
|
+
|
395
|
+
const exportPlacement =
|
396
|
+
declaration.parent.type === "ExportNamedDeclaration"
|
397
|
+
? "export "
|
398
|
+
: "";
|
399
|
+
|
400
|
+
/*
|
401
|
+
* `var x,y`
|
402
|
+
* tokenAfterDeclarator ^^ afterComma
|
403
|
+
*/
|
404
|
+
if (
|
405
|
+
afterComma.range[0] ===
|
406
|
+
tokenAfterDeclarator.range[1]
|
407
|
+
) {
|
408
|
+
return fixer.replaceText(
|
409
|
+
tokenAfterDeclarator,
|
410
|
+
`; ${exportPlacement}${declaration.kind} `,
|
411
|
+
);
|
412
|
+
}
|
413
|
+
|
414
|
+
/*
|
415
|
+
* `var x,
|
416
|
+
* tokenAfterDeclarator ^
|
417
|
+
* y`
|
418
|
+
* ^ afterComma
|
419
|
+
*/
|
420
|
+
if (
|
421
|
+
afterComma.loc.start.line >
|
422
|
+
tokenAfterDeclarator.loc.end.line ||
|
423
|
+
afterComma.type === "Line" ||
|
424
|
+
afterComma.type === "Block"
|
425
|
+
) {
|
426
|
+
let lastComment = afterComma;
|
427
|
+
|
428
|
+
while (
|
429
|
+
lastComment.type === "Line" ||
|
430
|
+
lastComment.type === "Block"
|
431
|
+
) {
|
432
|
+
lastComment = sourceCode.getTokenAfter(
|
433
|
+
lastComment,
|
434
|
+
{ includeComments: true },
|
435
|
+
);
|
436
|
+
}
|
437
|
+
|
438
|
+
return fixer.replaceTextRange(
|
439
|
+
[
|
440
|
+
tokenAfterDeclarator.range[0],
|
441
|
+
lastComment.range[0],
|
442
|
+
],
|
443
|
+
`;${sourceCode.text.slice(tokenAfterDeclarator.range[1], lastComment.range[0])}${exportPlacement}${declaration.kind} `,
|
444
|
+
);
|
445
|
+
}
|
446
|
+
|
447
|
+
return fixer.replaceText(
|
448
|
+
tokenAfterDeclarator,
|
449
|
+
`; ${exportPlacement}${declaration.kind}`,
|
450
|
+
);
|
451
|
+
})
|
452
|
+
.filter(x => x);
|
453
|
+
}
|
454
|
+
|
455
|
+
/**
|
456
|
+
* Checks a given VariableDeclaration node for errors.
|
457
|
+
* @param {ASTNode} node The VariableDeclaration node to check
|
458
|
+
* @returns {void}
|
459
|
+
* @private
|
460
|
+
*/
|
461
|
+
function checkVariableDeclaration(node) {
|
462
|
+
const parent = node.parent;
|
463
|
+
const type = node.kind;
|
464
|
+
|
465
|
+
if (!options[type]) {
|
466
|
+
return;
|
467
|
+
}
|
468
|
+
|
469
|
+
const declarations = node.declarations;
|
470
|
+
const declarationCounts = countDeclarations(declarations);
|
471
|
+
const mixedRequires =
|
472
|
+
declarations.some(isRequire) && !declarations.every(isRequire);
|
473
|
+
|
474
|
+
if (options[type].initialized === MODE_ALWAYS) {
|
475
|
+
if (options.separateRequires && mixedRequires) {
|
476
|
+
context.report({
|
477
|
+
node,
|
478
|
+
messageId: "splitRequires",
|
479
|
+
});
|
480
|
+
}
|
481
|
+
}
|
482
|
+
|
483
|
+
// consecutive
|
484
|
+
const nodeIndex =
|
485
|
+
(parent.body &&
|
486
|
+
parent.body.length > 0 &&
|
487
|
+
parent.body.indexOf(node)) ||
|
488
|
+
0;
|
489
|
+
|
490
|
+
if (nodeIndex > 0) {
|
491
|
+
const previousNode = parent.body[nodeIndex - 1];
|
492
|
+
const isPreviousNodeDeclaration =
|
493
|
+
previousNode.type === "VariableDeclaration";
|
494
|
+
const declarationsWithPrevious = declarations.concat(
|
495
|
+
previousNode.declarations || [],
|
496
|
+
);
|
497
|
+
|
498
|
+
if (
|
499
|
+
isPreviousNodeDeclaration &&
|
500
|
+
previousNode.kind === type &&
|
501
|
+
!(
|
502
|
+
declarationsWithPrevious.some(isRequire) &&
|
503
|
+
!declarationsWithPrevious.every(isRequire)
|
504
|
+
)
|
505
|
+
) {
|
506
|
+
const previousDeclCounts = countDeclarations(
|
507
|
+
previousNode.declarations,
|
508
|
+
);
|
509
|
+
|
510
|
+
if (
|
511
|
+
options[type].initialized === MODE_CONSECUTIVE &&
|
512
|
+
options[type].uninitialized === MODE_CONSECUTIVE
|
513
|
+
) {
|
514
|
+
context.report({
|
515
|
+
node,
|
516
|
+
messageId: "combine",
|
517
|
+
data: {
|
518
|
+
type,
|
519
|
+
},
|
520
|
+
fix: joinDeclarations(declarations),
|
521
|
+
});
|
522
|
+
} else if (
|
523
|
+
options[type].initialized === MODE_CONSECUTIVE &&
|
524
|
+
declarationCounts.initialized > 0 &&
|
525
|
+
previousDeclCounts.initialized > 0
|
526
|
+
) {
|
527
|
+
context.report({
|
528
|
+
node,
|
529
|
+
messageId: "combineInitialized",
|
530
|
+
data: {
|
531
|
+
type,
|
532
|
+
},
|
533
|
+
fix: joinDeclarations(declarations),
|
534
|
+
});
|
535
|
+
} else if (
|
536
|
+
options[type].uninitialized === MODE_CONSECUTIVE &&
|
537
|
+
declarationCounts.uninitialized > 0 &&
|
538
|
+
previousDeclCounts.uninitialized > 0
|
539
|
+
) {
|
540
|
+
context.report({
|
541
|
+
node,
|
542
|
+
messageId: "combineUninitialized",
|
543
|
+
data: {
|
544
|
+
type,
|
545
|
+
},
|
546
|
+
fix: joinDeclarations(declarations),
|
547
|
+
});
|
548
|
+
}
|
549
|
+
}
|
550
|
+
}
|
551
|
+
|
552
|
+
// always
|
553
|
+
if (!hasOnlyOneStatement(type, declarations)) {
|
554
|
+
if (
|
555
|
+
options[type].initialized === MODE_ALWAYS &&
|
556
|
+
options[type].uninitialized === MODE_ALWAYS
|
557
|
+
) {
|
558
|
+
context.report({
|
559
|
+
node,
|
560
|
+
messageId: "combine",
|
561
|
+
data: {
|
562
|
+
type,
|
563
|
+
},
|
564
|
+
fix: joinDeclarations(declarations),
|
565
|
+
});
|
566
|
+
} else {
|
567
|
+
if (
|
568
|
+
options[type].initialized === MODE_ALWAYS &&
|
569
|
+
declarationCounts.initialized > 0
|
570
|
+
) {
|
571
|
+
context.report({
|
572
|
+
node,
|
573
|
+
messageId: "combineInitialized",
|
574
|
+
data: {
|
575
|
+
type,
|
576
|
+
},
|
577
|
+
fix: joinDeclarations(declarations),
|
578
|
+
});
|
579
|
+
}
|
580
|
+
if (
|
581
|
+
options[type].uninitialized === MODE_ALWAYS &&
|
582
|
+
declarationCounts.uninitialized > 0
|
583
|
+
) {
|
584
|
+
if (
|
585
|
+
node.parent.left === node &&
|
586
|
+
(node.parent.type === "ForInStatement" ||
|
587
|
+
node.parent.type === "ForOfStatement")
|
588
|
+
) {
|
589
|
+
return;
|
590
|
+
}
|
591
|
+
context.report({
|
592
|
+
node,
|
593
|
+
messageId: "combineUninitialized",
|
594
|
+
data: {
|
595
|
+
type,
|
596
|
+
},
|
597
|
+
fix: joinDeclarations(declarations),
|
598
|
+
});
|
599
|
+
}
|
600
|
+
}
|
601
|
+
}
|
602
|
+
|
603
|
+
// never
|
604
|
+
if (parent.type !== "ForStatement" || parent.init !== node) {
|
605
|
+
const totalDeclarations =
|
606
|
+
declarationCounts.uninitialized +
|
607
|
+
declarationCounts.initialized;
|
608
|
+
|
609
|
+
if (totalDeclarations > 1) {
|
610
|
+
if (
|
611
|
+
options[type].initialized === MODE_NEVER &&
|
612
|
+
options[type].uninitialized === MODE_NEVER
|
613
|
+
) {
|
614
|
+
// both initialized and uninitialized
|
615
|
+
context.report({
|
616
|
+
node,
|
617
|
+
messageId: "split",
|
618
|
+
data: {
|
619
|
+
type,
|
620
|
+
},
|
621
|
+
fix: splitDeclarations(node),
|
622
|
+
});
|
623
|
+
} else if (
|
624
|
+
options[type].initialized === MODE_NEVER &&
|
625
|
+
declarationCounts.initialized > 0
|
626
|
+
) {
|
627
|
+
// initialized
|
628
|
+
context.report({
|
629
|
+
node,
|
630
|
+
messageId: "splitInitialized",
|
631
|
+
data: {
|
632
|
+
type,
|
633
|
+
},
|
634
|
+
fix: splitDeclarations(node),
|
635
|
+
});
|
636
|
+
} else if (
|
637
|
+
options[type].uninitialized === MODE_NEVER &&
|
638
|
+
declarationCounts.uninitialized > 0
|
639
|
+
) {
|
640
|
+
// uninitialized
|
641
|
+
context.report({
|
642
|
+
node,
|
643
|
+
messageId: "splitUninitialized",
|
644
|
+
data: {
|
645
|
+
type,
|
646
|
+
},
|
647
|
+
fix: splitDeclarations(node),
|
648
|
+
});
|
649
|
+
}
|
650
|
+
}
|
651
|
+
}
|
652
|
+
}
|
653
|
+
|
654
|
+
//--------------------------------------------------------------------------
|
655
|
+
// Public API
|
656
|
+
//--------------------------------------------------------------------------
|
657
|
+
|
658
|
+
return {
|
659
|
+
Program: startFunction,
|
660
|
+
FunctionDeclaration: startFunction,
|
661
|
+
FunctionExpression: startFunction,
|
662
|
+
ArrowFunctionExpression: startFunction,
|
663
|
+
StaticBlock: startFunction, // StaticBlock creates a new scope for `var` variables
|
664
|
+
|
665
|
+
BlockStatement: startBlock,
|
666
|
+
ForStatement: startBlock,
|
667
|
+
ForInStatement: startBlock,
|
668
|
+
ForOfStatement: startBlock,
|
669
|
+
SwitchStatement: startBlock,
|
670
|
+
VariableDeclaration: checkVariableDeclaration,
|
671
|
+
"ForStatement:exit": endBlock,
|
672
|
+
"ForOfStatement:exit": endBlock,
|
673
|
+
"ForInStatement:exit": endBlock,
|
674
|
+
"SwitchStatement:exit": endBlock,
|
675
|
+
"BlockStatement:exit": endBlock,
|
676
|
+
|
677
|
+
"Program:exit": endFunction,
|
678
|
+
"FunctionDeclaration:exit": endFunction,
|
679
|
+
"FunctionExpression:exit": endFunction,
|
680
|
+
"ArrowFunctionExpression:exit": endFunction,
|
681
|
+
"StaticBlock:exit": endFunction,
|
682
|
+
};
|
683
|
+
},
|
568
684
|
};
|