eslint 8.57.1 → 9.39.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +165 -115
- package/bin/eslint.js +112 -89
- package/conf/default-cli-options.js +22 -22
- package/conf/ecma-version.js +16 -0
- package/conf/globals.js +109 -94
- package/conf/replacements.json +24 -20
- package/conf/rule-type-list.json +89 -26
- package/lib/api.js +16 -20
- package/lib/cli-engine/cli-engine.js +841 -810
- package/lib/cli-engine/file-enumerator.js +384 -390
- package/lib/cli-engine/formatters/formatters-meta.json +17 -45
- package/lib/cli-engine/formatters/html.js +110 -102
- 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 +97 -76
- package/lib/cli-engine/hash.js +1 -1
- package/lib/cli-engine/index.js +1 -1
- package/lib/cli-engine/lint-result-cache.js +165 -148
- package/lib/cli-engine/load-rules.js +17 -17
- package/lib/cli.js +481 -399
- package/lib/config/config-loader.js +816 -0
- package/lib/config/config.js +674 -0
- package/lib/config/default-config.js +57 -46
- package/lib/config/flat-config-array.js +170 -333
- package/lib/config/flat-config-schema.js +389 -389
- package/lib/config-api.js +12 -0
- package/lib/eslint/eslint-helpers.js +1196 -663
- package/lib/eslint/eslint.js +1262 -607
- package/lib/eslint/index.js +3 -3
- package/lib/eslint/legacy-eslint.js +786 -0
- package/lib/eslint/worker.js +173 -0
- package/lib/languages/js/index.js +336 -0
- package/lib/languages/js/source-code/index.js +7 -0
- package/lib/languages/js/source-code/source-code.js +1364 -0
- package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +61 -0
- package/lib/languages/js/source-code/token-store/backward-token-cursor.js +57 -0
- package/lib/{source-code → languages/js/source-code}/token-store/cursor.js +36 -36
- package/lib/languages/js/source-code/token-store/cursors.js +120 -0
- package/lib/{source-code → languages/js/source-code}/token-store/decorative-cursor.js +17 -18
- package/lib/{source-code → languages/js/source-code}/token-store/filter-cursor.js +19 -20
- package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +65 -0
- package/lib/languages/js/source-code/token-store/forward-token-cursor.js +62 -0
- package/lib/languages/js/source-code/token-store/index.js +721 -0
- package/lib/{source-code → languages/js/source-code}/token-store/limit-cursor.js +17 -18
- package/lib/languages/js/source-code/token-store/padded-token-cursor.js +45 -0
- package/lib/{source-code → languages/js/source-code}/token-store/skip-cursor.js +19 -20
- package/lib/languages/js/source-code/token-store/utils.js +110 -0
- package/lib/languages/js/validate-language-options.js +196 -0
- package/lib/linter/apply-disable-directives.js +490 -371
- package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -674
- 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 -317
- package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
- package/lib/linter/code-path-analysis/fork-context.js +297 -272
- package/lib/linter/code-path-analysis/id-generator.js +22 -23
- package/lib/linter/esquery.js +332 -0
- package/lib/linter/file-context.js +144 -0
- package/lib/linter/file-report.js +608 -0
- package/lib/linter/index.js +3 -5
- package/lib/linter/interpolate.js +38 -16
- package/lib/linter/linter.js +2328 -1785
- package/lib/linter/rule-fixer.js +136 -107
- package/lib/linter/rules.js +37 -46
- package/lib/linter/source-code-fixer.js +96 -94
- package/lib/linter/source-code-traverser.js +333 -0
- package/lib/linter/source-code-visitor.js +81 -0
- package/lib/linter/timing.js +145 -97
- package/lib/linter/vfile.js +115 -0
- package/lib/options.js +464 -326
- package/lib/rule-tester/index.js +3 -1
- package/lib/rule-tester/rule-tester.js +1371 -998
- package/lib/rules/accessor-pairs.js +333 -259
- package/lib/rules/array-bracket-newline.js +250 -220
- package/lib/rules/array-bracket-spacing.js +286 -229
- package/lib/rules/array-callback-return.js +401 -354
- package/lib/rules/array-element-newline.js +358 -295
- package/lib/rules/arrow-body-style.js +400 -278
- package/lib/rules/arrow-parens.js +206 -155
- package/lib/rules/arrow-spacing.js +169 -145
- package/lib/rules/block-scoped-var.js +125 -123
- package/lib/rules/block-spacing.js +186 -158
- package/lib/rules/brace-style.js +262 -181
- package/lib/rules/callback-return.js +203 -174
- package/lib/rules/camelcase.js +403 -380
- package/lib/rules/capitalized-comments.js +253 -228
- package/lib/rules/class-methods-use-this.js +231 -168
- package/lib/rules/comma-dangle.js +379 -328
- package/lib/rules/comma-spacing.js +193 -177
- package/lib/rules/comma-style.js +375 -298
- package/lib/rules/complexity.js +180 -144
- package/lib/rules/computed-property-spacing.js +236 -193
- package/lib/rules/consistent-return.js +181 -170
- package/lib/rules/consistent-this.js +167 -141
- package/lib/rules/constructor-super.js +418 -411
- package/lib/rules/curly.js +407 -468
- package/lib/rules/default-case-last.js +39 -32
- package/lib/rules/default-case.js +89 -83
- package/lib/rules/default-param-last.js +69 -53
- package/lib/rules/dot-location.js +122 -92
- package/lib/rules/dot-notation.js +193 -153
- package/lib/rules/eol-last.js +122 -102
- package/lib/rules/eqeqeq.js +191 -155
- package/lib/rules/for-direction.js +150 -122
- package/lib/rules/func-call-spacing.js +261 -213
- package/lib/rules/func-name-matching.js +294 -209
- package/lib/rules/func-names.js +165 -164
- package/lib/rules/func-style.js +209 -86
- package/lib/rules/function-call-argument-newline.js +152 -111
- package/lib/rules/function-paren-newline.js +349 -273
- package/lib/rules/generator-star-spacing.js +229 -192
- package/lib/rules/getter-return.js +208 -170
- package/lib/rules/global-require.js +85 -58
- package/lib/rules/grouped-accessor-pairs.js +201 -148
- package/lib/rules/guard-for-in.js +72 -63
- package/lib/rules/handle-callback-err.js +108 -87
- package/lib/rules/id-blacklist.js +182 -187
- package/lib/rules/id-denylist.js +174 -179
- package/lib/rules/id-length.js +197 -157
- package/lib/rules/id-match.js +350 -286
- package/lib/rules/implicit-arrow-linebreak.js +102 -61
- package/lib/rules/indent-legacy.js +1345 -1102
- package/lib/rules/indent.js +2272 -1741
- package/lib/rules/index.js +320 -294
- package/lib/rules/init-declarations.js +139 -106
- package/lib/rules/jsx-quotes.js +94 -64
- package/lib/rules/key-spacing.js +750 -615
- package/lib/rules/keyword-spacing.js +648 -587
- package/lib/rules/line-comment-position.js +143 -108
- package/lib/rules/linebreak-style.js +115 -88
- package/lib/rules/lines-around-comment.js +540 -430
- package/lib/rules/lines-around-directive.js +233 -185
- package/lib/rules/lines-between-class-members.js +305 -216
- package/lib/rules/logical-assignment-operators.js +582 -398
- package/lib/rules/max-classes-per-file.js +69 -68
- package/lib/rules/max-depth.js +146 -143
- package/lib/rules/max-len.js +473 -416
- package/lib/rules/max-lines-per-function.js +201 -176
- package/lib/rules/max-lines.js +158 -162
- package/lib/rules/max-nested-callbacks.js +102 -104
- package/lib/rules/max-params.js +102 -75
- package/lib/rules/max-statements-per-line.js +205 -180
- package/lib/rules/max-statements.js +168 -164
- package/lib/rules/multiline-comment-style.js +638 -460
- package/lib/rules/multiline-ternary.js +241 -158
- package/lib/rules/new-cap.js +233 -232
- package/lib/rules/new-parens.js +88 -61
- package/lib/rules/newline-after-var.js +287 -233
- package/lib/rules/newline-before-return.js +229 -204
- package/lib/rules/newline-per-chained-call.js +142 -109
- package/lib/rules/no-alert.js +90 -79
- package/lib/rules/no-array-constructor.js +175 -113
- package/lib/rules/no-async-promise-executor.js +30 -24
- package/lib/rules/no-await-in-loop.js +79 -70
- package/lib/rules/no-bitwise.js +113 -87
- package/lib/rules/no-buffer-constructor.js +61 -37
- package/lib/rules/no-caller.js +39 -33
- package/lib/rules/no-case-declarations.js +61 -45
- package/lib/rules/no-catch-shadow.js +76 -62
- package/lib/rules/no-class-assign.js +51 -48
- package/lib/rules/no-compare-neg-zero.js +62 -48
- package/lib/rules/no-cond-assign.js +148 -132
- package/lib/rules/no-confusing-arrow.js +98 -63
- package/lib/rules/no-console.js +202 -188
- package/lib/rules/no-const-assign.js +58 -41
- package/lib/rules/no-constant-binary-expression.js +501 -407
- package/lib/rules/no-constant-condition.js +158 -131
- package/lib/rules/no-constructor-return.js +49 -49
- package/lib/rules/no-continue.js +25 -26
- package/lib/rules/no-control-regex.js +125 -121
- package/lib/rules/no-debugger.js +28 -30
- package/lib/rules/no-delete-var.js +29 -29
- package/lib/rules/no-div-regex.js +47 -40
- package/lib/rules/no-dupe-args.js +79 -69
- package/lib/rules/no-dupe-class-members.js +102 -89
- package/lib/rules/no-dupe-else-if.js +100 -77
- package/lib/rules/no-dupe-keys.js +133 -110
- package/lib/rules/no-duplicate-case.js +50 -43
- package/lib/rules/no-duplicate-imports.js +266 -188
- package/lib/rules/no-else-return.js +430 -385
- package/lib/rules/no-empty-character-class.js +57 -50
- package/lib/rules/no-empty-function.js +197 -128
- package/lib/rules/no-empty-pattern.js +63 -56
- package/lib/rules/no-empty-static-block.js +61 -35
- package/lib/rules/no-empty.js +135 -85
- package/lib/rules/no-eq-null.js +37 -32
- package/lib/rules/no-eval.js +258 -249
- package/lib/rules/no-ex-assign.js +42 -39
- package/lib/rules/no-extend-native.js +161 -160
- package/lib/rules/no-extra-bind.js +201 -190
- package/lib/rules/no-extra-boolean-cast.js +398 -295
- package/lib/rules/no-extra-label.js +150 -130
- package/lib/rules/no-extra-parens.js +1654 -1307
- package/lib/rules/no-extra-semi.js +146 -126
- package/lib/rules/no-fallthrough.js +200 -136
- package/lib/rules/no-floating-decimal.js +74 -48
- package/lib/rules/no-func-assign.js +54 -55
- package/lib/rules/no-global-assign.js +78 -72
- package/lib/rules/no-implicit-coercion.js +350 -262
- package/lib/rules/no-implicit-globals.js +174 -133
- package/lib/rules/no-implied-eval.js +150 -112
- package/lib/rules/no-import-assign.js +145 -159
- package/lib/rules/no-inline-comments.js +101 -96
- package/lib/rules/no-inner-declarations.js +115 -78
- package/lib/rules/no-invalid-regexp.js +223 -174
- package/lib/rules/no-invalid-this.js +145 -117
- package/lib/rules/no-irregular-whitespace.js +266 -250
- package/lib/rules/no-iterator.js +29 -33
- package/lib/rules/no-label-var.js +59 -61
- package/lib/rules/no-labels.js +138 -131
- package/lib/rules/no-lone-blocks.js +127 -123
- package/lib/rules/no-lonely-if.js +105 -67
- package/lib/rules/no-loop-func.js +245 -184
- package/lib/rules/no-loss-of-precision.js +236 -201
- package/lib/rules/no-magic-numbers.js +339 -217
- package/lib/rules/no-misleading-character-class.js +548 -253
- package/lib/rules/no-mixed-operators.js +188 -164
- package/lib/rules/no-mixed-requires.js +253 -224
- package/lib/rules/no-mixed-spaces-and-tabs.js +135 -103
- package/lib/rules/no-multi-assign.js +46 -47
- package/lib/rules/no-multi-spaces.js +163 -125
- package/lib/rules/no-multi-str.js +42 -40
- package/lib/rules/no-multiple-empty-lines.js +196 -140
- package/lib/rules/no-native-reassign.js +90 -74
- package/lib/rules/no-negated-condition.js +79 -74
- package/lib/rules/no-negated-in-lhs.js +45 -32
- package/lib/rules/no-nested-ternary.js +33 -31
- package/lib/rules/no-new-func.js +71 -62
- package/lib/rules/no-new-native-nonconstructor.js +43 -39
- package/lib/rules/no-new-object.js +48 -39
- package/lib/rules/no-new-require.js +48 -31
- package/lib/rules/no-new-symbol.js +61 -43
- package/lib/rules/no-new-wrappers.js +43 -41
- package/lib/rules/no-new.js +28 -29
- package/lib/rules/no-nonoctal-decimal-escape.js +149 -121
- package/lib/rules/no-obj-calls.js +66 -53
- package/lib/rules/no-object-constructor.js +104 -97
- package/lib/rules/no-octal-escape.js +40 -43
- package/lib/rules/no-octal.js +29 -32
- package/lib/rules/no-param-reassign.js +236 -218
- package/lib/rules/no-path-concat.js +66 -51
- package/lib/rules/no-plusplus.js +60 -63
- package/lib/rules/no-process-env.js +49 -32
- package/lib/rules/no-process-exit.js +48 -28
- package/lib/rules/no-promise-executor-return.js +205 -204
- package/lib/rules/no-proto.js +26 -29
- package/lib/rules/no-prototype-builtins.js +146 -124
- package/lib/rules/no-redeclare.js +154 -155
- package/lib/rules/no-regex-spaces.js +183 -161
- package/lib/rules/no-restricted-exports.js +208 -174
- package/lib/rules/no-restricted-globals.js +254 -112
- package/lib/rules/no-restricted-imports.js +824 -384
- package/lib/rules/no-restricted-modules.js +222 -186
- package/lib/rules/no-restricted-properties.js +218 -153
- package/lib/rules/no-restricted-syntax.js +56 -52
- package/lib/rules/no-return-assign.js +56 -49
- package/lib/rules/no-return-await.js +147 -120
- package/lib/rules/no-script-url.js +53 -46
- package/lib/rules/no-self-assign.js +148 -145
- package/lib/rules/no-self-compare.js +63 -46
- package/lib/rules/no-sequences.js +135 -115
- package/lib/rules/no-setter-return.js +176 -178
- package/lib/rules/no-shadow-restricted-names.js +84 -36
- package/lib/rules/no-shadow.js +598 -310
- package/lib/rules/no-spaced-func.js +82 -60
- package/lib/rules/no-sparse-arrays.js +46 -28
- package/lib/rules/no-sync.js +61 -44
- package/lib/rules/no-tabs.js +83 -54
- package/lib/rules/no-template-curly-in-string.js +33 -32
- package/lib/rules/no-ternary.js +25 -28
- package/lib/rules/no-this-before-super.js +332 -298
- package/lib/rules/no-throw-literal.js +31 -36
- package/lib/rules/no-trailing-spaces.js +208 -174
- package/lib/rules/no-unassigned-vars.js +80 -0
- package/lib/rules/no-undef-init.js +86 -60
- package/lib/rules/no-undef.js +52 -47
- package/lib/rules/no-undefined.js +73 -74
- package/lib/rules/no-underscore-dangle.js +370 -322
- package/lib/rules/no-unexpected-multiline.js +112 -102
- package/lib/rules/no-unmodified-loop-condition.js +254 -254
- package/lib/rules/no-unneeded-ternary.js +212 -146
- package/lib/rules/no-unreachable-loop.js +145 -140
- package/lib/rules/no-unreachable.js +255 -248
- package/lib/rules/no-unsafe-finally.js +93 -85
- package/lib/rules/no-unsafe-negation.js +105 -81
- package/lib/rules/no-unsafe-optional-chaining.js +193 -177
- package/lib/rules/no-unused-expressions.js +199 -158
- package/lib/rules/no-unused-labels.js +139 -124
- package/lib/rules/no-unused-private-class-members.js +206 -182
- package/lib/rules/no-unused-vars.js +1708 -687
- package/lib/rules/no-use-before-define.js +327 -229
- package/lib/rules/no-useless-assignment.js +654 -0
- package/lib/rules/no-useless-backreference.js +212 -143
- package/lib/rules/no-useless-call.js +58 -53
- package/lib/rules/no-useless-catch.js +40 -40
- package/lib/rules/no-useless-computed-key.js +144 -108
- package/lib/rules/no-useless-concat.js +65 -59
- package/lib/rules/no-useless-constructor.js +160 -97
- package/lib/rules/no-useless-escape.js +364 -291
- package/lib/rules/no-useless-rename.js +183 -153
- package/lib/rules/no-useless-return.js +344 -307
- package/lib/rules/no-var.js +245 -212
- package/lib/rules/no-void.js +51 -46
- package/lib/rules/no-warning-comments.js +191 -183
- package/lib/rules/no-whitespace-before-property.js +131 -97
- package/lib/rules/no-with.js +24 -26
- package/lib/rules/nonblock-statement-body-position.js +149 -112
- package/lib/rules/object-curly-newline.js +306 -247
- package/lib/rules/object-curly-spacing.js +360 -296
- package/lib/rules/object-property-newline.js +137 -88
- package/lib/rules/object-shorthand.js +632 -500
- package/lib/rules/one-var-declaration-per-line.js +104 -82
- package/lib/rules/one-var.js +686 -536
- package/lib/rules/operator-assignment.js +219 -158
- package/lib/rules/operator-linebreak.js +295 -233
- package/lib/rules/padded-blocks.js +346 -290
- package/lib/rules/padding-line-between-statements.js +443 -421
- package/lib/rules/prefer-arrow-callback.js +371 -315
- package/lib/rules/prefer-const.js +418 -373
- package/lib/rules/prefer-destructuring.js +309 -278
- package/lib/rules/prefer-exponentiation-operator.js +176 -132
- package/lib/rules/prefer-named-capture-group.js +160 -141
- package/lib/rules/prefer-numeric-literals.js +121 -112
- package/lib/rules/prefer-object-has-own.js +116 -82
- package/lib/rules/prefer-object-spread.js +214 -193
- package/lib/rules/prefer-promise-reject-errors.js +140 -118
- package/lib/rules/prefer-reflect.js +126 -103
- package/lib/rules/prefer-regex-literals.js +561 -463
- package/lib/rules/prefer-rest-params.js +79 -80
- package/lib/rules/prefer-spread.js +47 -43
- package/lib/rules/prefer-template.js +266 -194
- package/lib/rules/preserve-caught-error.js +535 -0
- package/lib/rules/quote-props.js +373 -289
- package/lib/rules/quotes.js +374 -308
- package/lib/rules/radix.js +152 -134
- package/lib/rules/require-atomic-updates.js +316 -282
- package/lib/rules/require-await.js +153 -82
- package/lib/rules/require-unicode-regexp.js +296 -108
- package/lib/rules/require-yield.js +53 -54
- package/lib/rules/rest-spread-spacing.js +128 -98
- package/lib/rules/semi-spacing.js +281 -232
- package/lib/rules/semi-style.js +176 -116
- package/lib/rules/semi.js +456 -418
- package/lib/rules/sort-imports.js +307 -229
- package/lib/rules/sort-keys.js +219 -181
- package/lib/rules/sort-vars.js +127 -91
- package/lib/rules/space-before-blocks.js +199 -171
- package/lib/rules/space-before-function-paren.js +186 -148
- package/lib/rules/space-in-parens.js +359 -270
- package/lib/rules/space-infix-ops.js +237 -183
- package/lib/rules/space-unary-ops.js +356 -280
- package/lib/rules/spaced-comment.js +363 -301
- package/lib/rules/strict.js +266 -229
- package/lib/rules/switch-colon-spacing.js +130 -104
- package/lib/rules/symbol-description.js +45 -48
- package/lib/rules/template-curly-spacing.js +148 -124
- package/lib/rules/template-tag-spacing.js +98 -70
- package/lib/rules/unicode-bom.js +54 -54
- package/lib/rules/use-isnan.js +237 -110
- package/lib/rules/utils/ast-utils.js +2139 -1688
- package/lib/rules/utils/char-source.js +247 -0
- package/lib/rules/utils/fix-tracker.js +99 -88
- package/lib/rules/utils/keywords.js +59 -59
- package/lib/rules/utils/lazy-loading-rule-map.js +81 -78
- package/lib/rules/utils/regular-expressions.js +35 -19
- package/lib/rules/utils/unicode/index.js +9 -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 +153 -109
- package/lib/rules/vars-on-top.js +152 -144
- package/lib/rules/wrap-iife.js +204 -173
- package/lib/rules/wrap-regex.js +77 -47
- package/lib/rules/yield-star-spacing.js +145 -116
- package/lib/rules/yoda.js +283 -274
- package/lib/services/parser-service.js +65 -0
- package/lib/services/processor-service.js +101 -0
- package/lib/services/suppressions-service.js +302 -0
- package/lib/services/warning-service.js +98 -0
- package/lib/shared/ajv.js +14 -14
- package/lib/shared/assert.js +21 -0
- package/lib/shared/ast-utils.js +7 -6
- package/lib/shared/deep-merge-arrays.js +62 -0
- package/lib/shared/directives.js +3 -2
- package/lib/shared/flags.js +108 -0
- package/lib/shared/logging.js +24 -16
- package/lib/shared/naming.js +109 -0
- package/lib/shared/option-utils.js +63 -0
- package/lib/shared/relative-module-resolver.js +18 -40
- package/lib/shared/runtime-info.js +138 -128
- package/lib/shared/serialization.js +78 -0
- package/lib/shared/severity.js +22 -22
- package/lib/shared/stats.js +30 -0
- package/lib/shared/string-utils.js +19 -21
- package/lib/shared/text-table.js +68 -0
- package/lib/shared/translate-cli-options.js +281 -0
- package/lib/shared/traverser.js +153 -146
- package/lib/types/config-api.d.ts +12 -0
- package/lib/types/index.d.ts +1473 -0
- package/lib/types/rules.d.ts +5589 -0
- package/lib/types/universal.d.ts +6 -0
- package/lib/types/use-at-your-own-risk.d.ts +87 -0
- package/lib/universal.js +10 -0
- package/lib/unsupported-api.js +8 -9
- package/messages/all-files-ignored.js +3 -3
- package/messages/all-matched-files-ignored.js +21 -0
- package/messages/config-file-missing.js +16 -0
- package/messages/config-plugin-missing.js +14 -0
- package/messages/config-serialize-function.js +30 -0
- package/messages/eslintrc-incompat.js +35 -16
- package/messages/eslintrc-plugins.js +8 -5
- 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 +4 -4
- package/messages/plugin-conflict.js +9 -9
- package/messages/plugin-invalid.js +4 -4
- package/messages/plugin-missing.js +4 -4
- 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 +105 -60
- package/conf/config-schema.js +0 -93
- package/lib/cli-engine/formatters/checkstyle.js +0 -60
- package/lib/cli-engine/formatters/compact.js +0 -60
- package/lib/cli-engine/formatters/jslint-xml.js +0 -41
- package/lib/cli-engine/formatters/junit.js +0 -82
- package/lib/cli-engine/formatters/tap.js +0 -95
- package/lib/cli-engine/formatters/unix.js +0 -58
- package/lib/cli-engine/formatters/visualstudio.js +0 -63
- package/lib/cli-engine/xml-escape.js +0 -34
- package/lib/config/flat-config-helpers.js +0 -111
- package/lib/config/rule-validator.js +0 -158
- package/lib/eslint/flat-eslint.js +0 -1159
- package/lib/linter/config-comment-parser.js +0 -185
- package/lib/linter/node-event-generator.js +0 -354
- package/lib/linter/report-translator.js +0 -369
- package/lib/linter/safe-emitter.js +0 -52
- package/lib/rule-tester/flat-rule-tester.js +0 -1131
- package/lib/rules/require-jsdoc.js +0 -122
- package/lib/rules/utils/patterns/letters.js +0 -36
- package/lib/rules/valid-jsdoc.js +0 -516
- package/lib/shared/config-validator.js +0 -347
- package/lib/shared/deprecation-warnings.js +0 -58
- package/lib/shared/types.js +0 -216
- package/lib/source-code/index.js +0 -5
- package/lib/source-code/source-code.js +0 -1055
- package/lib/source-code/token-store/backward-token-comment-cursor.js +0 -57
- package/lib/source-code/token-store/backward-token-cursor.js +0 -58
- package/lib/source-code/token-store/cursors.js +0 -90
- package/lib/source-code/token-store/forward-token-comment-cursor.js +0 -57
- package/lib/source-code/token-store/forward-token-cursor.js +0 -63
- package/lib/source-code/token-store/index.js +0 -627
- package/lib/source-code/token-store/padded-token-cursor.js +0 -38
- package/lib/source-code/token-store/utils.js +0 -107
package/lib/rules/no-shadow.js
CHANGED
|
@@ -15,322 +15,610 @@ const astUtils = require("./utils/ast-utils");
|
|
|
15
15
|
// Helpers
|
|
16
16
|
//------------------------------------------------------------------------------
|
|
17
17
|
|
|
18
|
-
const FUNC_EXPR_NODE_TYPES = new Set([
|
|
18
|
+
const FUNC_EXPR_NODE_TYPES = new Set([
|
|
19
|
+
"ArrowFunctionExpression",
|
|
20
|
+
"FunctionExpression",
|
|
21
|
+
]);
|
|
19
22
|
const CALL_EXPR_NODE_TYPE = new Set(["CallExpression"]);
|
|
20
23
|
const FOR_IN_OF_TYPE = /^For(?:In|Of)Statement$/u;
|
|
21
|
-
const SENTINEL_TYPE =
|
|
24
|
+
const SENTINEL_TYPE =
|
|
25
|
+
/^(?:(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|CatchClause|ImportDeclaration|ExportNamedDeclaration)$/u;
|
|
26
|
+
|
|
27
|
+
// TS-specific node types
|
|
28
|
+
const TYPES_HOISTED_NODES = new Set([
|
|
29
|
+
"TSInterfaceDeclaration",
|
|
30
|
+
"TSTypeAliasDeclaration",
|
|
31
|
+
]);
|
|
32
|
+
|
|
33
|
+
// TS-specific function variable def types
|
|
34
|
+
const ALLOWED_FUNCTION_VARIABLE_DEF_TYPES = new Set([
|
|
35
|
+
"TSCallSignatureDeclaration",
|
|
36
|
+
"TSFunctionType",
|
|
37
|
+
"TSMethodSignature",
|
|
38
|
+
"TSEmptyBodyFunctionExpression",
|
|
39
|
+
"TSDeclareFunction",
|
|
40
|
+
"TSConstructSignatureDeclaration",
|
|
41
|
+
"TSConstructorType",
|
|
42
|
+
]);
|
|
22
43
|
|
|
23
44
|
//------------------------------------------------------------------------------
|
|
24
45
|
// Rule Definition
|
|
25
46
|
//------------------------------------------------------------------------------
|
|
26
47
|
|
|
27
|
-
/** @type {import('../
|
|
48
|
+
/** @type {import('../types').Rule.RuleModule} */
|
|
28
49
|
module.exports = {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
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
|
-
|
|
50
|
+
meta: {
|
|
51
|
+
type: "suggestion",
|
|
52
|
+
dialects: ["typescript", "javascript"],
|
|
53
|
+
language: "javascript",
|
|
54
|
+
|
|
55
|
+
defaultOptions: [
|
|
56
|
+
{
|
|
57
|
+
allow: [],
|
|
58
|
+
builtinGlobals: false,
|
|
59
|
+
hoist: "functions",
|
|
60
|
+
ignoreOnInitialization: false,
|
|
61
|
+
ignoreTypeValueShadow: true,
|
|
62
|
+
ignoreFunctionTypeParameterNameValueShadow: true,
|
|
63
|
+
},
|
|
64
|
+
],
|
|
65
|
+
|
|
66
|
+
docs: {
|
|
67
|
+
description:
|
|
68
|
+
"Disallow variable declarations from shadowing variables declared in the outer scope",
|
|
69
|
+
recommended: false,
|
|
70
|
+
url: "https://eslint.org/docs/latest/rules/no-shadow",
|
|
71
|
+
},
|
|
72
|
+
|
|
73
|
+
schema: [
|
|
74
|
+
{
|
|
75
|
+
type: "object",
|
|
76
|
+
properties: {
|
|
77
|
+
builtinGlobals: { type: "boolean" },
|
|
78
|
+
hoist: {
|
|
79
|
+
enum: [
|
|
80
|
+
"all",
|
|
81
|
+
"functions",
|
|
82
|
+
"never",
|
|
83
|
+
"types",
|
|
84
|
+
"functions-and-types",
|
|
85
|
+
],
|
|
86
|
+
},
|
|
87
|
+
allow: {
|
|
88
|
+
type: "array",
|
|
89
|
+
items: {
|
|
90
|
+
type: "string",
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
ignoreOnInitialization: { type: "boolean" },
|
|
94
|
+
ignoreTypeValueShadow: { type: "boolean" },
|
|
95
|
+
ignoreFunctionTypeParameterNameValueShadow: {
|
|
96
|
+
type: "boolean",
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
additionalProperties: false,
|
|
100
|
+
},
|
|
101
|
+
],
|
|
102
|
+
|
|
103
|
+
messages: {
|
|
104
|
+
noShadow:
|
|
105
|
+
"'{{name}}' is already declared in the upper scope on line {{shadowedLine}} column {{shadowedColumn}}.",
|
|
106
|
+
noShadowGlobal: "'{{name}}' is already a global variable.",
|
|
107
|
+
},
|
|
108
|
+
},
|
|
109
|
+
|
|
110
|
+
create(context) {
|
|
111
|
+
const [
|
|
112
|
+
{
|
|
113
|
+
builtinGlobals,
|
|
114
|
+
hoist,
|
|
115
|
+
allow,
|
|
116
|
+
ignoreOnInitialization,
|
|
117
|
+
ignoreTypeValueShadow,
|
|
118
|
+
ignoreFunctionTypeParameterNameValueShadow,
|
|
119
|
+
},
|
|
120
|
+
] = context.options;
|
|
121
|
+
const sourceCode = context.sourceCode;
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Check if a scope is a TypeScript module augmenting the global namespace.
|
|
125
|
+
* @param {Scope} scope The scope to check
|
|
126
|
+
* @returns {boolean} Whether the scope is a global augmentation
|
|
127
|
+
*/
|
|
128
|
+
function isGlobalAugmentation(scope) {
|
|
129
|
+
return (
|
|
130
|
+
scope.block.kind === "global" ||
|
|
131
|
+
(!!scope.upper && isGlobalAugmentation(scope.upper))
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Check if variable is a `this` parameter.
|
|
137
|
+
* @param {Object} variable The variable to check
|
|
138
|
+
* @returns {boolean} Whether the variable is a this parameter
|
|
139
|
+
*/
|
|
140
|
+
function isThisParam(variable) {
|
|
141
|
+
return variable.name === "this";
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Checks if type and value shadows each other
|
|
146
|
+
* @param {Object} variable The variable to check
|
|
147
|
+
* @param {Object} shadowedVariable The shadowed variable
|
|
148
|
+
* @returns {boolean} Whether it's a type/value shadow case to ignore
|
|
149
|
+
*/
|
|
150
|
+
function isTypeValueShadow(variable, shadowedVariable) {
|
|
151
|
+
if (ignoreTypeValueShadow !== true) {
|
|
152
|
+
return false;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
if (!("isValueVariable" in variable)) {
|
|
156
|
+
return false;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const firstDefinition = shadowedVariable.defs[0];
|
|
160
|
+
|
|
161
|
+
// Check if shadowedVariable is a type import
|
|
162
|
+
const isTypeImport =
|
|
163
|
+
firstDefinition &&
|
|
164
|
+
firstDefinition.parent?.type === "ImportDeclaration" &&
|
|
165
|
+
(firstDefinition.parent.importKind === "type" ||
|
|
166
|
+
firstDefinition.parent.specifiers.some(
|
|
167
|
+
s => s.importKind === "type",
|
|
168
|
+
));
|
|
169
|
+
|
|
170
|
+
const isShadowedValue =
|
|
171
|
+
!firstDefinition ||
|
|
172
|
+
(isTypeImport ? false : shadowedVariable.isValueVariable);
|
|
173
|
+
|
|
174
|
+
return variable.isValueVariable !== isShadowedValue;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Checks if it's a function type parameter shadow
|
|
179
|
+
* @param {Object} variable The variable to check
|
|
180
|
+
* @returns {boolean} Whether it's a function type parameter shadow case to ignore
|
|
181
|
+
*/
|
|
182
|
+
function isFunctionTypeParameterNameValueShadow(variable) {
|
|
183
|
+
if (ignoreFunctionTypeParameterNameValueShadow !== true) {
|
|
184
|
+
return false;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
return variable.defs.some(def =>
|
|
188
|
+
ALLOWED_FUNCTION_VARIABLE_DEF_TYPES.has(def.node.type),
|
|
189
|
+
);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* Checks if the variable is a generic of a static method
|
|
194
|
+
* @param {Object} variable The variable to check
|
|
195
|
+
* @returns {boolean} Whether the variable is a generic of a static method
|
|
196
|
+
*/
|
|
197
|
+
function isTypeParameterOfStaticMethod(variable) {
|
|
198
|
+
const typeParameter = variable.identifiers[0].parent;
|
|
199
|
+
const typeParameterDecl = typeParameter.parent;
|
|
200
|
+
if (typeParameterDecl.type !== "TSTypeParameterDeclaration") {
|
|
201
|
+
return false;
|
|
202
|
+
}
|
|
203
|
+
const functionExpr = typeParameterDecl.parent;
|
|
204
|
+
const methodDefinition = functionExpr.parent;
|
|
205
|
+
return methodDefinition.static;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Checks for static method generic shadowing class generic
|
|
210
|
+
* @param {Object} variable The variable to check
|
|
211
|
+
* @returns {boolean} Whether it's a static method generic shadowing class generic
|
|
212
|
+
*/
|
|
213
|
+
function isGenericOfAStaticMethodShadow(variable) {
|
|
214
|
+
return isTypeParameterOfStaticMethod(variable);
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Checks whether or not a given location is inside of the range of a given node.
|
|
219
|
+
* @param {ASTNode} node An node to check.
|
|
220
|
+
* @param {number} location A location to check.
|
|
221
|
+
* @returns {boolean} `true` if the location is inside of the range of the node.
|
|
222
|
+
*/
|
|
223
|
+
function isInRange(node, location) {
|
|
224
|
+
return (
|
|
225
|
+
node && node.range[0] <= location && location <= node.range[1]
|
|
226
|
+
);
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Searches from the current node through its ancestry to find a matching node.
|
|
231
|
+
* @param {ASTNode} node a node to get.
|
|
232
|
+
* @param {(node: ASTNode) => boolean} match a callback that checks whether or not the node verifies its condition or not.
|
|
233
|
+
* @returns {ASTNode|null} the matching node.
|
|
234
|
+
*/
|
|
235
|
+
function findSelfOrAncestor(node, match) {
|
|
236
|
+
let currentNode = node;
|
|
237
|
+
|
|
238
|
+
while (currentNode && !match(currentNode)) {
|
|
239
|
+
currentNode = currentNode.parent;
|
|
240
|
+
}
|
|
241
|
+
return currentNode;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* Finds function's outer scope.
|
|
246
|
+
* @param {Scope} scope Function's own scope.
|
|
247
|
+
* @returns {Scope} Function's outer scope.
|
|
248
|
+
*/
|
|
249
|
+
function getOuterScope(scope) {
|
|
250
|
+
const upper = scope.upper;
|
|
251
|
+
|
|
252
|
+
if (upper && upper.type === "function-expression-name") {
|
|
253
|
+
return upper.upper;
|
|
254
|
+
}
|
|
255
|
+
return upper;
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Checks if a variable and a shadowedVariable have the same init pattern ancestor.
|
|
260
|
+
* @param {Object} variable a variable to check.
|
|
261
|
+
* @param {Object} shadowedVariable a shadowedVariable to check.
|
|
262
|
+
* @returns {boolean} Whether or not the variable and the shadowedVariable have the same init pattern ancestor.
|
|
263
|
+
*/
|
|
264
|
+
function isInitPatternNode(variable, shadowedVariable) {
|
|
265
|
+
const outerDef = shadowedVariable.defs[0];
|
|
266
|
+
|
|
267
|
+
if (!outerDef) {
|
|
268
|
+
return false;
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
const { variableScope } = variable.scope;
|
|
272
|
+
|
|
273
|
+
if (
|
|
274
|
+
!(
|
|
275
|
+
FUNC_EXPR_NODE_TYPES.has(variableScope.block.type) &&
|
|
276
|
+
getOuterScope(variableScope) === shadowedVariable.scope
|
|
277
|
+
)
|
|
278
|
+
) {
|
|
279
|
+
return false;
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
const fun = variableScope.block;
|
|
283
|
+
const { parent } = fun;
|
|
284
|
+
|
|
285
|
+
const callExpression = findSelfOrAncestor(parent, node =>
|
|
286
|
+
CALL_EXPR_NODE_TYPE.has(node.type),
|
|
287
|
+
);
|
|
288
|
+
|
|
289
|
+
if (!callExpression) {
|
|
290
|
+
return false;
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
let node = outerDef.name;
|
|
294
|
+
const location = callExpression.range[1];
|
|
295
|
+
|
|
296
|
+
while (node) {
|
|
297
|
+
if (node.type === "VariableDeclarator") {
|
|
298
|
+
if (isInRange(node.init, location)) {
|
|
299
|
+
return true;
|
|
300
|
+
}
|
|
301
|
+
if (
|
|
302
|
+
FOR_IN_OF_TYPE.test(node.parent.parent.type) &&
|
|
303
|
+
isInRange(node.parent.parent.right, location)
|
|
304
|
+
) {
|
|
305
|
+
return true;
|
|
306
|
+
}
|
|
307
|
+
break;
|
|
308
|
+
} else if (node.type === "AssignmentPattern") {
|
|
309
|
+
if (isInRange(node.right, location)) {
|
|
310
|
+
return true;
|
|
311
|
+
}
|
|
312
|
+
} else if (SENTINEL_TYPE.test(node.type)) {
|
|
313
|
+
break;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
node = node.parent;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
return false;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* Check if variable name is allowed.
|
|
324
|
+
* @param {ASTNode} variable The variable to check.
|
|
325
|
+
* @returns {boolean} Whether or not the variable name is allowed.
|
|
326
|
+
*/
|
|
327
|
+
function isAllowed(variable) {
|
|
328
|
+
return allow.includes(variable.name);
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* Checks if a variable of the class name in the class scope of ClassDeclaration.
|
|
333
|
+
*
|
|
334
|
+
* ClassDeclaration creates two variables of its name into its outer scope and its class scope.
|
|
335
|
+
* So we should ignore the variable in the class scope.
|
|
336
|
+
* @param {Object} variable The variable to check.
|
|
337
|
+
* @returns {boolean} Whether or not the variable of the class name in the class scope of ClassDeclaration.
|
|
338
|
+
*/
|
|
339
|
+
function isDuplicatedClassNameVariable(variable) {
|
|
340
|
+
const block = variable.scope.block;
|
|
341
|
+
|
|
342
|
+
return (
|
|
343
|
+
block.type === "ClassDeclaration" &&
|
|
344
|
+
block.id === variable.identifiers[0]
|
|
345
|
+
);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Checks if a variable is inside the initializer of scopeVar.
|
|
350
|
+
*
|
|
351
|
+
* To avoid reporting at declarations such as `var a = function a() {};`.
|
|
352
|
+
* But it should report `var a = function(a) {};` or `var a = function() { function a() {} };`.
|
|
353
|
+
* @param {Object} variable The variable to check.
|
|
354
|
+
* @param {Object} scopeVar The scope variable to look for.
|
|
355
|
+
* @returns {boolean} Whether or not the variable is inside initializer of scopeVar.
|
|
356
|
+
*/
|
|
357
|
+
function isOnInitializer(variable, scopeVar) {
|
|
358
|
+
const outerScope = scopeVar.scope;
|
|
359
|
+
const outerDef = scopeVar.defs[0];
|
|
360
|
+
const outer = outerDef && outerDef.parent && outerDef.parent.range;
|
|
361
|
+
const innerScope = variable.scope;
|
|
362
|
+
const innerDef = variable.defs[0];
|
|
363
|
+
const inner = innerDef && innerDef.name.range;
|
|
364
|
+
|
|
365
|
+
return (
|
|
366
|
+
outer &&
|
|
367
|
+
inner &&
|
|
368
|
+
outer[0] < inner[0] &&
|
|
369
|
+
inner[1] < outer[1] &&
|
|
370
|
+
((innerDef.type === "FunctionName" &&
|
|
371
|
+
innerDef.node.type === "FunctionExpression") ||
|
|
372
|
+
innerDef.node.type === "ClassExpression") &&
|
|
373
|
+
outerScope === innerScope.upper
|
|
374
|
+
);
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Get a range of a variable's identifier node.
|
|
379
|
+
* @param {Object} variable The variable to get.
|
|
380
|
+
* @returns {Array|undefined} The range of the variable's identifier node.
|
|
381
|
+
*/
|
|
382
|
+
function getNameRange(variable) {
|
|
383
|
+
const def = variable.defs[0];
|
|
384
|
+
|
|
385
|
+
return def && def.name.range;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* Get declared line and column of a variable.
|
|
390
|
+
* @param {eslint-scope.Variable} variable The variable to get.
|
|
391
|
+
* @returns {Object} The declared line and column of the variable.
|
|
392
|
+
*/
|
|
393
|
+
function getDeclaredLocation(variable) {
|
|
394
|
+
const identifier = variable.identifiers[0];
|
|
395
|
+
let obj;
|
|
396
|
+
|
|
397
|
+
if (identifier) {
|
|
398
|
+
obj = {
|
|
399
|
+
global: false,
|
|
400
|
+
line: identifier.loc.start.line,
|
|
401
|
+
column: identifier.loc.start.column + 1,
|
|
402
|
+
};
|
|
403
|
+
} else {
|
|
404
|
+
obj = {
|
|
405
|
+
global: true,
|
|
406
|
+
};
|
|
407
|
+
}
|
|
408
|
+
return obj;
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Checks if a variable is in TDZ of scopeVar.
|
|
413
|
+
* @param {Object} variable The variable to check.
|
|
414
|
+
* @param {Object} scopeVar The variable of TDZ.
|
|
415
|
+
* @returns {boolean} Whether or not the variable is in TDZ of scopeVar.
|
|
416
|
+
*/
|
|
417
|
+
function isInTdz(variable, scopeVar) {
|
|
418
|
+
const outerDef = scopeVar.defs[0];
|
|
419
|
+
const inner = getNameRange(variable);
|
|
420
|
+
const outer = getNameRange(scopeVar);
|
|
421
|
+
|
|
422
|
+
if (!outer || inner[1] >= outer[0]) {
|
|
423
|
+
return false;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
if (hoist === "types") {
|
|
427
|
+
return !TYPES_HOISTED_NODES.has(outerDef.node.type);
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
if (hoist === "functions-and-types") {
|
|
431
|
+
return (
|
|
432
|
+
outerDef.node.type !== "FunctionDeclaration" &&
|
|
433
|
+
!TYPES_HOISTED_NODES.has(outerDef.node.type)
|
|
434
|
+
);
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
return (
|
|
438
|
+
inner &&
|
|
439
|
+
outer &&
|
|
440
|
+
inner[1] < outer[0] &&
|
|
441
|
+
// Excepts FunctionDeclaration if is {"hoist":"function"}.
|
|
442
|
+
(hoist !== "functions" ||
|
|
443
|
+
!outerDef ||
|
|
444
|
+
outerDef.node.type !== "FunctionDeclaration")
|
|
445
|
+
);
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* Checks if the initialization of a variable has the declare modifier in a
|
|
450
|
+
* definition file.
|
|
451
|
+
* @param {Object} variable The variable to check
|
|
452
|
+
* @returns {boolean} Whether the variable is declared in a definition file
|
|
453
|
+
*/
|
|
454
|
+
function isDeclareInDTSFile(variable) {
|
|
455
|
+
const fileName = context.filename;
|
|
456
|
+
if (
|
|
457
|
+
!fileName.endsWith(".d.ts") &&
|
|
458
|
+
!fileName.endsWith(".d.cts") &&
|
|
459
|
+
!fileName.endsWith(".d.mts")
|
|
460
|
+
) {
|
|
461
|
+
return false;
|
|
462
|
+
}
|
|
463
|
+
return variable.defs.some(
|
|
464
|
+
def =>
|
|
465
|
+
(def.type === "Variable" && def.parent.declare) ||
|
|
466
|
+
(def.type === "ClassName" && def.node.declare) ||
|
|
467
|
+
(def.type === "TSEnumName" && def.node.declare) ||
|
|
468
|
+
(def.type === "TSModuleName" && def.node.declare),
|
|
469
|
+
);
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* Checks if a variable is a duplicate of an enum name in the enum scope
|
|
474
|
+
* @param {Object} variable The variable to check
|
|
475
|
+
* @returns {boolean} Whether it's a duplicate enum name variable
|
|
476
|
+
*/
|
|
477
|
+
function isDuplicatedEnumNameVariable(variable) {
|
|
478
|
+
const block = variable.scope.block;
|
|
479
|
+
|
|
480
|
+
return (
|
|
481
|
+
block.type === "TSEnumDeclaration" &&
|
|
482
|
+
block.id === variable.identifiers[0]
|
|
483
|
+
);
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Check if this is an external module declaration merging with a type import
|
|
488
|
+
* @param {Scope} scope Current scope
|
|
489
|
+
* @param {Object} variable Current variable
|
|
490
|
+
* @param {Object} shadowedVariable Shadowed variable
|
|
491
|
+
* @returns {boolean} Whether it's an external declaration merging
|
|
492
|
+
*/
|
|
493
|
+
function isExternalDeclarationMerging(
|
|
494
|
+
scope,
|
|
495
|
+
variable,
|
|
496
|
+
shadowedVariable,
|
|
497
|
+
) {
|
|
498
|
+
const firstDefinition = shadowedVariable.defs[0];
|
|
499
|
+
|
|
500
|
+
if (!firstDefinition || !firstDefinition.parent) {
|
|
501
|
+
return false;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
// Check if the shadowed variable is a type import
|
|
505
|
+
const isTypeImport =
|
|
506
|
+
firstDefinition.parent.type === "ImportDeclaration" &&
|
|
507
|
+
(firstDefinition.parent.importKind === "type" ||
|
|
508
|
+
firstDefinition.parent.specifiers?.some(
|
|
509
|
+
s =>
|
|
510
|
+
s.type === "ImportSpecifier" &&
|
|
511
|
+
s.importKind === "type" &&
|
|
512
|
+
s.local.name === shadowedVariable.name,
|
|
513
|
+
));
|
|
514
|
+
|
|
515
|
+
if (!isTypeImport) {
|
|
516
|
+
return false;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
// Check if the current variable is within a module declaration
|
|
520
|
+
const moduleDecl = findSelfOrAncestor(
|
|
521
|
+
variable.identifiers[0]?.parent,
|
|
522
|
+
node => node.type === "TSModuleDeclaration",
|
|
523
|
+
);
|
|
524
|
+
|
|
525
|
+
if (!moduleDecl) {
|
|
526
|
+
return false;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/*
|
|
530
|
+
* Module declaration merging should only happen within the same module
|
|
531
|
+
* Check if the module name matches the import source
|
|
532
|
+
*/
|
|
533
|
+
const importSource = firstDefinition.parent.source.value;
|
|
534
|
+
const moduleName =
|
|
535
|
+
moduleDecl.id.type === "Literal"
|
|
536
|
+
? moduleDecl.id.value
|
|
537
|
+
: moduleDecl.id.name;
|
|
538
|
+
|
|
539
|
+
return importSource === moduleName;
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
/**
|
|
543
|
+
* Checks the current context for shadowed variables.
|
|
544
|
+
* @param {Scope} scope Fixme
|
|
545
|
+
* @returns {void}
|
|
546
|
+
*/
|
|
547
|
+
function checkForShadows(scope) {
|
|
548
|
+
// ignore global augmentation
|
|
549
|
+
if (isGlobalAugmentation(scope)) {
|
|
550
|
+
return;
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
const variables = scope.variables;
|
|
554
|
+
|
|
555
|
+
for (let i = 0; i < variables.length; ++i) {
|
|
556
|
+
const variable = variables[i];
|
|
557
|
+
|
|
558
|
+
// Skips "arguments" or variables of a class name in the class scope of ClassDeclaration.
|
|
559
|
+
if (
|
|
560
|
+
variable.identifiers.length === 0 ||
|
|
561
|
+
isDuplicatedClassNameVariable(variable) ||
|
|
562
|
+
isDuplicatedEnumNameVariable(variable) ||
|
|
563
|
+
isAllowed(variable) ||
|
|
564
|
+
isDeclareInDTSFile(variable) ||
|
|
565
|
+
isThisParam(variable)
|
|
566
|
+
) {
|
|
567
|
+
continue;
|
|
568
|
+
}
|
|
569
|
+
|
|
570
|
+
// Gets shadowed variable.
|
|
571
|
+
const shadowed = astUtils.getVariableByName(
|
|
572
|
+
scope.upper,
|
|
573
|
+
variable.name,
|
|
574
|
+
);
|
|
575
|
+
|
|
576
|
+
if (
|
|
577
|
+
shadowed &&
|
|
578
|
+
(shadowed.identifiers.length > 0 ||
|
|
579
|
+
(builtinGlobals && "writeable" in shadowed)) &&
|
|
580
|
+
!isOnInitializer(variable, shadowed) &&
|
|
581
|
+
!(
|
|
582
|
+
ignoreOnInitialization &&
|
|
583
|
+
isInitPatternNode(variable, shadowed)
|
|
584
|
+
) &&
|
|
585
|
+
!(hoist !== "all" && isInTdz(variable, shadowed)) &&
|
|
586
|
+
!isTypeValueShadow(variable, shadowed) &&
|
|
587
|
+
!isFunctionTypeParameterNameValueShadow(variable) &&
|
|
588
|
+
!isGenericOfAStaticMethodShadow(variable, shadowed) &&
|
|
589
|
+
!isExternalDeclarationMerging(scope, variable, shadowed)
|
|
590
|
+
) {
|
|
591
|
+
const location = getDeclaredLocation(shadowed);
|
|
592
|
+
const messageId = location.global
|
|
593
|
+
? "noShadowGlobal"
|
|
594
|
+
: "noShadow";
|
|
595
|
+
const data = { name: variable.name };
|
|
596
|
+
|
|
597
|
+
if (!location.global) {
|
|
598
|
+
data.shadowedLine = location.line;
|
|
599
|
+
data.shadowedColumn = location.column;
|
|
600
|
+
}
|
|
601
|
+
context.report({
|
|
602
|
+
node: variable.identifiers[0],
|
|
603
|
+
messageId,
|
|
604
|
+
data,
|
|
605
|
+
});
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
}
|
|
609
|
+
|
|
610
|
+
return {
|
|
611
|
+
"Program:exit"(node) {
|
|
612
|
+
const globalScope = sourceCode.getScope(node);
|
|
613
|
+
const stack = globalScope.childScopes.slice();
|
|
614
|
+
|
|
615
|
+
while (stack.length) {
|
|
616
|
+
const scope = stack.pop();
|
|
617
|
+
|
|
618
|
+
stack.push(...scope.childScopes);
|
|
619
|
+
checkForShadows(scope);
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
};
|
|
623
|
+
},
|
|
336
624
|
};
|