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
|
@@ -0,0 +1,816 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Utility to load config files
|
|
3
|
+
* @author Nicholas C. Zakas
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
"use strict";
|
|
7
|
+
|
|
8
|
+
//------------------------------------------------------------------------------
|
|
9
|
+
// Requirements
|
|
10
|
+
//------------------------------------------------------------------------------
|
|
11
|
+
|
|
12
|
+
const path = require("node:path");
|
|
13
|
+
const fs = require("node:fs/promises");
|
|
14
|
+
const findUp = require("find-up");
|
|
15
|
+
const { pathToFileURL } = require("node:url");
|
|
16
|
+
const debug = require("debug")("eslint:config-loader");
|
|
17
|
+
const { FlatConfigArray } = require("./flat-config-array");
|
|
18
|
+
const { WarningService } = require("../services/warning-service");
|
|
19
|
+
|
|
20
|
+
//-----------------------------------------------------------------------------
|
|
21
|
+
// Types
|
|
22
|
+
//-----------------------------------------------------------------------------
|
|
23
|
+
|
|
24
|
+
/** @typedef {import("../types").Linter.Config} Config */
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* @typedef {Object} ConfigLoaderOptions
|
|
28
|
+
* @property {string|false|undefined} configFile The path to the config file to use.
|
|
29
|
+
* @property {string} cwd The current working directory.
|
|
30
|
+
* @property {boolean} ignoreEnabled Indicates if ignore patterns should be honored.
|
|
31
|
+
* @property {Config|Array<Config>} [baseConfig] The base config to use.
|
|
32
|
+
* @property {Array<Config>} [defaultConfigs] The default configs to use.
|
|
33
|
+
* @property {Array<string>} [ignorePatterns] The ignore patterns to use.
|
|
34
|
+
* @property {Config|Array<Config>} [overrideConfig] The override config to use.
|
|
35
|
+
* @property {boolean} [hasUnstableNativeNodeJsTSConfigFlag] The flag to indicate whether the `unstable_native_nodejs_ts_config` flag is enabled.
|
|
36
|
+
* @property {WarningService} [warningService] The warning service to use.
|
|
37
|
+
*/
|
|
38
|
+
|
|
39
|
+
//------------------------------------------------------------------------------
|
|
40
|
+
// Helpers
|
|
41
|
+
//------------------------------------------------------------------------------
|
|
42
|
+
|
|
43
|
+
const FLAT_CONFIG_FILENAMES = [
|
|
44
|
+
"eslint.config.js",
|
|
45
|
+
"eslint.config.mjs",
|
|
46
|
+
"eslint.config.cjs",
|
|
47
|
+
"eslint.config.ts",
|
|
48
|
+
"eslint.config.mts",
|
|
49
|
+
"eslint.config.cts",
|
|
50
|
+
];
|
|
51
|
+
|
|
52
|
+
const importedConfigFileModificationTime = new Map();
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Asserts that the given file path is valid.
|
|
56
|
+
* @param {string} filePath The file path to check.
|
|
57
|
+
* @returns {void}
|
|
58
|
+
* @throws {Error} If `filePath` is not a non-empty string.
|
|
59
|
+
*/
|
|
60
|
+
function assertValidFilePath(filePath) {
|
|
61
|
+
if (!filePath || typeof filePath !== "string") {
|
|
62
|
+
throw new Error("'filePath' must be a non-empty string");
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Asserts that a configuration exists. A configuration exists if any
|
|
68
|
+
* of the following are true:
|
|
69
|
+
* - `configFilePath` is defined.
|
|
70
|
+
* - `useConfigFile` is `false`.
|
|
71
|
+
* @param {string|undefined} configFilePath The path to the config file.
|
|
72
|
+
* @param {ConfigLoaderOptions} loaderOptions The options to use when loading configuration files.
|
|
73
|
+
* @returns {void}
|
|
74
|
+
* @throws {Error} If no configuration exists.
|
|
75
|
+
*/
|
|
76
|
+
function assertConfigurationExists(configFilePath, loaderOptions) {
|
|
77
|
+
const { configFile: useConfigFile } = loaderOptions;
|
|
78
|
+
|
|
79
|
+
if (!configFilePath && useConfigFile !== false) {
|
|
80
|
+
const error = new Error("Could not find config file.");
|
|
81
|
+
|
|
82
|
+
error.messageTemplate = "config-file-missing";
|
|
83
|
+
throw error;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Check if the file is a TypeScript file.
|
|
89
|
+
* @param {string} filePath The file path to check.
|
|
90
|
+
* @returns {boolean} `true` if the file is a TypeScript file, `false` if it's not.
|
|
91
|
+
*/
|
|
92
|
+
function isFileTS(filePath) {
|
|
93
|
+
const fileExtension = path.extname(filePath);
|
|
94
|
+
|
|
95
|
+
return /^\.[mc]?ts$/u.test(fileExtension);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* Check if ESLint is running in Bun.
|
|
100
|
+
* @returns {boolean} `true` if the ESLint is running Bun, `false` if it's not.
|
|
101
|
+
*/
|
|
102
|
+
function isRunningInBun() {
|
|
103
|
+
return !!globalThis.Bun;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Check if ESLint is running in Deno.
|
|
108
|
+
* @returns {boolean} `true` if the ESLint is running in Deno, `false` if it's not.
|
|
109
|
+
*/
|
|
110
|
+
function isRunningInDeno() {
|
|
111
|
+
return !!globalThis.Deno;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Checks if native TypeScript support is
|
|
116
|
+
* enabled in the current Node.js process.
|
|
117
|
+
*
|
|
118
|
+
* This function determines if the
|
|
119
|
+
* {@linkcode NodeJS.ProcessFeatures.typescript | typescript}
|
|
120
|
+
* feature is present in the
|
|
121
|
+
* {@linkcode process.features} object
|
|
122
|
+
* and if its value is either "strip" or "transform".
|
|
123
|
+
* @returns {boolean} `true` if native TypeScript support is enabled, otherwise `false`.
|
|
124
|
+
* @since 9.24.0
|
|
125
|
+
*/
|
|
126
|
+
function isNativeTypeScriptSupportEnabled() {
|
|
127
|
+
return (
|
|
128
|
+
// eslint-disable-next-line n/no-unsupported-features/node-builtins -- it's still an experimental feature.
|
|
129
|
+
["strip", "transform"].includes(process.features.typescript)
|
|
130
|
+
);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Load the TypeScript configuration file.
|
|
135
|
+
* @param {string} filePath The absolute file path to load.
|
|
136
|
+
* @param {URL} fileURL The file URL to load.
|
|
137
|
+
* @param {number} mtime The last modified timestamp of the file.
|
|
138
|
+
* @returns {Promise<any>} The configuration loaded from the file.
|
|
139
|
+
* @since 9.24.0
|
|
140
|
+
*/
|
|
141
|
+
async function loadTypeScriptConfigFileWithJiti(filePath, fileURL, mtime) {
|
|
142
|
+
const { createJiti, version: jitiVersion } =
|
|
143
|
+
// eslint-disable-next-line no-use-before-define -- `ConfigLoader.loadJiti` can be overwritten for testing
|
|
144
|
+
await ConfigLoader.loadJiti().catch(() => {
|
|
145
|
+
throw new Error(
|
|
146
|
+
"The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it.",
|
|
147
|
+
);
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
// `createJiti` was added in jiti v2.
|
|
151
|
+
if (typeof createJiti !== "function") {
|
|
152
|
+
throw new Error(
|
|
153
|
+
"You are using an outdated version of the 'jiti' library. Please update to the latest version of 'jiti' to ensure compatibility and access to the latest features.",
|
|
154
|
+
);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/*
|
|
158
|
+
* Disabling `moduleCache` allows us to reload a
|
|
159
|
+
* config file when the last modified timestamp changes.
|
|
160
|
+
*/
|
|
161
|
+
const jitiOptions = {
|
|
162
|
+
moduleCache: false,
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
if (jitiVersion.startsWith("2.1.")) {
|
|
166
|
+
jitiOptions.interopDefault = false;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
const jiti = createJiti(__filename, jitiOptions);
|
|
170
|
+
const config = await jiti.import(fileURL.href);
|
|
171
|
+
|
|
172
|
+
importedConfigFileModificationTime.set(filePath, mtime);
|
|
173
|
+
|
|
174
|
+
return config?.default ?? config;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Dynamically imports a module from the given file path.
|
|
179
|
+
* @param {string} filePath The absolute file path of the module to import.
|
|
180
|
+
* @param {URL} fileURL The file URL to load.
|
|
181
|
+
* @param {number} mtime The last modified timestamp of the file.
|
|
182
|
+
* @returns {Promise<any>} - A {@linkcode Promise | promise} that resolves to the imported ESLint config.
|
|
183
|
+
* @since 9.24.0
|
|
184
|
+
*/
|
|
185
|
+
async function dynamicImportConfig(filePath, fileURL, mtime) {
|
|
186
|
+
const module = await import(fileURL.href);
|
|
187
|
+
|
|
188
|
+
importedConfigFileModificationTime.set(filePath, mtime);
|
|
189
|
+
|
|
190
|
+
return module.default;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Load the config array from the given filename.
|
|
195
|
+
* @param {string} filePath The filename to load from.
|
|
196
|
+
* @param {boolean} hasUnstableNativeNodeJsTSConfigFlag The flag to indicate whether the `unstable_native_nodejs_ts_config` flag is enabled.
|
|
197
|
+
* @returns {Promise<any>} The config loaded from the config file.
|
|
198
|
+
*/
|
|
199
|
+
async function loadConfigFile(filePath, hasUnstableNativeNodeJsTSConfigFlag) {
|
|
200
|
+
debug(`Loading config from ${filePath}`);
|
|
201
|
+
|
|
202
|
+
const fileURL = pathToFileURL(filePath);
|
|
203
|
+
|
|
204
|
+
debug(`Config file URL is ${fileURL}`);
|
|
205
|
+
|
|
206
|
+
const mtime = (await fs.stat(filePath)).mtime.getTime();
|
|
207
|
+
|
|
208
|
+
/*
|
|
209
|
+
* Append a query with the config file's modification time (`mtime`) in order
|
|
210
|
+
* to import the current version of the config file. Without the query, `import()` would
|
|
211
|
+
* cache the config file module by the pathname only, and then always return
|
|
212
|
+
* the same version (the one that was actual when the module was imported for the first time).
|
|
213
|
+
*
|
|
214
|
+
* This ensures that the config file module is loaded and executed again
|
|
215
|
+
* if it has been changed since the last time it was imported.
|
|
216
|
+
* If it hasn't been changed, `import()` will just return the cached version.
|
|
217
|
+
*
|
|
218
|
+
* Note that we should not overuse queries (e.g., by appending the current time
|
|
219
|
+
* to always reload the config file module) as that could cause memory leaks
|
|
220
|
+
* because entries are never removed from the import cache.
|
|
221
|
+
*/
|
|
222
|
+
fileURL.searchParams.append("mtime", mtime);
|
|
223
|
+
|
|
224
|
+
/*
|
|
225
|
+
* With queries, we can bypass the import cache. However, when import-ing a CJS module,
|
|
226
|
+
* Node.js uses the require infrastructure under the hood. That includes the require cache,
|
|
227
|
+
* which caches the config file module by its file path (queries have no effect).
|
|
228
|
+
* Therefore, we also need to clear the require cache before importing the config file module.
|
|
229
|
+
* In order to get the same behavior with ESM and CJS config files, in particular - to reload
|
|
230
|
+
* the config file only if it has been changed, we track file modification times and clear
|
|
231
|
+
* the require cache only if the file has been changed.
|
|
232
|
+
*/
|
|
233
|
+
if (importedConfigFileModificationTime.get(filePath) !== mtime) {
|
|
234
|
+
delete require.cache[filePath];
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
const isTS = isFileTS(filePath);
|
|
238
|
+
const isBun = isRunningInBun();
|
|
239
|
+
const isDeno = isRunningInDeno();
|
|
240
|
+
|
|
241
|
+
/*
|
|
242
|
+
* If we are dealing with a TypeScript file, then we need to use `jiti` to load it
|
|
243
|
+
* in Node.js. Deno and Bun both allow native importing of TypeScript files.
|
|
244
|
+
*
|
|
245
|
+
* When Node.js supports native TypeScript imports, we can remove this check.
|
|
246
|
+
*/
|
|
247
|
+
|
|
248
|
+
if (isTS) {
|
|
249
|
+
if (hasUnstableNativeNodeJsTSConfigFlag) {
|
|
250
|
+
if (isNativeTypeScriptSupportEnabled()) {
|
|
251
|
+
return await dynamicImportConfig(filePath, fileURL, mtime);
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
if (!("typescript" in process.features)) {
|
|
255
|
+
throw new Error(
|
|
256
|
+
"The unstable_native_nodejs_ts_config flag is not supported in older versions of Node.js.",
|
|
257
|
+
);
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
throw new Error(
|
|
261
|
+
"The unstable_native_nodejs_ts_config flag is enabled, but native TypeScript support is not enabled in the current Node.js process. You need to either enable native TypeScript support by passing --experimental-strip-types or remove the unstable_native_nodejs_ts_config flag.",
|
|
262
|
+
);
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
if (!isDeno && !isBun) {
|
|
266
|
+
return await loadTypeScriptConfigFileWithJiti(
|
|
267
|
+
filePath,
|
|
268
|
+
fileURL,
|
|
269
|
+
mtime,
|
|
270
|
+
);
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
// fallback to normal runtime behavior
|
|
275
|
+
|
|
276
|
+
return await dynamicImportConfig(filePath, fileURL, mtime);
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
//-----------------------------------------------------------------------------
|
|
280
|
+
// Exports
|
|
281
|
+
//-----------------------------------------------------------------------------
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Encapsulates the loading and caching of configuration files when looking up
|
|
285
|
+
* from the file being linted.
|
|
286
|
+
*/
|
|
287
|
+
class ConfigLoader {
|
|
288
|
+
/**
|
|
289
|
+
* Map of config file paths to the config arrays for those directories.
|
|
290
|
+
* @type {Map<string, FlatConfigArray|Promise<FlatConfigArray>>}
|
|
291
|
+
*/
|
|
292
|
+
#configArrays = new Map();
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Map of absolute directory names to the config file paths for those directories.
|
|
296
|
+
* @type {Map<string, {configFilePath:string,basePath:string}|Promise<{configFilePath:string,basePath:string}>>}
|
|
297
|
+
*/
|
|
298
|
+
#configFilePaths = new Map();
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* The options to use when loading configuration files.
|
|
302
|
+
* @type {ConfigLoaderOptions}
|
|
303
|
+
*/
|
|
304
|
+
#options;
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Creates a new instance.
|
|
308
|
+
* @param {ConfigLoaderOptions} options The options to use when loading configuration files.
|
|
309
|
+
*/
|
|
310
|
+
constructor(options) {
|
|
311
|
+
this.#options = options.warningService
|
|
312
|
+
? options
|
|
313
|
+
: { ...options, warningService: new WarningService() };
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* Determines which config file to use. This is determined by seeing if an
|
|
318
|
+
* override config file was specified, and if so, using it; otherwise, as long
|
|
319
|
+
* as override config file is not explicitly set to `false`, it will search
|
|
320
|
+
* upwards from `fromDirectory` for a file named `eslint.config.js`.
|
|
321
|
+
* @param {string} fromDirectory The directory from which to start searching.
|
|
322
|
+
* @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
|
|
323
|
+
* the config file.
|
|
324
|
+
*/
|
|
325
|
+
async #locateConfigFileToUse(fromDirectory) {
|
|
326
|
+
// check cache first
|
|
327
|
+
if (this.#configFilePaths.has(fromDirectory)) {
|
|
328
|
+
return this.#configFilePaths.get(fromDirectory);
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
const resultPromise = ConfigLoader.locateConfigFileToUse({
|
|
332
|
+
useConfigFile: this.#options.configFile,
|
|
333
|
+
cwd: this.#options.cwd,
|
|
334
|
+
fromDirectory,
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
// ensure `ConfigLoader.locateConfigFileToUse` is called only once for `fromDirectory`
|
|
338
|
+
this.#configFilePaths.set(fromDirectory, resultPromise);
|
|
339
|
+
|
|
340
|
+
// Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
|
|
341
|
+
const result = await resultPromise;
|
|
342
|
+
|
|
343
|
+
this.#configFilePaths.set(fromDirectory, result);
|
|
344
|
+
|
|
345
|
+
return result;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Calculates the config array for this run based on inputs.
|
|
350
|
+
* @param {string} configFilePath The absolute path to the config file to use if not overridden.
|
|
351
|
+
* @param {string} basePath The base path to use for relative paths in the config file.
|
|
352
|
+
* @returns {Promise<FlatConfigArray>} The config array for `eslint`.
|
|
353
|
+
*/
|
|
354
|
+
async #calculateConfigArray(configFilePath, basePath) {
|
|
355
|
+
// check for cached version first
|
|
356
|
+
if (this.#configArrays.has(configFilePath)) {
|
|
357
|
+
return this.#configArrays.get(configFilePath);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
const configsPromise = ConfigLoader.calculateConfigArray(
|
|
361
|
+
configFilePath,
|
|
362
|
+
basePath,
|
|
363
|
+
this.#options,
|
|
364
|
+
);
|
|
365
|
+
|
|
366
|
+
// ensure `ConfigLoader.calculateConfigArray` is called only once for `configFilePath`
|
|
367
|
+
this.#configArrays.set(configFilePath, configsPromise);
|
|
368
|
+
|
|
369
|
+
// Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
|
|
370
|
+
const configs = await configsPromise;
|
|
371
|
+
|
|
372
|
+
this.#configArrays.set(configFilePath, configs);
|
|
373
|
+
|
|
374
|
+
return configs;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Returns the config file path for the given directory or file. This will either use
|
|
379
|
+
* the override config file that was specified in the constructor options or
|
|
380
|
+
* search for a config file from the directory.
|
|
381
|
+
* @param {string} fileOrDirPath The file or directory path to get the config file path for.
|
|
382
|
+
* @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
|
|
383
|
+
* @throws {Error} If `fileOrDirPath` is not a non-empty string.
|
|
384
|
+
* @throws {Error} If `fileOrDirPath` is not an absolute path.
|
|
385
|
+
*/
|
|
386
|
+
async findConfigFileForPath(fileOrDirPath) {
|
|
387
|
+
assertValidFilePath(fileOrDirPath);
|
|
388
|
+
|
|
389
|
+
const absoluteDirPath = path.resolve(
|
|
390
|
+
this.#options.cwd,
|
|
391
|
+
path.dirname(fileOrDirPath),
|
|
392
|
+
);
|
|
393
|
+
const { configFilePath } =
|
|
394
|
+
await this.#locateConfigFileToUse(absoluteDirPath);
|
|
395
|
+
|
|
396
|
+
return configFilePath;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* Returns a configuration object for the given file based on the CLI options.
|
|
401
|
+
* This is the same logic used by the ESLint CLI executable to determine
|
|
402
|
+
* configuration for each file it processes.
|
|
403
|
+
* @param {string} filePath The path of the file or directory to retrieve config for.
|
|
404
|
+
* @returns {Promise<FlatConfigArray>} A configuration object for the file.
|
|
405
|
+
* @throws {Error} If no configuration for `filePath` exists.
|
|
406
|
+
*/
|
|
407
|
+
async loadConfigArrayForFile(filePath) {
|
|
408
|
+
assertValidFilePath(filePath);
|
|
409
|
+
|
|
410
|
+
debug(`Calculating config for file ${filePath}`);
|
|
411
|
+
|
|
412
|
+
const configFilePath = await this.findConfigFileForPath(filePath);
|
|
413
|
+
|
|
414
|
+
assertConfigurationExists(configFilePath, this.#options);
|
|
415
|
+
|
|
416
|
+
return this.loadConfigArrayForDirectory(filePath);
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Returns a configuration object for the given directory based on the CLI options.
|
|
421
|
+
* This is the same logic used by the ESLint CLI executable to determine
|
|
422
|
+
* configuration for each file it processes.
|
|
423
|
+
* @param {string} dirPath The path of the directory to retrieve config for.
|
|
424
|
+
* @returns {Promise<FlatConfigArray>} A configuration object for the directory.
|
|
425
|
+
*/
|
|
426
|
+
async loadConfigArrayForDirectory(dirPath) {
|
|
427
|
+
assertValidFilePath(dirPath);
|
|
428
|
+
|
|
429
|
+
debug(`Calculating config for directory ${dirPath}`);
|
|
430
|
+
|
|
431
|
+
const absoluteDirPath = path.resolve(
|
|
432
|
+
this.#options.cwd,
|
|
433
|
+
path.dirname(dirPath),
|
|
434
|
+
);
|
|
435
|
+
const { configFilePath, basePath } =
|
|
436
|
+
await this.#locateConfigFileToUse(absoluteDirPath);
|
|
437
|
+
|
|
438
|
+
debug(`Using config file ${configFilePath} and base path ${basePath}`);
|
|
439
|
+
return this.#calculateConfigArray(configFilePath, basePath);
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* Returns a configuration array for the given file based on the CLI options.
|
|
444
|
+
* This is a synchronous operation and does not read any files from disk. It's
|
|
445
|
+
* intended to be used in locations where we know the config file has already
|
|
446
|
+
* been loaded and we just need to get the configuration for a file.
|
|
447
|
+
* @param {string} filePath The path of the file to retrieve a config object for.
|
|
448
|
+
* @returns {FlatConfigArray} A configuration object for the file.
|
|
449
|
+
* @throws {Error} If `filePath` is not a non-empty string.
|
|
450
|
+
* @throws {Error} If `filePath` is not an absolute path.
|
|
451
|
+
* @throws {Error} If the config file was not already loaded.
|
|
452
|
+
*/
|
|
453
|
+
getCachedConfigArrayForFile(filePath) {
|
|
454
|
+
assertValidFilePath(filePath);
|
|
455
|
+
|
|
456
|
+
debug(`Looking up cached config for ${filePath}`);
|
|
457
|
+
|
|
458
|
+
return this.getCachedConfigArrayForPath(path.dirname(filePath));
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Returns a configuration array for the given directory based on the CLI options.
|
|
463
|
+
* This is a synchronous operation and does not read any files from disk. It's
|
|
464
|
+
* intended to be used in locations where we know the config file has already
|
|
465
|
+
* been loaded and we just need to get the configuration for a file.
|
|
466
|
+
* @param {string} fileOrDirPath The path of the directory to retrieve a config object for.
|
|
467
|
+
* @returns {FlatConfigArray} A configuration object for the directory.
|
|
468
|
+
* @throws {Error} If `dirPath` is not a non-empty string.
|
|
469
|
+
* @throws {Error} If `dirPath` is not an absolute path.
|
|
470
|
+
* @throws {Error} If the config file was not already loaded.
|
|
471
|
+
*/
|
|
472
|
+
getCachedConfigArrayForPath(fileOrDirPath) {
|
|
473
|
+
assertValidFilePath(fileOrDirPath);
|
|
474
|
+
|
|
475
|
+
debug(`Looking up cached config for ${fileOrDirPath}`);
|
|
476
|
+
|
|
477
|
+
const absoluteDirPath = path.resolve(this.#options.cwd, fileOrDirPath);
|
|
478
|
+
|
|
479
|
+
if (!this.#configFilePaths.has(absoluteDirPath)) {
|
|
480
|
+
throw new Error(`Could not find config file for ${fileOrDirPath}`);
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
const configFilePathInfo = this.#configFilePaths.get(absoluteDirPath);
|
|
484
|
+
|
|
485
|
+
if (typeof configFilePathInfo.then === "function") {
|
|
486
|
+
throw new Error(
|
|
487
|
+
`Config file path for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`,
|
|
488
|
+
);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
const { configFilePath } = configFilePathInfo;
|
|
492
|
+
|
|
493
|
+
const configArray = this.#configArrays.get(configFilePath);
|
|
494
|
+
|
|
495
|
+
if (!configArray || typeof configArray.then === "function") {
|
|
496
|
+
throw new Error(
|
|
497
|
+
`Config array for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`,
|
|
498
|
+
);
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
return configArray;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* Used to import the jiti dependency. This method is exposed internally for testing purposes.
|
|
506
|
+
* @returns {Promise<{createJiti: Function|undefined, version: string;}>} A promise that fulfills with an object containing the jiti module's createJiti function and version.
|
|
507
|
+
*/
|
|
508
|
+
static async loadJiti() {
|
|
509
|
+
const { createJiti } = await import("jiti");
|
|
510
|
+
const version = require("jiti/package.json").version;
|
|
511
|
+
return { createJiti, version };
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Determines which config file to use. This is determined by seeing if an
|
|
516
|
+
* override config file was specified, and if so, using it; otherwise, as long
|
|
517
|
+
* as override config file is not explicitly set to `false`, it will search
|
|
518
|
+
* upwards from `fromDirectory` for a file named `eslint.config.js`.
|
|
519
|
+
* This method is exposed internally for testing purposes.
|
|
520
|
+
* @param {Object} [options] the options object
|
|
521
|
+
* @param {string|false|undefined} options.useConfigFile The path to the config file to use.
|
|
522
|
+
* @param {string} options.cwd Path to a directory that should be considered as the current working directory.
|
|
523
|
+
* @param {string} [options.fromDirectory] The directory from which to start searching. Defaults to `cwd`.
|
|
524
|
+
* @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
|
|
525
|
+
* the config file.
|
|
526
|
+
*/
|
|
527
|
+
static async locateConfigFileToUse({
|
|
528
|
+
useConfigFile,
|
|
529
|
+
cwd,
|
|
530
|
+
fromDirectory = cwd,
|
|
531
|
+
}) {
|
|
532
|
+
// determine where to load config file from
|
|
533
|
+
let configFilePath;
|
|
534
|
+
let basePath = cwd;
|
|
535
|
+
|
|
536
|
+
if (typeof useConfigFile === "string") {
|
|
537
|
+
debug(`Override config file path is ${useConfigFile}`);
|
|
538
|
+
configFilePath = path.resolve(cwd, useConfigFile);
|
|
539
|
+
basePath = cwd;
|
|
540
|
+
} else if (useConfigFile !== false) {
|
|
541
|
+
debug("Searching for eslint.config.js");
|
|
542
|
+
configFilePath = await findUp(FLAT_CONFIG_FILENAMES, {
|
|
543
|
+
cwd: fromDirectory,
|
|
544
|
+
});
|
|
545
|
+
|
|
546
|
+
if (configFilePath) {
|
|
547
|
+
basePath = path.dirname(configFilePath);
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
return {
|
|
552
|
+
configFilePath,
|
|
553
|
+
basePath,
|
|
554
|
+
};
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Calculates the config array for this run based on inputs.
|
|
559
|
+
* This method is exposed internally for testing purposes.
|
|
560
|
+
* @param {string} configFilePath The absolute path to the config file to use if not overridden.
|
|
561
|
+
* @param {string} basePath The base path to use for relative paths in the config file.
|
|
562
|
+
* @param {ConfigLoaderOptions} options The options to use when loading configuration files.
|
|
563
|
+
* @returns {Promise<FlatConfigArray>} The config array for `eslint`.
|
|
564
|
+
*/
|
|
565
|
+
static async calculateConfigArray(configFilePath, basePath, options) {
|
|
566
|
+
const {
|
|
567
|
+
cwd,
|
|
568
|
+
baseConfig,
|
|
569
|
+
ignoreEnabled,
|
|
570
|
+
ignorePatterns,
|
|
571
|
+
overrideConfig,
|
|
572
|
+
hasUnstableNativeNodeJsTSConfigFlag = false,
|
|
573
|
+
defaultConfigs = [],
|
|
574
|
+
warningService,
|
|
575
|
+
} = options;
|
|
576
|
+
|
|
577
|
+
debug(
|
|
578
|
+
`Calculating config array from config file ${configFilePath} and base path ${basePath}`,
|
|
579
|
+
);
|
|
580
|
+
|
|
581
|
+
const configs = new FlatConfigArray(baseConfig || [], {
|
|
582
|
+
basePath,
|
|
583
|
+
shouldIgnore: ignoreEnabled,
|
|
584
|
+
});
|
|
585
|
+
|
|
586
|
+
// load config file
|
|
587
|
+
if (configFilePath) {
|
|
588
|
+
debug(`Loading config file ${configFilePath}`);
|
|
589
|
+
const fileConfig = await loadConfigFile(
|
|
590
|
+
configFilePath,
|
|
591
|
+
hasUnstableNativeNodeJsTSConfigFlag,
|
|
592
|
+
);
|
|
593
|
+
|
|
594
|
+
/*
|
|
595
|
+
* It's possible that a config file could be empty or else
|
|
596
|
+
* have an empty object or array. In this case, we want to
|
|
597
|
+
* warn the user that they have an empty config.
|
|
598
|
+
*
|
|
599
|
+
* An empty CommonJS file exports an empty object while
|
|
600
|
+
* an empty ESM file exports undefined.
|
|
601
|
+
*/
|
|
602
|
+
|
|
603
|
+
let emptyConfig = typeof fileConfig === "undefined";
|
|
604
|
+
|
|
605
|
+
debug(
|
|
606
|
+
`Config file ${configFilePath} is ${emptyConfig ? "empty" : "not empty"}`,
|
|
607
|
+
);
|
|
608
|
+
|
|
609
|
+
if (!emptyConfig) {
|
|
610
|
+
if (Array.isArray(fileConfig)) {
|
|
611
|
+
if (fileConfig.length === 0) {
|
|
612
|
+
debug(
|
|
613
|
+
`Config file ${configFilePath} is an empty array`,
|
|
614
|
+
);
|
|
615
|
+
emptyConfig = true;
|
|
616
|
+
} else {
|
|
617
|
+
configs.push(...fileConfig);
|
|
618
|
+
}
|
|
619
|
+
} else {
|
|
620
|
+
if (
|
|
621
|
+
typeof fileConfig === "object" &&
|
|
622
|
+
fileConfig !== null &&
|
|
623
|
+
Object.keys(fileConfig).length === 0
|
|
624
|
+
) {
|
|
625
|
+
debug(
|
|
626
|
+
`Config file ${configFilePath} is an empty object`,
|
|
627
|
+
);
|
|
628
|
+
emptyConfig = true;
|
|
629
|
+
} else {
|
|
630
|
+
configs.push(fileConfig);
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
if (emptyConfig) {
|
|
636
|
+
warningService.emitEmptyConfigWarning(configFilePath);
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
// add in any configured defaults
|
|
641
|
+
configs.push(...defaultConfigs);
|
|
642
|
+
|
|
643
|
+
// append command line ignore patterns
|
|
644
|
+
if (ignorePatterns && ignorePatterns.length > 0) {
|
|
645
|
+
/*
|
|
646
|
+
* Ignore patterns are added to the end of the config array
|
|
647
|
+
* so they can override default ignores.
|
|
648
|
+
*/
|
|
649
|
+
configs.push({
|
|
650
|
+
basePath: cwd,
|
|
651
|
+
ignores: ignorePatterns,
|
|
652
|
+
});
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
if (overrideConfig) {
|
|
656
|
+
if (Array.isArray(overrideConfig)) {
|
|
657
|
+
configs.push(...overrideConfig);
|
|
658
|
+
} else {
|
|
659
|
+
configs.push(overrideConfig);
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
await configs.normalize();
|
|
664
|
+
|
|
665
|
+
return configs;
|
|
666
|
+
}
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
/**
|
|
670
|
+
* Encapsulates the loading and caching of configuration files when looking up
|
|
671
|
+
* from the current working directory.
|
|
672
|
+
*/
|
|
673
|
+
class LegacyConfigLoader extends ConfigLoader {
|
|
674
|
+
/**
|
|
675
|
+
* The options to use when loading configuration files.
|
|
676
|
+
* @type {ConfigLoaderOptions}
|
|
677
|
+
*/
|
|
678
|
+
#options;
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* The cached config file path for this instance.
|
|
682
|
+
* @type {Promise<{configFilePath:string,basePath:string}|undefined>}
|
|
683
|
+
*/
|
|
684
|
+
#configFilePath;
|
|
685
|
+
|
|
686
|
+
/**
|
|
687
|
+
* The cached config array for this instance.
|
|
688
|
+
* @type {FlatConfigArray|Promise<FlatConfigArray>}
|
|
689
|
+
*/
|
|
690
|
+
#configArray;
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* Creates a new instance.
|
|
694
|
+
* @param {ConfigLoaderOptions} options The options to use when loading configuration files.
|
|
695
|
+
*/
|
|
696
|
+
constructor(options) {
|
|
697
|
+
const normalizedOptions = options.warningService
|
|
698
|
+
? options
|
|
699
|
+
: { ...options, warningService: new WarningService() };
|
|
700
|
+
super(normalizedOptions);
|
|
701
|
+
this.#options = normalizedOptions;
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
/**
|
|
705
|
+
* Determines which config file to use. This is determined by seeing if an
|
|
706
|
+
* override config file was specified, and if so, using it; otherwise, as long
|
|
707
|
+
* as override config file is not explicitly set to `false`, it will search
|
|
708
|
+
* upwards from the cwd for a file named `eslint.config.js`.
|
|
709
|
+
* @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
|
|
710
|
+
* the config file.
|
|
711
|
+
*/
|
|
712
|
+
#locateConfigFileToUse() {
|
|
713
|
+
if (!this.#configFilePath) {
|
|
714
|
+
this.#configFilePath = ConfigLoader.locateConfigFileToUse({
|
|
715
|
+
useConfigFile: this.#options.configFile,
|
|
716
|
+
cwd: this.#options.cwd,
|
|
717
|
+
});
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
return this.#configFilePath;
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
/**
|
|
724
|
+
* Calculates the config array for this run based on inputs.
|
|
725
|
+
* @param {string} configFilePath The absolute path to the config file to use if not overridden.
|
|
726
|
+
* @param {string} basePath The base path to use for relative paths in the config file.
|
|
727
|
+
* @returns {Promise<FlatConfigArray>} The config array for `eslint`.
|
|
728
|
+
*/
|
|
729
|
+
async #calculateConfigArray(configFilePath, basePath) {
|
|
730
|
+
// check for cached version first
|
|
731
|
+
if (this.#configArray) {
|
|
732
|
+
return this.#configArray;
|
|
733
|
+
}
|
|
734
|
+
|
|
735
|
+
// ensure `ConfigLoader.calculateConfigArray` is called only once
|
|
736
|
+
this.#configArray = ConfigLoader.calculateConfigArray(
|
|
737
|
+
configFilePath,
|
|
738
|
+
basePath,
|
|
739
|
+
this.#options,
|
|
740
|
+
);
|
|
741
|
+
|
|
742
|
+
// Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
|
|
743
|
+
this.#configArray = await this.#configArray;
|
|
744
|
+
|
|
745
|
+
return this.#configArray;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
/**
|
|
749
|
+
* Returns the config file path for the given directory. This will either use
|
|
750
|
+
* the override config file that was specified in the constructor options or
|
|
751
|
+
* search for a config file from the directory of the file being linted.
|
|
752
|
+
* @param {string} dirPath The directory path to get the config file path for.
|
|
753
|
+
* @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
|
|
754
|
+
* @throws {Error} If `fileOrDirPath` is not a non-empty string.
|
|
755
|
+
* @throws {Error} If `fileOrDirPath` is not an absolute path.
|
|
756
|
+
*/
|
|
757
|
+
async findConfigFileForPath(dirPath) {
|
|
758
|
+
assertValidFilePath(dirPath);
|
|
759
|
+
|
|
760
|
+
const { configFilePath } = await this.#locateConfigFileToUse();
|
|
761
|
+
|
|
762
|
+
return configFilePath;
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* Returns a configuration object for the given file based on the CLI options.
|
|
767
|
+
* This is the same logic used by the ESLint CLI executable to determine
|
|
768
|
+
* configuration for each file it processes.
|
|
769
|
+
* @param {string} dirPath The path of the directory to retrieve config for.
|
|
770
|
+
* @returns {Promise<FlatConfigArray>} A configuration object for the file.
|
|
771
|
+
*/
|
|
772
|
+
async loadConfigArrayForDirectory(dirPath) {
|
|
773
|
+
assertValidFilePath(dirPath);
|
|
774
|
+
|
|
775
|
+
debug(`[Legacy]: Calculating config for ${dirPath}`);
|
|
776
|
+
|
|
777
|
+
const { configFilePath, basePath } =
|
|
778
|
+
await this.#locateConfigFileToUse();
|
|
779
|
+
|
|
780
|
+
debug(
|
|
781
|
+
`[Legacy]: Using config file ${configFilePath} and base path ${basePath}`,
|
|
782
|
+
);
|
|
783
|
+
return this.#calculateConfigArray(configFilePath, basePath);
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* Returns a configuration array for the given directory based on the CLI options.
|
|
788
|
+
* This is a synchronous operation and does not read any files from disk. It's
|
|
789
|
+
* intended to be used in locations where we know the config file has already
|
|
790
|
+
* been loaded and we just need to get the configuration for a file.
|
|
791
|
+
* @param {string} dirPath The path of the directory to retrieve a config object for.
|
|
792
|
+
* @returns {FlatConfigArray} A configuration object for the file.
|
|
793
|
+
* @throws {Error} If `dirPath` is not a non-empty string.
|
|
794
|
+
* @throws {Error} If `dirPath` is not an absolute path.
|
|
795
|
+
* @throws {Error} If the config file was not already loaded.
|
|
796
|
+
*/
|
|
797
|
+
getCachedConfigArrayForPath(dirPath) {
|
|
798
|
+
assertValidFilePath(dirPath);
|
|
799
|
+
|
|
800
|
+
debug(`[Legacy]: Looking up cached config for ${dirPath}`);
|
|
801
|
+
|
|
802
|
+
if (!this.#configArray) {
|
|
803
|
+
throw new Error(`Could not find config file for ${dirPath}`);
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
if (typeof this.#configArray.then === "function") {
|
|
807
|
+
throw new Error(
|
|
808
|
+
`Config array for ${dirPath} has not yet been calculated or an error occurred during the calculation`,
|
|
809
|
+
);
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
return this.#configArray;
|
|
813
|
+
}
|
|
814
|
+
}
|
|
815
|
+
|
|
816
|
+
module.exports = { ConfigLoader, LegacyConfigLoader };
|