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/cli.js
CHANGED
|
@@ -15,217 +15,73 @@
|
|
|
15
15
|
// Requirements
|
|
16
16
|
//------------------------------------------------------------------------------
|
|
17
17
|
|
|
18
|
-
const fs = require("fs"),
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
18
|
+
const fs = require("node:fs"),
|
|
19
|
+
{ mkdir, stat, writeFile } = require("node:fs/promises"),
|
|
20
|
+
path = require("node:path"),
|
|
21
|
+
{ pathToFileURL } = require("node:url"),
|
|
22
|
+
{ LegacyESLint } = require("./eslint"),
|
|
23
|
+
{
|
|
24
|
+
ESLint,
|
|
25
|
+
shouldUseFlatConfig,
|
|
26
|
+
locateConfigFileToUse,
|
|
27
|
+
} = require("./eslint/eslint"),
|
|
28
|
+
createCLIOptions = require("./options"),
|
|
29
|
+
log = require("./shared/logging"),
|
|
30
|
+
RuntimeInfo = require("./shared/runtime-info"),
|
|
31
|
+
translateOptions = require("./shared/translate-cli-options");
|
|
32
|
+
const { getCacheFile } = require("./eslint/eslint-helpers");
|
|
33
|
+
const { SuppressionsService } = require("./services/suppressions-service");
|
|
30
34
|
const debug = require("debug")("eslint:cli");
|
|
31
35
|
|
|
32
36
|
//------------------------------------------------------------------------------
|
|
33
37
|
// Types
|
|
34
38
|
//------------------------------------------------------------------------------
|
|
35
39
|
|
|
36
|
-
/** @typedef {import("./eslint/eslint").ESLintOptions} ESLintOptions */
|
|
37
|
-
/** @typedef {import("./eslint/eslint").LintMessage} LintMessage */
|
|
38
|
-
/** @typedef {import("./eslint/eslint").LintResult} LintResult */
|
|
39
40
|
/** @typedef {import("./options").ParsedCLIOptions} ParsedCLIOptions */
|
|
40
|
-
/** @typedef {import("./
|
|
41
|
+
/** @typedef {import("./types").ESLint.LintResult} LintResult */
|
|
42
|
+
/** @typedef {import("./types").ESLint.ResultsMeta} ResultsMeta */
|
|
41
43
|
|
|
42
44
|
//------------------------------------------------------------------------------
|
|
43
45
|
// Helpers
|
|
44
46
|
//------------------------------------------------------------------------------
|
|
45
47
|
|
|
46
|
-
const mkdir = promisify(fs.mkdir);
|
|
47
|
-
const stat = promisify(fs.stat);
|
|
48
|
-
const writeFile = promisify(fs.writeFile);
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Predicate function for whether or not to apply fixes in quiet mode.
|
|
52
|
-
* If a message is a warning, do not apply a fix.
|
|
53
|
-
* @param {LintMessage} message The lint result.
|
|
54
|
-
* @returns {boolean} True if the lint message is an error (and thus should be
|
|
55
|
-
* autofixed), false otherwise.
|
|
56
|
-
*/
|
|
57
|
-
function quietFixPredicate(message) {
|
|
58
|
-
return message.severity === 2;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Translates the CLI options into the options expected by the ESLint constructor.
|
|
63
|
-
* @param {ParsedCLIOptions} cliOptions The CLI options to translate.
|
|
64
|
-
* @param {"flat"|"eslintrc"} [configType="eslintrc"] The format of the
|
|
65
|
-
* config to generate.
|
|
66
|
-
* @returns {Promise<ESLintOptions>} The options object for the ESLint constructor.
|
|
67
|
-
* @private
|
|
68
|
-
*/
|
|
69
|
-
async function translateOptions({
|
|
70
|
-
cache,
|
|
71
|
-
cacheFile,
|
|
72
|
-
cacheLocation,
|
|
73
|
-
cacheStrategy,
|
|
74
|
-
config,
|
|
75
|
-
configLookup,
|
|
76
|
-
env,
|
|
77
|
-
errorOnUnmatchedPattern,
|
|
78
|
-
eslintrc,
|
|
79
|
-
ext,
|
|
80
|
-
fix,
|
|
81
|
-
fixDryRun,
|
|
82
|
-
fixType,
|
|
83
|
-
global,
|
|
84
|
-
ignore,
|
|
85
|
-
ignorePath,
|
|
86
|
-
ignorePattern,
|
|
87
|
-
inlineConfig,
|
|
88
|
-
parser,
|
|
89
|
-
parserOptions,
|
|
90
|
-
plugin,
|
|
91
|
-
quiet,
|
|
92
|
-
reportUnusedDisableDirectives,
|
|
93
|
-
reportUnusedDisableDirectivesSeverity,
|
|
94
|
-
resolvePluginsRelativeTo,
|
|
95
|
-
rule,
|
|
96
|
-
rulesdir,
|
|
97
|
-
warnIgnored
|
|
98
|
-
}, configType) {
|
|
99
|
-
|
|
100
|
-
let overrideConfig, overrideConfigFile;
|
|
101
|
-
const importer = new ModuleImporter();
|
|
102
|
-
|
|
103
|
-
if (configType === "flat") {
|
|
104
|
-
overrideConfigFile = (typeof config === "string") ? config : !configLookup;
|
|
105
|
-
if (overrideConfigFile === false) {
|
|
106
|
-
overrideConfigFile = void 0;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
let globals = {};
|
|
110
|
-
|
|
111
|
-
if (global) {
|
|
112
|
-
globals = global.reduce((obj, name) => {
|
|
113
|
-
if (name.endsWith(":true")) {
|
|
114
|
-
obj[name.slice(0, -5)] = "writable";
|
|
115
|
-
} else {
|
|
116
|
-
obj[name] = "readonly";
|
|
117
|
-
}
|
|
118
|
-
return obj;
|
|
119
|
-
}, globals);
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
overrideConfig = [{
|
|
123
|
-
languageOptions: {
|
|
124
|
-
globals,
|
|
125
|
-
parserOptions: parserOptions || {}
|
|
126
|
-
},
|
|
127
|
-
rules: rule ? rule : {}
|
|
128
|
-
}];
|
|
129
|
-
|
|
130
|
-
if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
|
|
131
|
-
overrideConfig[0].linterOptions = {
|
|
132
|
-
reportUnusedDisableDirectives: reportUnusedDisableDirectives
|
|
133
|
-
? "error"
|
|
134
|
-
: normalizeSeverityToString(reportUnusedDisableDirectivesSeverity)
|
|
135
|
-
};
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
if (parser) {
|
|
139
|
-
overrideConfig[0].languageOptions.parser = await importer.import(parser);
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
if (plugin) {
|
|
143
|
-
const plugins = {};
|
|
144
|
-
|
|
145
|
-
for (const pluginName of plugin) {
|
|
146
|
-
|
|
147
|
-
const shortName = naming.getShorthandName(pluginName, "eslint-plugin");
|
|
148
|
-
const longName = naming.normalizePackageName(pluginName, "eslint-plugin");
|
|
149
|
-
|
|
150
|
-
plugins[shortName] = await importer.import(longName);
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
overrideConfig[0].plugins = plugins;
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
} else {
|
|
157
|
-
overrideConfigFile = config;
|
|
158
|
-
|
|
159
|
-
overrideConfig = {
|
|
160
|
-
env: env && env.reduce((obj, name) => {
|
|
161
|
-
obj[name] = true;
|
|
162
|
-
return obj;
|
|
163
|
-
}, {}),
|
|
164
|
-
globals: global && global.reduce((obj, name) => {
|
|
165
|
-
if (name.endsWith(":true")) {
|
|
166
|
-
obj[name.slice(0, -5)] = "writable";
|
|
167
|
-
} else {
|
|
168
|
-
obj[name] = "readonly";
|
|
169
|
-
}
|
|
170
|
-
return obj;
|
|
171
|
-
}, {}),
|
|
172
|
-
ignorePatterns: ignorePattern,
|
|
173
|
-
parser,
|
|
174
|
-
parserOptions,
|
|
175
|
-
plugins: plugin,
|
|
176
|
-
rules: rule
|
|
177
|
-
};
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
const options = {
|
|
181
|
-
allowInlineConfig: inlineConfig,
|
|
182
|
-
cache,
|
|
183
|
-
cacheLocation: cacheLocation || cacheFile,
|
|
184
|
-
cacheStrategy,
|
|
185
|
-
errorOnUnmatchedPattern,
|
|
186
|
-
fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
|
|
187
|
-
fixTypes: fixType,
|
|
188
|
-
ignore,
|
|
189
|
-
overrideConfig,
|
|
190
|
-
overrideConfigFile
|
|
191
|
-
};
|
|
192
|
-
|
|
193
|
-
if (configType === "flat") {
|
|
194
|
-
options.ignorePatterns = ignorePattern;
|
|
195
|
-
options.warnIgnored = warnIgnored;
|
|
196
|
-
} else {
|
|
197
|
-
options.resolvePluginsRelativeTo = resolvePluginsRelativeTo;
|
|
198
|
-
options.rulePaths = rulesdir;
|
|
199
|
-
options.useEslintrc = eslintrc;
|
|
200
|
-
options.extensions = ext;
|
|
201
|
-
options.ignorePath = ignorePath;
|
|
202
|
-
if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
|
|
203
|
-
options.reportUnusedDisableDirectives = reportUnusedDisableDirectives
|
|
204
|
-
? "error"
|
|
205
|
-
: normalizeSeverityToString(reportUnusedDisableDirectivesSeverity);
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
return options;
|
|
210
|
-
}
|
|
211
|
-
|
|
212
48
|
/**
|
|
213
49
|
* Count error messages.
|
|
214
50
|
* @param {LintResult[]} results The lint results.
|
|
215
51
|
* @returns {{errorCount:number;fatalErrorCount:number,warningCount:number}} The number of error messages.
|
|
216
52
|
*/
|
|
217
53
|
function countErrors(results) {
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
54
|
+
let errorCount = 0;
|
|
55
|
+
let fatalErrorCount = 0;
|
|
56
|
+
let warningCount = 0;
|
|
57
|
+
|
|
58
|
+
for (const result of results) {
|
|
59
|
+
errorCount += result.errorCount;
|
|
60
|
+
fatalErrorCount += result.fatalErrorCount;
|
|
61
|
+
warningCount += result.warningCount;
|
|
62
|
+
}
|
|
221
63
|
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
fatalErrorCount += result.fatalErrorCount;
|
|
225
|
-
warningCount += result.warningCount;
|
|
226
|
-
}
|
|
64
|
+
return { errorCount, fatalErrorCount, warningCount };
|
|
65
|
+
}
|
|
227
66
|
|
|
228
|
-
|
|
67
|
+
/**
|
|
68
|
+
* Creates an options module from the provided CLI options and encodes it as a data URL.
|
|
69
|
+
* @param {ParsedCLIOptions} options The CLI options.
|
|
70
|
+
* @returns {URL} The URL of the options module.
|
|
71
|
+
*/
|
|
72
|
+
function createOptionsModule(options) {
|
|
73
|
+
const translateOptionsFileURL = new URL(
|
|
74
|
+
"./shared/translate-cli-options.js",
|
|
75
|
+
pathToFileURL(__filename),
|
|
76
|
+
).href;
|
|
77
|
+
const optionsSrc =
|
|
78
|
+
`import translateOptions from ${JSON.stringify(translateOptionsFileURL)};\n` +
|
|
79
|
+
`export default await translateOptions(${JSON.stringify(options)}, "flat");\n`;
|
|
80
|
+
|
|
81
|
+
// Base64 encoding is typically shorter than URL encoding
|
|
82
|
+
return new URL(
|
|
83
|
+
`data:text/javascript;base64,${Buffer.from(optionsSrc).toString("base64")}`,
|
|
84
|
+
);
|
|
229
85
|
}
|
|
230
86
|
|
|
231
87
|
/**
|
|
@@ -234,14 +90,14 @@ function countErrors(results) {
|
|
|
234
90
|
* @returns {Promise<boolean>} `true` if the given path is a directory.
|
|
235
91
|
*/
|
|
236
92
|
async function isDirectory(filePath) {
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
93
|
+
try {
|
|
94
|
+
return (await stat(filePath)).isDirectory();
|
|
95
|
+
} catch (error) {
|
|
96
|
+
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
|
|
97
|
+
return false;
|
|
98
|
+
}
|
|
99
|
+
throw error;
|
|
100
|
+
}
|
|
245
101
|
}
|
|
246
102
|
|
|
247
103
|
/**
|
|
@@ -255,39 +111,64 @@ async function isDirectory(filePath) {
|
|
|
255
111
|
* @private
|
|
256
112
|
*/
|
|
257
113
|
async function printResults(engine, results, format, outputFile, resultsMeta) {
|
|
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
|
-
|
|
114
|
+
let formatter;
|
|
115
|
+
|
|
116
|
+
try {
|
|
117
|
+
formatter = await engine.loadFormatter(format);
|
|
118
|
+
} catch (e) {
|
|
119
|
+
log.error(e.message);
|
|
120
|
+
return false;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
const output = await formatter.format(results, resultsMeta);
|
|
124
|
+
|
|
125
|
+
if (outputFile) {
|
|
126
|
+
const filePath = path.resolve(process.cwd(), outputFile);
|
|
127
|
+
|
|
128
|
+
if (await isDirectory(filePath)) {
|
|
129
|
+
log.error(
|
|
130
|
+
"Cannot write to output file path, it is a directory: %s",
|
|
131
|
+
outputFile,
|
|
132
|
+
);
|
|
133
|
+
return false;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
try {
|
|
137
|
+
await mkdir(path.dirname(filePath), { recursive: true });
|
|
138
|
+
await writeFile(filePath, output);
|
|
139
|
+
} catch (ex) {
|
|
140
|
+
log.error("There was a problem writing the output file:\n%s", ex);
|
|
141
|
+
return false;
|
|
142
|
+
}
|
|
143
|
+
} else if (output) {
|
|
144
|
+
log.info(output);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
return true;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Validates the `--concurrency` flag value.
|
|
152
|
+
* @param {string} concurrency The `--concurrency` flag value to validate.
|
|
153
|
+
* @returns {void}
|
|
154
|
+
* @throws {Error} If the `--concurrency` flag value is invalid.
|
|
155
|
+
*/
|
|
156
|
+
function validateConcurrency(concurrency) {
|
|
157
|
+
if (
|
|
158
|
+
concurrency === void 0 ||
|
|
159
|
+
concurrency === "auto" ||
|
|
160
|
+
concurrency === "off"
|
|
161
|
+
) {
|
|
162
|
+
return;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
const concurrencyValue = Number(concurrency);
|
|
166
|
+
|
|
167
|
+
if (!Number.isInteger(concurrencyValue) || concurrencyValue < 1) {
|
|
168
|
+
throw new Error(
|
|
169
|
+
`Option concurrency: '${concurrency}' is not a positive integer, 'auto' or 'off'.`,
|
|
170
|
+
);
|
|
171
|
+
}
|
|
291
172
|
}
|
|
292
173
|
|
|
293
174
|
//------------------------------------------------------------------------------
|
|
@@ -299,173 +180,374 @@ async function printResults(engine, results, format, outputFile, resultsMeta) {
|
|
|
299
180
|
* for other Node.js programs to effectively run the CLI.
|
|
300
181
|
*/
|
|
301
182
|
const cli = {
|
|
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
|
-
|
|
183
|
+
/**
|
|
184
|
+
* Calculates the command string for the --inspect-config operation.
|
|
185
|
+
* @param {string} configFile The path to the config file to inspect.
|
|
186
|
+
* @returns {Promise<string>} The command string to execute.
|
|
187
|
+
*/
|
|
188
|
+
async calculateInspectConfigFlags(configFile) {
|
|
189
|
+
// find the config file
|
|
190
|
+
const { configFilePath, basePath } = await locateConfigFileToUse({
|
|
191
|
+
cwd: process.cwd(),
|
|
192
|
+
configFile,
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
return ["--config", configFilePath, "--basePath", basePath];
|
|
196
|
+
},
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Executes the CLI based on an array of arguments that is passed in.
|
|
200
|
+
* @param {string|Array|Object} args The arguments to process.
|
|
201
|
+
* @param {string} [text] The text to lint (used for TTY).
|
|
202
|
+
* @param {boolean} [allowFlatConfig=true] Whether or not to allow flat config.
|
|
203
|
+
* @returns {Promise<number>} The exit code for the operation.
|
|
204
|
+
*/
|
|
205
|
+
async execute(args, text, allowFlatConfig = true) {
|
|
206
|
+
if (Array.isArray(args)) {
|
|
207
|
+
debug("CLI args: %o", args.slice(2));
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/*
|
|
211
|
+
* Before doing anything, we need to see if we are using a
|
|
212
|
+
* flat config file. If so, then we need to change the way command
|
|
213
|
+
* line args are parsed. This is temporary, and when we fully
|
|
214
|
+
* switch to flat config we can remove this logic.
|
|
215
|
+
*/
|
|
216
|
+
|
|
217
|
+
const usingFlatConfig =
|
|
218
|
+
allowFlatConfig && (await shouldUseFlatConfig());
|
|
219
|
+
|
|
220
|
+
debug("Using flat config?", usingFlatConfig);
|
|
221
|
+
|
|
222
|
+
if (allowFlatConfig && !usingFlatConfig) {
|
|
223
|
+
const { WarningService } = require("./services/warning-service");
|
|
224
|
+
new WarningService().emitESLintRCWarning();
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
const CLIOptions = createCLIOptions(usingFlatConfig);
|
|
228
|
+
|
|
229
|
+
/** @type {ParsedCLIOptions} */
|
|
230
|
+
let options;
|
|
231
|
+
|
|
232
|
+
try {
|
|
233
|
+
options = CLIOptions.parse(args);
|
|
234
|
+
validateConcurrency(options.concurrency);
|
|
235
|
+
} catch (error) {
|
|
236
|
+
debug("Error parsing CLI options:", error.message);
|
|
237
|
+
|
|
238
|
+
let errorMessage = error.message;
|
|
239
|
+
|
|
240
|
+
if (usingFlatConfig) {
|
|
241
|
+
errorMessage +=
|
|
242
|
+
"\nYou're using eslint.config.js, some command line flags are no longer available. Please see https://eslint.org/docs/latest/use/command-line-interface for details.";
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
log.error(errorMessage);
|
|
246
|
+
return 2;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
const files = options._;
|
|
250
|
+
const useStdin = typeof text === "string";
|
|
251
|
+
|
|
252
|
+
if (options.help) {
|
|
253
|
+
log.info(CLIOptions.generateHelp());
|
|
254
|
+
return 0;
|
|
255
|
+
}
|
|
256
|
+
if (options.version) {
|
|
257
|
+
log.info(RuntimeInfo.version());
|
|
258
|
+
return 0;
|
|
259
|
+
}
|
|
260
|
+
if (options.envInfo) {
|
|
261
|
+
try {
|
|
262
|
+
log.info(RuntimeInfo.environment());
|
|
263
|
+
return 0;
|
|
264
|
+
} catch (err) {
|
|
265
|
+
debug("Error retrieving environment info");
|
|
266
|
+
log.error(err.message);
|
|
267
|
+
return 2;
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
if (options.printConfig) {
|
|
272
|
+
if (files.length) {
|
|
273
|
+
log.error(
|
|
274
|
+
"The --print-config option must be used with exactly one file name.",
|
|
275
|
+
);
|
|
276
|
+
return 2;
|
|
277
|
+
}
|
|
278
|
+
if (useStdin) {
|
|
279
|
+
log.error(
|
|
280
|
+
"The --print-config option is not available for piped-in code.",
|
|
281
|
+
);
|
|
282
|
+
return 2;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
const engine = usingFlatConfig
|
|
286
|
+
? new ESLint(await translateOptions(options, "flat"))
|
|
287
|
+
: new LegacyESLint(await translateOptions(options));
|
|
288
|
+
const fileConfig = await engine.calculateConfigForFile(
|
|
289
|
+
options.printConfig,
|
|
290
|
+
);
|
|
291
|
+
|
|
292
|
+
log.info(JSON.stringify(fileConfig, null, " "));
|
|
293
|
+
return 0;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
if (options.inspectConfig) {
|
|
297
|
+
log.info(
|
|
298
|
+
"You can also run this command directly using 'npx @eslint/config-inspector@latest' in the same directory as your configuration file.",
|
|
299
|
+
);
|
|
300
|
+
|
|
301
|
+
try {
|
|
302
|
+
const flatOptions = await translateOptions(options, "flat");
|
|
303
|
+
const spawn = require("cross-spawn");
|
|
304
|
+
const flags = await cli.calculateInspectConfigFlags(
|
|
305
|
+
flatOptions.overrideConfigFile,
|
|
306
|
+
);
|
|
307
|
+
|
|
308
|
+
spawn.sync(
|
|
309
|
+
"npx",
|
|
310
|
+
["@eslint/config-inspector@latest", ...flags],
|
|
311
|
+
{ encoding: "utf8", stdio: "inherit" },
|
|
312
|
+
);
|
|
313
|
+
} catch (error) {
|
|
314
|
+
log.error(error);
|
|
315
|
+
return 2;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
return 0;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
debug(`Running on ${useStdin ? "text" : "files"}`);
|
|
322
|
+
|
|
323
|
+
if (options.fix && options.fixDryRun) {
|
|
324
|
+
log.error(
|
|
325
|
+
"The --fix option and the --fix-dry-run option cannot be used together.",
|
|
326
|
+
);
|
|
327
|
+
return 2;
|
|
328
|
+
}
|
|
329
|
+
if (useStdin && options.fix) {
|
|
330
|
+
log.error(
|
|
331
|
+
"The --fix option is not available for piped-in code; use --fix-dry-run instead.",
|
|
332
|
+
);
|
|
333
|
+
return 2;
|
|
334
|
+
}
|
|
335
|
+
if (options.fixType && !options.fix && !options.fixDryRun) {
|
|
336
|
+
log.error(
|
|
337
|
+
"The --fix-type option requires either --fix or --fix-dry-run.",
|
|
338
|
+
);
|
|
339
|
+
return 2;
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
if (
|
|
343
|
+
options.reportUnusedDisableDirectives &&
|
|
344
|
+
options.reportUnusedDisableDirectivesSeverity !== void 0
|
|
345
|
+
) {
|
|
346
|
+
log.error(
|
|
347
|
+
"The --report-unused-disable-directives option and the --report-unused-disable-directives-severity option cannot be used together.",
|
|
348
|
+
);
|
|
349
|
+
return 2;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
if (usingFlatConfig && options.ext) {
|
|
353
|
+
// Passing `--ext ""` results in `options.ext` being an empty array.
|
|
354
|
+
if (options.ext.length === 0) {
|
|
355
|
+
log.error("The --ext option value cannot be empty.");
|
|
356
|
+
return 2;
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
// Passing `--ext ,ts` results in an empty string at index 0. Passing `--ext ts,,tsx` results in an empty string at index 1.
|
|
360
|
+
const emptyStringIndex = options.ext.indexOf("");
|
|
361
|
+
|
|
362
|
+
if (emptyStringIndex >= 0) {
|
|
363
|
+
log.error(
|
|
364
|
+
`The --ext option arguments cannot be empty strings. Found an empty string at index ${emptyStringIndex}.`,
|
|
365
|
+
);
|
|
366
|
+
return 2;
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
if (options.suppressAll && options.suppressRule) {
|
|
371
|
+
log.error(
|
|
372
|
+
"The --suppress-all option and the --suppress-rule option cannot be used together.",
|
|
373
|
+
);
|
|
374
|
+
return 2;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
if (options.suppressAll && options.pruneSuppressions) {
|
|
378
|
+
log.error(
|
|
379
|
+
"The --suppress-all option and the --prune-suppressions option cannot be used together.",
|
|
380
|
+
);
|
|
381
|
+
return 2;
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
if (options.suppressRule && options.pruneSuppressions) {
|
|
385
|
+
log.error(
|
|
386
|
+
"The --suppress-rule option and the --prune-suppressions option cannot be used together.",
|
|
387
|
+
);
|
|
388
|
+
return 2;
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
if (
|
|
392
|
+
useStdin &&
|
|
393
|
+
(options.suppressAll ||
|
|
394
|
+
options.suppressRule ||
|
|
395
|
+
options.pruneSuppressions)
|
|
396
|
+
) {
|
|
397
|
+
log.error(
|
|
398
|
+
"The --suppress-all, --suppress-rule, and --prune-suppressions options cannot be used with piped-in code.",
|
|
399
|
+
);
|
|
400
|
+
return 2;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
const ActiveESLint = usingFlatConfig ? ESLint : LegacyESLint;
|
|
404
|
+
|
|
405
|
+
/** @type {ESLint|LegacyESLint} */
|
|
406
|
+
let engine;
|
|
407
|
+
|
|
408
|
+
if (options.concurrency && options.concurrency !== "off") {
|
|
409
|
+
const optionsURL = createOptionsModule(options);
|
|
410
|
+
engine = await ESLint.fromOptionsModule(optionsURL);
|
|
411
|
+
} else {
|
|
412
|
+
const eslintOptions = await translateOptions(
|
|
413
|
+
options,
|
|
414
|
+
usingFlatConfig ? "flat" : "eslintrc",
|
|
415
|
+
);
|
|
416
|
+
engine = new ActiveESLint(eslintOptions);
|
|
417
|
+
}
|
|
418
|
+
let results;
|
|
419
|
+
|
|
420
|
+
if (useStdin) {
|
|
421
|
+
results = await engine.lintText(text, {
|
|
422
|
+
filePath: options.stdinFilename,
|
|
423
|
+
|
|
424
|
+
// flatConfig respects CLI flag and constructor warnIgnored, eslintrc forces true for backwards compatibility
|
|
425
|
+
warnIgnored: usingFlatConfig ? void 0 : true,
|
|
426
|
+
});
|
|
427
|
+
} else {
|
|
428
|
+
results = await engine.lintFiles(files);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
if (options.fix) {
|
|
432
|
+
debug("Fix mode enabled - applying fixes");
|
|
433
|
+
await ActiveESLint.outputFixes(results);
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
let unusedSuppressions = {};
|
|
437
|
+
|
|
438
|
+
if (!useStdin) {
|
|
439
|
+
const suppressionsFileLocation = getCacheFile(
|
|
440
|
+
options.suppressionsLocation || "eslint-suppressions.json",
|
|
441
|
+
process.cwd(),
|
|
442
|
+
{
|
|
443
|
+
prefix: "suppressions_",
|
|
444
|
+
},
|
|
445
|
+
);
|
|
446
|
+
|
|
447
|
+
if (
|
|
448
|
+
options.suppressionsLocation &&
|
|
449
|
+
!fs.existsSync(suppressionsFileLocation) &&
|
|
450
|
+
!options.suppressAll &&
|
|
451
|
+
!options.suppressRule
|
|
452
|
+
) {
|
|
453
|
+
log.error(
|
|
454
|
+
"The suppressions file does not exist. Please run the command with `--suppress-all` or `--suppress-rule` to create it.",
|
|
455
|
+
);
|
|
456
|
+
return 2;
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
if (
|
|
460
|
+
options.suppressAll ||
|
|
461
|
+
options.suppressRule ||
|
|
462
|
+
options.pruneSuppressions ||
|
|
463
|
+
fs.existsSync(suppressionsFileLocation)
|
|
464
|
+
) {
|
|
465
|
+
const suppressions = new SuppressionsService({
|
|
466
|
+
filePath: suppressionsFileLocation,
|
|
467
|
+
cwd: process.cwd(),
|
|
468
|
+
});
|
|
469
|
+
|
|
470
|
+
if (options.suppressAll || options.suppressRule) {
|
|
471
|
+
await suppressions.suppress(results, options.suppressRule);
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
if (options.pruneSuppressions) {
|
|
475
|
+
await suppressions.prune(results);
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
const suppressionResults = suppressions.applySuppressions(
|
|
479
|
+
results,
|
|
480
|
+
await suppressions.load(),
|
|
481
|
+
);
|
|
482
|
+
|
|
483
|
+
results = suppressionResults.results;
|
|
484
|
+
unusedSuppressions = suppressionResults.unused;
|
|
485
|
+
}
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
let resultsToPrint = results;
|
|
489
|
+
|
|
490
|
+
if (options.quiet) {
|
|
491
|
+
debug("Quiet mode enabled - filtering out warnings");
|
|
492
|
+
resultsToPrint = ActiveESLint.getErrorResults(resultsToPrint);
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
const resultCounts = countErrors(results);
|
|
496
|
+
const tooManyWarnings =
|
|
497
|
+
options.maxWarnings >= 0 &&
|
|
498
|
+
resultCounts.warningCount > options.maxWarnings;
|
|
499
|
+
const resultsMeta = tooManyWarnings
|
|
500
|
+
? {
|
|
501
|
+
maxWarningsExceeded: {
|
|
502
|
+
maxWarnings: options.maxWarnings,
|
|
503
|
+
foundWarnings: resultCounts.warningCount,
|
|
504
|
+
},
|
|
505
|
+
}
|
|
506
|
+
: {};
|
|
507
|
+
|
|
508
|
+
if (
|
|
509
|
+
await printResults(
|
|
510
|
+
engine,
|
|
511
|
+
resultsToPrint,
|
|
512
|
+
options.format,
|
|
513
|
+
options.outputFile,
|
|
514
|
+
resultsMeta,
|
|
515
|
+
)
|
|
516
|
+
) {
|
|
517
|
+
// Errors and warnings from the original unfiltered results should determine the exit code
|
|
518
|
+
const shouldExitForFatalErrors =
|
|
519
|
+
options.exitOnFatalError && resultCounts.fatalErrorCount > 0;
|
|
520
|
+
|
|
521
|
+
if (!resultCounts.errorCount && tooManyWarnings) {
|
|
522
|
+
log.error(
|
|
523
|
+
"ESLint found too many warnings (maximum: %s).",
|
|
524
|
+
options.maxWarnings,
|
|
525
|
+
);
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
if (!options.passOnUnprunedSuppressions) {
|
|
529
|
+
const unusedSuppressionsCount =
|
|
530
|
+
Object.keys(unusedSuppressions).length;
|
|
531
|
+
|
|
532
|
+
if (unusedSuppressionsCount > 0) {
|
|
533
|
+
log.error(
|
|
534
|
+
"There are suppressions left that do not occur anymore. Consider re-running the command with `--prune-suppressions`.",
|
|
535
|
+
);
|
|
536
|
+
debug(JSON.stringify(unusedSuppressions, null, 2));
|
|
537
|
+
|
|
538
|
+
return 2;
|
|
539
|
+
}
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
if (shouldExitForFatalErrors) {
|
|
543
|
+
return 2;
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
return resultCounts.errorCount || tooManyWarnings ? 1 : 0;
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
return 2;
|
|
550
|
+
},
|
|
469
551
|
};
|
|
470
552
|
|
|
471
553
|
module.exports = cli;
|