@isentinel/eslint-config 6.0.0-beta.21 → 6.0.0-beta.23
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 +31 -0
- package/dist/cli.mjs +13 -12
- package/dist/index.d.mts +211 -98
- package/dist/index.mjs +103 -42
- package/dist/lint-cli.mjs +6 -6
- package/dist/oxlint.d.mts +271 -165
- package/dist/oxlint.mjs +186 -9
- package/package.json +23 -22
package/dist/oxlint.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { DummyRule, DummyRuleMap, DummyRuleMap as DummyRuleMap$1, ExternalPluginEntry, OxlintConfig, OxlintConfig as OxlintConfig$1, OxlintOverride, OxlintOverride as OxlintOverride$1, RuleCategories, RuleCategories as RuleCategories$1 } from "oxlint";
|
|
2
|
-
import { ESLintReactSettings } from "@eslint-react/shared";
|
|
3
2
|
import { ParserOptions } from "@typescript-eslint/parser";
|
|
4
3
|
import { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
|
|
5
4
|
import "type-fest";
|
|
@@ -3123,9 +3122,22 @@ interface OxlintTestRuleDefaults {
|
|
|
3123
3122
|
"flawless/max-lines-per-function": {
|
|
3124
3123
|
"*": "off";
|
|
3125
3124
|
};
|
|
3125
|
+
"flawless/no-conditional-in-test": {
|
|
3126
|
+
"*": ["error", {
|
|
3127
|
+
"allowOptionalChaining": false;
|
|
3128
|
+
}];
|
|
3129
|
+
};
|
|
3126
3130
|
"flawless/padding-after-expect-assertions": {
|
|
3127
3131
|
"*": "warn";
|
|
3128
3132
|
};
|
|
3133
|
+
"flawless/prefer-ending-with-an-expect": {
|
|
3134
|
+
"*": ["warn", {
|
|
3135
|
+
"assertFunctionNames": ["expect", "expectTypeOf", "assertType"];
|
|
3136
|
+
}];
|
|
3137
|
+
};
|
|
3138
|
+
"flawless/prefer-expect-assertions-count": {
|
|
3139
|
+
"*": "warn";
|
|
3140
|
+
};
|
|
3129
3141
|
"jest-js/consistent-test-it": {
|
|
3130
3142
|
"*": "error";
|
|
3131
3143
|
};
|
|
@@ -3372,9 +3384,6 @@ interface OxlintTestRuleDefaults {
|
|
|
3372
3384
|
"vitest/no-conditional-expect": {
|
|
3373
3385
|
"*": "error";
|
|
3374
3386
|
};
|
|
3375
|
-
"vitest/no-conditional-in-test": {
|
|
3376
|
-
"*": "error";
|
|
3377
|
-
};
|
|
3378
3387
|
"vitest/no-conditional-tests": {
|
|
3379
3388
|
"*": "error";
|
|
3380
3389
|
};
|
|
@@ -4179,87 +4188,102 @@ interface RuleOptions {
|
|
|
4179
4188
|
'eslint-plugin/unique-test-case-names'?: Linter.RuleEntry<[]>;
|
|
4180
4189
|
/**
|
|
4181
4190
|
* Enforce arrow function return style based on line length
|
|
4182
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4191
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/arrow-return-style/documentation.md
|
|
4183
4192
|
*/
|
|
4184
4193
|
'flawless/arrow-return-style'?: Linter.RuleEntry<FlawlessArrowReturnStyle>;
|
|
4185
4194
|
/**
|
|
4186
4195
|
* Disallow shorthand boolean JSX attributes
|
|
4187
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4196
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/jsx-shorthand-boolean/documentation.md
|
|
4188
4197
|
*/
|
|
4189
4198
|
'flawless/jsx-shorthand-boolean'?: Linter.RuleEntry<[]>;
|
|
4190
4199
|
/**
|
|
4191
4200
|
* Enforce a consistent fragment form: the shorthand `<>...</>` or a named fragment
|
|
4192
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4201
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/jsx-shorthand-fragment/documentation.md
|
|
4193
4202
|
*/
|
|
4194
4203
|
'flawless/jsx-shorthand-fragment'?: Linter.RuleEntry<FlawlessJsxShorthandFragment>;
|
|
4195
4204
|
/**
|
|
4196
4205
|
* Enforce a maximum number of lines of code in a function
|
|
4197
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4206
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/max-lines-per-function/documentation.md
|
|
4198
4207
|
*/
|
|
4199
4208
|
'flawless/max-lines-per-function'?: Linter.RuleEntry<FlawlessMaxLinesPerFunction>;
|
|
4200
4209
|
/**
|
|
4201
4210
|
* Enforce naming conventions for everything across a codebase
|
|
4202
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4211
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/naming-convention/documentation.md
|
|
4203
4212
|
*/
|
|
4204
4213
|
'flawless/naming-convention'?: Linter.RuleEntry<FlawlessNamingConvention>;
|
|
4214
|
+
/**
|
|
4215
|
+
* Disallow conditional logic in tests
|
|
4216
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/no-conditional-in-test/documentation.md
|
|
4217
|
+
*/
|
|
4218
|
+
'flawless/no-conditional-in-test'?: Linter.RuleEntry<FlawlessNoConditionalInTest>;
|
|
4205
4219
|
/**
|
|
4206
4220
|
* Disallow anonymous arrow functions as export default declarations
|
|
4207
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4221
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/no-export-default-arrow/documentation.md
|
|
4208
4222
|
*/
|
|
4209
4223
|
'flawless/no-export-default-arrow'?: Linter.RuleEntry<[]>;
|
|
4210
4224
|
/**
|
|
4211
4225
|
* Disallow tsconfig options that redundantly re-set a value already provided by an extended config
|
|
4212
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4226
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/no-redundant-tsconfig-options/documentation.md
|
|
4213
4227
|
*/
|
|
4214
4228
|
'flawless/no-redundant-tsconfig-options'?: Linter.RuleEntry<[]>;
|
|
4215
4229
|
/**
|
|
4216
4230
|
* Disallow unnecessary usage of 'useCallback'
|
|
4217
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4231
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/no-unnecessary-use-callback/documentation.md
|
|
4218
4232
|
*/
|
|
4219
4233
|
'flawless/no-unnecessary-use-callback'?: Linter.RuleEntry<[]>;
|
|
4220
4234
|
/**
|
|
4221
4235
|
* Disallow unnecessary usage of 'useMemo'
|
|
4222
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4236
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/no-unnecessary-use-memo/documentation.md
|
|
4223
4237
|
*/
|
|
4224
4238
|
'flawless/no-unnecessary-use-memo'?: Linter.RuleEntry<[]>;
|
|
4225
4239
|
/**
|
|
4226
4240
|
* Enforce a blank line after `expect.assertions` and `expect.hasAssertions`
|
|
4227
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4241
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/padding-after-expect-assertions/documentation.md
|
|
4228
4242
|
*/
|
|
4229
4243
|
'flawless/padding-after-expect-assertions'?: Linter.RuleEntry<[]>;
|
|
4230
4244
|
/**
|
|
4231
4245
|
* Enforce destructuring assignment for component props
|
|
4232
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4246
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/prefer-destructuring-assignment/documentation.md
|
|
4233
4247
|
*/
|
|
4234
4248
|
'flawless/prefer-destructuring-assignment'?: Linter.RuleEntry<[]>;
|
|
4249
|
+
/**
|
|
4250
|
+
* Prefer having the last statement in a test be an assertion
|
|
4251
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/prefer-ending-with-an-expect/documentation.md
|
|
4252
|
+
*/
|
|
4253
|
+
'flawless/prefer-ending-with-an-expect'?: Linter.RuleEntry<FlawlessPreferEndingWithAnExpect>;
|
|
4254
|
+
/**
|
|
4255
|
+
* Prefer `expect.assertions(<count>)` over `expect.hasAssertions()`
|
|
4256
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/prefer-expect-assertions-count/documentation.md
|
|
4257
|
+
*/
|
|
4258
|
+
'flawless/prefer-expect-assertions-count'?: Linter.RuleEntry<[]>;
|
|
4235
4259
|
/**
|
|
4236
4260
|
* Enforce destructuring parameters in the function signature
|
|
4237
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4261
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/prefer-parameter-destructuring/documentation.md
|
|
4238
4262
|
*/
|
|
4239
4263
|
'flawless/prefer-parameter-destructuring'?: Linter.RuleEntry<FlawlessPreferParameterDestructuring>;
|
|
4240
4264
|
/**
|
|
4241
4265
|
* Enforce that function component props are read-only
|
|
4242
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4266
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/prefer-read-only-props/documentation.md
|
|
4243
4267
|
*/
|
|
4244
4268
|
'flawless/prefer-read-only-props'?: Linter.RuleEntry<FlawlessPreferReadOnlyProps>;
|
|
4245
4269
|
/**
|
|
4246
4270
|
* Disallow impure calls such as `math.random` or `os.clock` during render
|
|
4247
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4271
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/purity/documentation.md
|
|
4248
4272
|
*/
|
|
4249
4273
|
'flawless/purity'?: Linter.RuleEntry<FlawlessPurity>;
|
|
4250
4274
|
/**
|
|
4251
4275
|
* Prefer named imports for React runtime values and the React namespace for React types
|
|
4252
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4276
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/react-namespace/documentation.md
|
|
4253
4277
|
*/
|
|
4254
4278
|
'flawless/react-namespace'?: Linter.RuleEntry<[]>;
|
|
4255
4279
|
/**
|
|
4256
4280
|
* Enforce a configured sort order for TOML keys and tables
|
|
4257
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4281
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/toml-sort-keys/documentation.md
|
|
4258
4282
|
*/
|
|
4259
4283
|
'flawless/toml-sort-keys'?: Linter.RuleEntry<FlawlessTomlSortKeys>;
|
|
4260
4284
|
/**
|
|
4261
4285
|
* Enforce blank lines around top-level YAML block collection keys
|
|
4262
|
-
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.
|
|
4286
|
+
* @see https://github.com/christopher-buss/eslint-plugin-flawless/blob/v1.4.1/src/rules/yaml-block-key-blank-lines/documentation.md
|
|
4263
4287
|
*/
|
|
4264
4288
|
'flawless/yaml-block-key-blank-lines'?: Linter.RuleEntry<[]>;
|
|
4265
4289
|
/**
|
|
@@ -4428,357 +4452,357 @@ interface RuleOptions {
|
|
|
4428
4452
|
'init-declarations'?: Linter.RuleEntry<InitDeclarations>;
|
|
4429
4453
|
/**
|
|
4430
4454
|
* Enforce `test` and `it` usage conventions
|
|
4431
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4455
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/consistent-test-it.md
|
|
4432
4456
|
*/
|
|
4433
4457
|
'jest/consistent-test-it'?: Linter.RuleEntry<JestConsistentTestIt>;
|
|
4434
4458
|
/**
|
|
4435
4459
|
* Enforce assertion to be made in a test body
|
|
4436
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4460
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/expect-expect.md
|
|
4437
4461
|
*/
|
|
4438
4462
|
'jest/expect-expect'?: Linter.RuleEntry<JestExpectExpect>;
|
|
4439
4463
|
/**
|
|
4440
4464
|
* Enforces a maximum number assertion calls in a test body
|
|
4441
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4465
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/max-expects.md
|
|
4442
4466
|
*/
|
|
4443
4467
|
'jest/max-expects'?: Linter.RuleEntry<JestMaxExpects>;
|
|
4444
4468
|
/**
|
|
4445
4469
|
* Enforces a maximum depth to nested describe calls
|
|
4446
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4470
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/max-nested-describe.md
|
|
4447
4471
|
*/
|
|
4448
4472
|
'jest/max-nested-describe'?: Linter.RuleEntry<JestMaxNestedDescribe>;
|
|
4449
4473
|
/**
|
|
4450
4474
|
* Disallow alias methods
|
|
4451
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4475
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-alias-methods.md
|
|
4452
4476
|
*/
|
|
4453
4477
|
'jest/no-alias-methods'?: Linter.RuleEntry<[]>;
|
|
4454
4478
|
/**
|
|
4455
4479
|
* Disallow commented out tests
|
|
4456
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4480
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-commented-out-tests.md
|
|
4457
4481
|
*/
|
|
4458
4482
|
'jest/no-commented-out-tests'?: Linter.RuleEntry<[]>;
|
|
4459
4483
|
/**
|
|
4460
4484
|
* Disallow calling `expect` conditionally
|
|
4461
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4485
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-conditional-expect.md
|
|
4462
4486
|
*/
|
|
4463
4487
|
'jest/no-conditional-expect'?: Linter.RuleEntry<[]>;
|
|
4464
4488
|
/**
|
|
4465
4489
|
* Disallow conditional logic in tests
|
|
4466
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4490
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-conditional-in-test.md
|
|
4467
4491
|
*/
|
|
4468
4492
|
'jest/no-conditional-in-test'?: Linter.RuleEntry<JestNoConditionalInTest>;
|
|
4469
4493
|
/**
|
|
4470
4494
|
* Disallow confusing usages of jest.setTimeout
|
|
4471
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4495
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-confusing-set-timeout.md
|
|
4472
4496
|
*/
|
|
4473
4497
|
'jest/no-confusing-set-timeout'?: Linter.RuleEntry<[]>;
|
|
4474
4498
|
/**
|
|
4475
4499
|
* Disallow use of deprecated functions
|
|
4476
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4500
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-deprecated-functions.md
|
|
4477
4501
|
*/
|
|
4478
4502
|
'jest/no-deprecated-functions'?: Linter.RuleEntry<[]>;
|
|
4479
4503
|
/**
|
|
4480
4504
|
* Disallow disabled tests
|
|
4481
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4505
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-disabled-tests.md
|
|
4482
4506
|
*/
|
|
4483
4507
|
'jest/no-disabled-tests'?: Linter.RuleEntry<[]>;
|
|
4484
4508
|
/**
|
|
4485
4509
|
* Disallow using a callback in asynchronous tests and hooks
|
|
4486
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4510
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-done-callback.md
|
|
4487
4511
|
*/
|
|
4488
4512
|
'jest/no-done-callback'?: Linter.RuleEntry<[]>;
|
|
4489
4513
|
/**
|
|
4490
4514
|
* Disallow duplicate setup and teardown hooks
|
|
4491
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4515
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-duplicate-hooks.md
|
|
4492
4516
|
*/
|
|
4493
4517
|
'jest/no-duplicate-hooks'?: Linter.RuleEntry<[]>;
|
|
4494
4518
|
/**
|
|
4495
4519
|
* Disallow using equality matchers on error types
|
|
4496
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4520
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-error-equal.md
|
|
4497
4521
|
*/
|
|
4498
4522
|
'jest/no-error-equal'?: Linter.RuleEntry<[]>;
|
|
4499
4523
|
/**
|
|
4500
4524
|
* Disallow using `exports` in files containing tests
|
|
4501
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4525
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-export.md
|
|
4502
4526
|
*/
|
|
4503
4527
|
'jest/no-export'?: Linter.RuleEntry<[]>;
|
|
4504
4528
|
/**
|
|
4505
4529
|
* Disallow focused tests
|
|
4506
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4530
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-focused-tests.md
|
|
4507
4531
|
*/
|
|
4508
4532
|
'jest/no-focused-tests'?: Linter.RuleEntry<[]>;
|
|
4509
4533
|
/**
|
|
4510
4534
|
* Disallow setup and teardown hooks
|
|
4511
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4535
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-hooks.md
|
|
4512
4536
|
*/
|
|
4513
4537
|
'jest/no-hooks'?: Linter.RuleEntry<JestNoHooks>;
|
|
4514
4538
|
/**
|
|
4515
4539
|
* Disallow identical titles
|
|
4516
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4540
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-identical-title.md
|
|
4517
4541
|
*/
|
|
4518
4542
|
'jest/no-identical-title'?: Linter.RuleEntry<[]>;
|
|
4519
4543
|
/**
|
|
4520
4544
|
* Disallow string interpolation inside snapshots
|
|
4521
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4545
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-interpolation-in-snapshots.md
|
|
4522
4546
|
*/
|
|
4523
4547
|
'jest/no-interpolation-in-snapshots'?: Linter.RuleEntry<[]>;
|
|
4524
4548
|
/**
|
|
4525
4549
|
* Disallow Jasmine globals
|
|
4526
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4550
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-jasmine-globals.md
|
|
4527
4551
|
*/
|
|
4528
4552
|
'jest/no-jasmine-globals'?: Linter.RuleEntry<[]>;
|
|
4529
4553
|
/**
|
|
4530
4554
|
* Disallow large snapshots
|
|
4531
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4555
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-large-snapshots.md
|
|
4532
4556
|
*/
|
|
4533
4557
|
'jest/no-large-snapshots'?: Linter.RuleEntry<JestNoLargeSnapshots>;
|
|
4534
4558
|
/**
|
|
4535
4559
|
* Disallow manually importing from `__mocks__`
|
|
4536
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4560
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-mocks-import.md
|
|
4537
4561
|
*/
|
|
4538
4562
|
'jest/no-mocks-import'?: Linter.RuleEntry<[]>;
|
|
4539
4563
|
/**
|
|
4540
4564
|
* Disallow specific `jest.` methods
|
|
4541
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4565
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-restricted-jest-methods.md
|
|
4542
4566
|
*/
|
|
4543
4567
|
'jest/no-restricted-jest-methods'?: Linter.RuleEntry<JestNoRestrictedJestMethods>;
|
|
4544
4568
|
/**
|
|
4545
4569
|
* Disallow specific matchers & modifiers
|
|
4546
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4570
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-restricted-matchers.md
|
|
4547
4571
|
*/
|
|
4548
4572
|
'jest/no-restricted-matchers'?: Linter.RuleEntry<JestNoRestrictedMatchers>;
|
|
4549
4573
|
/**
|
|
4550
4574
|
* Disallow using `expect` outside of `it` or `test` blocks
|
|
4551
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4575
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-standalone-expect.md
|
|
4552
4576
|
*/
|
|
4553
4577
|
'jest/no-standalone-expect'?: Linter.RuleEntry<JestNoStandaloneExpect>;
|
|
4554
4578
|
/**
|
|
4555
4579
|
* Require using `.only` and `.skip` over `f` and `x`
|
|
4556
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4580
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-test-prefixes.md
|
|
4557
4581
|
*/
|
|
4558
4582
|
'jest/no-test-prefixes'?: Linter.RuleEntry<[]>;
|
|
4559
4583
|
/**
|
|
4560
4584
|
* Disallow explicitly returning from tests
|
|
4561
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4585
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-test-return-statement.md
|
|
4562
4586
|
*/
|
|
4563
4587
|
'jest/no-test-return-statement'?: Linter.RuleEntry<[]>;
|
|
4564
4588
|
/**
|
|
4565
4589
|
* Disallow unnecessary assertions based on types
|
|
4566
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4590
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-unnecessary-assertion.md
|
|
4567
4591
|
*/
|
|
4568
4592
|
'jest/no-unnecessary-assertion'?: Linter.RuleEntry<[]>;
|
|
4569
4593
|
/**
|
|
4570
4594
|
* Disallow unnecessary async function wrapper for expected promises
|
|
4571
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4595
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-unneeded-async-expect-function.md
|
|
4572
4596
|
*/
|
|
4573
4597
|
'jest/no-unneeded-async-expect-function'?: Linter.RuleEntry<[]>;
|
|
4574
4598
|
/**
|
|
4575
4599
|
* Disallow using `jest.mock()` factories without an explicit type parameter
|
|
4576
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4600
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-untyped-mock-factory.md
|
|
4577
4601
|
*/
|
|
4578
4602
|
'jest/no-untyped-mock-factory'?: Linter.RuleEntry<[]>;
|
|
4579
4603
|
/**
|
|
4580
4604
|
* Enforce padding around `afterAll` blocks
|
|
4581
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4605
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-after-all-blocks.md
|
|
4582
4606
|
*/
|
|
4583
4607
|
'jest/padding-around-after-all-blocks'?: Linter.RuleEntry<[]>;
|
|
4584
4608
|
/**
|
|
4585
4609
|
* Enforce padding around `afterEach` blocks
|
|
4586
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4610
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-after-each-blocks.md
|
|
4587
4611
|
*/
|
|
4588
4612
|
'jest/padding-around-after-each-blocks'?: Linter.RuleEntry<[]>;
|
|
4589
4613
|
/**
|
|
4590
4614
|
* Enforce padding around Jest functions
|
|
4591
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4615
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-all.md
|
|
4592
4616
|
*/
|
|
4593
4617
|
'jest/padding-around-all'?: Linter.RuleEntry<[]>;
|
|
4594
4618
|
/**
|
|
4595
4619
|
* Enforce padding around `beforeAll` blocks
|
|
4596
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4620
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-before-all-blocks.md
|
|
4597
4621
|
*/
|
|
4598
4622
|
'jest/padding-around-before-all-blocks'?: Linter.RuleEntry<[]>;
|
|
4599
4623
|
/**
|
|
4600
4624
|
* Enforce padding around `beforeEach` blocks
|
|
4601
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4625
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-before-each-blocks.md
|
|
4602
4626
|
*/
|
|
4603
4627
|
'jest/padding-around-before-each-blocks'?: Linter.RuleEntry<[]>;
|
|
4604
4628
|
/**
|
|
4605
4629
|
* Enforce padding around `describe` blocks
|
|
4606
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4630
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-describe-blocks.md
|
|
4607
4631
|
*/
|
|
4608
4632
|
'jest/padding-around-describe-blocks'?: Linter.RuleEntry<[]>;
|
|
4609
4633
|
/**
|
|
4610
4634
|
* Enforce padding around `expect` groups
|
|
4611
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4635
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-expect-groups.md
|
|
4612
4636
|
*/
|
|
4613
4637
|
'jest/padding-around-expect-groups'?: Linter.RuleEntry<[]>;
|
|
4614
4638
|
/**
|
|
4615
4639
|
* Enforce padding around `test` and `it` blocks
|
|
4616
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4640
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-test-blocks.md
|
|
4617
4641
|
*/
|
|
4618
4642
|
'jest/padding-around-test-blocks'?: Linter.RuleEntry<[]>;
|
|
4619
4643
|
/**
|
|
4620
4644
|
* Suggest using `toHaveBeenCalledWith()`
|
|
4621
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4645
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-called-with.md
|
|
4622
4646
|
*/
|
|
4623
4647
|
'jest/prefer-called-with'?: Linter.RuleEntry<[]>;
|
|
4624
4648
|
/**
|
|
4625
4649
|
* Suggest using the built-in comparison matchers
|
|
4626
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4650
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-comparison-matcher.md
|
|
4627
4651
|
*/
|
|
4628
4652
|
'jest/prefer-comparison-matcher'?: Linter.RuleEntry<[]>;
|
|
4629
4653
|
/**
|
|
4630
4654
|
* Prefer using `.each` rather than manual loops
|
|
4631
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4655
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-each.md
|
|
4632
4656
|
*/
|
|
4633
4657
|
'jest/prefer-each'?: Linter.RuleEntry<[]>;
|
|
4634
4658
|
/**
|
|
4635
4659
|
* Prefer having the last statement in a test be an assertion
|
|
4636
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4660
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-ending-with-an-expect.md
|
|
4637
4661
|
*/
|
|
4638
4662
|
'jest/prefer-ending-with-an-expect'?: Linter.RuleEntry<JestPreferEndingWithAnExpect>;
|
|
4639
4663
|
/**
|
|
4640
4664
|
* Suggest using the built-in equality matchers
|
|
4641
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4665
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-equality-matcher.md
|
|
4642
4666
|
*/
|
|
4643
4667
|
'jest/prefer-equality-matcher'?: Linter.RuleEntry<[]>;
|
|
4644
4668
|
/**
|
|
4645
4669
|
* Suggest using `expect.assertions()` OR `expect.hasAssertions()`
|
|
4646
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4670
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-expect-assertions.md
|
|
4647
4671
|
*/
|
|
4648
4672
|
'jest/prefer-expect-assertions'?: Linter.RuleEntry<JestPreferExpectAssertions>;
|
|
4649
4673
|
/**
|
|
4650
4674
|
* Prefer `await expect(...).resolves` over `expect(await ...)` syntax
|
|
4651
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4675
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-expect-resolves.md
|
|
4652
4676
|
*/
|
|
4653
4677
|
'jest/prefer-expect-resolves'?: Linter.RuleEntry<[]>;
|
|
4654
4678
|
/**
|
|
4655
4679
|
* Prefer having hooks in a consistent order
|
|
4656
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4680
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-hooks-in-order.md
|
|
4657
4681
|
*/
|
|
4658
4682
|
'jest/prefer-hooks-in-order'?: Linter.RuleEntry<[]>;
|
|
4659
4683
|
/**
|
|
4660
4684
|
* Suggest having hooks before any test cases
|
|
4661
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4685
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-hooks-on-top.md
|
|
4662
4686
|
*/
|
|
4663
4687
|
'jest/prefer-hooks-on-top'?: Linter.RuleEntry<[]>;
|
|
4664
4688
|
/**
|
|
4665
4689
|
* Prefer importing Jest globals
|
|
4666
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4690
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-importing-jest-globals.md
|
|
4667
4691
|
*/
|
|
4668
4692
|
'jest/prefer-importing-jest-globals'?: Linter.RuleEntry<JestPreferImportingJestGlobals>;
|
|
4669
4693
|
/**
|
|
4670
4694
|
* Prefer `jest.mocked()` over `fn as jest.Mock`
|
|
4671
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4695
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-jest-mocked.md
|
|
4672
4696
|
*/
|
|
4673
4697
|
'jest/prefer-jest-mocked'?: Linter.RuleEntry<[]>;
|
|
4674
4698
|
/**
|
|
4675
4699
|
* Enforce lowercase test names
|
|
4676
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4700
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-lowercase-title.md
|
|
4677
4701
|
*/
|
|
4678
4702
|
'jest/prefer-lowercase-title'?: Linter.RuleEntry<JestPreferLowercaseTitle>;
|
|
4679
4703
|
/**
|
|
4680
4704
|
* Prefer mock resolved/rejected shorthands for promises
|
|
4681
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4705
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-mock-promise-shorthand.md
|
|
4682
4706
|
*/
|
|
4683
4707
|
'jest/prefer-mock-promise-shorthand'?: Linter.RuleEntry<[]>;
|
|
4684
4708
|
/**
|
|
4685
4709
|
* Prefer mock return shorthands
|
|
4686
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4710
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-mock-return-shorthand.md
|
|
4687
4711
|
*/
|
|
4688
4712
|
'jest/prefer-mock-return-shorthand'?: Linter.RuleEntry<[]>;
|
|
4689
4713
|
/**
|
|
4690
4714
|
* Prefer including a hint with external snapshots
|
|
4691
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4715
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-snapshot-hint.md
|
|
4692
4716
|
*/
|
|
4693
4717
|
'jest/prefer-snapshot-hint'?: Linter.RuleEntry<JestPreferSnapshotHint>;
|
|
4694
4718
|
/**
|
|
4695
4719
|
* Suggest using `jest.spyOn()`
|
|
4696
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4720
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-spy-on.md
|
|
4697
4721
|
*/
|
|
4698
4722
|
'jest/prefer-spy-on'?: Linter.RuleEntry<[]>;
|
|
4699
4723
|
/**
|
|
4700
4724
|
* Suggest using `toStrictEqual()`
|
|
4701
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4725
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-strict-equal.md
|
|
4702
4726
|
*/
|
|
4703
4727
|
'jest/prefer-strict-equal'?: Linter.RuleEntry<[]>;
|
|
4704
4728
|
/**
|
|
4705
4729
|
* Suggest using `toBe()` for primitive literals
|
|
4706
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4730
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-be.md
|
|
4707
4731
|
*/
|
|
4708
4732
|
'jest/prefer-to-be'?: Linter.RuleEntry<[]>;
|
|
4709
4733
|
/**
|
|
4710
4734
|
* Suggest using `toContain()`
|
|
4711
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4735
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-contain.md
|
|
4712
4736
|
*/
|
|
4713
4737
|
'jest/prefer-to-contain'?: Linter.RuleEntry<[]>;
|
|
4714
4738
|
/**
|
|
4715
4739
|
* Suggest using `toHaveBeenCalled`
|
|
4716
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4740
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-been-called.md
|
|
4717
4741
|
*/
|
|
4718
4742
|
'jest/prefer-to-have-been-called'?: Linter.RuleEntry<[]>;
|
|
4719
4743
|
/**
|
|
4720
4744
|
* Suggest using `toHaveBeenCalledTimes()`
|
|
4721
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4745
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-been-called-times.md
|
|
4722
4746
|
*/
|
|
4723
4747
|
'jest/prefer-to-have-been-called-times'?: Linter.RuleEntry<[]>;
|
|
4724
4748
|
/**
|
|
4725
4749
|
* Suggest using `toHaveLength()`
|
|
4726
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4750
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-length.md
|
|
4727
4751
|
*/
|
|
4728
4752
|
'jest/prefer-to-have-length'?: Linter.RuleEntry<[]>;
|
|
4729
4753
|
/**
|
|
4730
4754
|
* Suggest using `test.todo`
|
|
4731
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4755
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-todo.md
|
|
4732
4756
|
*/
|
|
4733
4757
|
'jest/prefer-todo'?: Linter.RuleEntry<[]>;
|
|
4734
4758
|
/**
|
|
4735
4759
|
* Require setup and teardown code to be within a hook
|
|
4736
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4760
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-hook.md
|
|
4737
4761
|
*/
|
|
4738
4762
|
'jest/require-hook'?: Linter.RuleEntry<JestRequireHook>;
|
|
4739
4763
|
/**
|
|
4740
4764
|
* Require a message for `toThrow()`
|
|
4741
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4765
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-to-throw-message.md
|
|
4742
4766
|
*/
|
|
4743
4767
|
'jest/require-to-throw-message'?: Linter.RuleEntry<[]>;
|
|
4744
4768
|
/**
|
|
4745
4769
|
* Require test cases and hooks to be inside a `describe` block
|
|
4746
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4770
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-top-level-describe.md
|
|
4747
4771
|
*/
|
|
4748
4772
|
'jest/require-top-level-describe'?: Linter.RuleEntry<JestRequireTopLevelDescribe>;
|
|
4749
4773
|
/**
|
|
4750
4774
|
* Enforce unbound methods are called with their expected scope
|
|
4751
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4775
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/unbound-method.md
|
|
4752
4776
|
*/
|
|
4753
4777
|
'jest/unbound-method'?: Linter.RuleEntry<JestUnboundMethod>;
|
|
4754
4778
|
/**
|
|
4755
4779
|
* Enforce valid `describe()` callback
|
|
4756
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4780
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-describe-callback.md
|
|
4757
4781
|
*/
|
|
4758
4782
|
'jest/valid-describe-callback'?: Linter.RuleEntry<[]>;
|
|
4759
4783
|
/**
|
|
4760
4784
|
* Enforce valid `expect()` usage
|
|
4761
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4785
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect.md
|
|
4762
4786
|
*/
|
|
4763
4787
|
'jest/valid-expect'?: Linter.RuleEntry<JestValidExpect>;
|
|
4764
4788
|
/**
|
|
4765
4789
|
* Require promises that have expectations in their chain to be valid
|
|
4766
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4790
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect-in-promise.md
|
|
4767
4791
|
*/
|
|
4768
4792
|
'jest/valid-expect-in-promise'?: Linter.RuleEntry<[]>;
|
|
4769
4793
|
/**
|
|
4770
4794
|
* Require that `resolve` and `reject` modifiers are present (and only) for promise-like types
|
|
4771
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4795
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect-with-promise.md
|
|
4772
4796
|
*/
|
|
4773
|
-
'jest/valid-expect-with-promise'?: Linter.RuleEntry<
|
|
4797
|
+
'jest/valid-expect-with-promise'?: Linter.RuleEntry<JestValidExpectWithPromise>;
|
|
4774
4798
|
/**
|
|
4775
4799
|
* Disallow mocking of non-existing module paths
|
|
4776
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4800
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-mock-module-path.md
|
|
4777
4801
|
*/
|
|
4778
4802
|
'jest/valid-mock-module-path'?: Linter.RuleEntry<JestValidMockModulePath>;
|
|
4779
4803
|
/**
|
|
4780
4804
|
* Enforce valid titles
|
|
4781
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
4805
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-title.md
|
|
4782
4806
|
*/
|
|
4783
4807
|
'jest/valid-title'?: Linter.RuleEntry<JestValidTitle>;
|
|
4784
4808
|
/**
|
|
@@ -7333,6 +7357,11 @@ interface RuleOptions {
|
|
|
7333
7357
|
* @see https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm/src/rules/yaml/yaml-enforce-settings.test.ts
|
|
7334
7358
|
*/
|
|
7335
7359
|
'pnpm/yaml-enforce-settings'?: Linter.RuleEntry<PnpmYamlEnforceSettings>;
|
|
7360
|
+
/**
|
|
7361
|
+
* Disallow the anonymous `catalog:` in `pnpm-workspace.yaml` in favor of named catalogs
|
|
7362
|
+
* @see https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm/src/rules/yaml/yaml-no-anonymous-catalog.test.ts
|
|
7363
|
+
*/
|
|
7364
|
+
'pnpm/yaml-no-anonymous-catalog'?: Linter.RuleEntry<[]>;
|
|
7336
7365
|
/**
|
|
7337
7366
|
* Disallow duplicate catalog items in `pnpm-workspace.yaml`
|
|
7338
7367
|
* @see https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm/src/rules/yaml/yaml-no-duplicate-catalog-item.test.ts
|
|
@@ -10789,6 +10818,7 @@ interface RuleOptions {
|
|
|
10789
10818
|
/**
|
|
10790
10819
|
* Disallow specified modules when loaded by `import`
|
|
10791
10820
|
* @see https://typescript-eslint.io/rules/no-restricted-imports
|
|
10821
|
+
* @deprecated
|
|
10792
10822
|
*/
|
|
10793
10823
|
'ts/no-restricted-imports'?: Linter.RuleEntry<TsNoRestrictedImports>;
|
|
10794
10824
|
/**
|
|
@@ -14180,6 +14210,16 @@ interface _FlawlessNamingConvention_MatchRegexConfig {
|
|
|
14180
14210
|
match: boolean;
|
|
14181
14211
|
regex: string;
|
|
14182
14212
|
}
|
|
14213
|
+
// ----- flawless/no-conditional-in-test -----
|
|
14214
|
+
type FlawlessNoConditionalInTest = [] | [{
|
|
14215
|
+
additionalTestBlockFunctions?: string[];
|
|
14216
|
+
allowOptionalChaining?: boolean;
|
|
14217
|
+
}];
|
|
14218
|
+
// ----- flawless/prefer-ending-with-an-expect -----
|
|
14219
|
+
type FlawlessPreferEndingWithAnExpect = [] | [{
|
|
14220
|
+
additionalTestBlockFunctions?: string[];
|
|
14221
|
+
assertFunctionNames?: string[];
|
|
14222
|
+
}];
|
|
14183
14223
|
// ----- flawless/prefer-parameter-destructuring -----
|
|
14184
14224
|
type FlawlessPreferParameterDestructuring = [] | [{
|
|
14185
14225
|
allowSideEffectReordering?: boolean;
|
|
@@ -14462,6 +14502,10 @@ type JestValidExpect = [] | [{
|
|
|
14462
14502
|
minArgs?: number;
|
|
14463
14503
|
maxArgs?: number;
|
|
14464
14504
|
}];
|
|
14505
|
+
// ----- jest/valid-expect-with-promise -----
|
|
14506
|
+
type JestValidExpectWithPromise = [] | [{
|
|
14507
|
+
checkThenables?: boolean;
|
|
14508
|
+
}];
|
|
14465
14509
|
// ----- jest/valid-mock-module-path -----
|
|
14466
14510
|
type JestValidMockModulePath = [] | [{
|
|
14467
14511
|
moduleFileExtensions?: string[];
|
|
@@ -14717,6 +14761,7 @@ type JsdocNoUndefinedTypes = [] | [{
|
|
|
14717
14761
|
type JsdocNormalizeSeeLinks = [] | [{
|
|
14718
14762
|
canonicalForm?: ("pipe" | "prefix");
|
|
14719
14763
|
enableFixer?: boolean;
|
|
14764
|
+
wrapBareUrls?: boolean;
|
|
14720
14765
|
}];
|
|
14721
14766
|
// ----- jsdoc/prefer-import-tag -----
|
|
14722
14767
|
type JsdocPreferImportTag = [] | [{
|
|
@@ -23947,7 +23992,49 @@ interface PerfectionistConfig {
|
|
|
23947
23992
|
*/
|
|
23948
23993
|
sortObjectsJsx?: Partial<ExtractRuleOptions<NonNullable<RuleOptions["perfectionist/sort-objects"]>>[0]>;
|
|
23949
23994
|
}
|
|
23950
|
-
|
|
23995
|
+
/**
|
|
23996
|
+
* The analyzer settings `@eslint-react` reads from `settings["react-x"]`,
|
|
23997
|
+
* declared here rather than imported from `@eslint-react/shared`.
|
|
23998
|
+
*
|
|
23999
|
+
* Upstream derives its own type from a Zod schema, so importing it would put
|
|
24000
|
+
* `zod` in the published declarations — and `@eslint-react/shared` itself,
|
|
24001
|
+
* which is a build-time dependency consumers never install. The shape is six
|
|
24002
|
+
* optional primitives, so restating it costs nothing.
|
|
24003
|
+
* `test/react-settings.spec.ts` fails if the two ever drift apart.
|
|
24004
|
+
*/
|
|
24005
|
+
interface ReactSettings {
|
|
24006
|
+
/**
|
|
24007
|
+
* A pattern matching custom hooks to treat as effect hooks, alongside
|
|
24008
|
+
* `useEffect` and friends.
|
|
24009
|
+
*/
|
|
24010
|
+
additionalEffectHooks?: string;
|
|
24011
|
+
/**
|
|
24012
|
+
* A pattern matching custom hooks to treat as state hooks, alongside
|
|
24013
|
+
* `useState` and friends.
|
|
24014
|
+
*/
|
|
24015
|
+
additionalStateHooks?: string;
|
|
24016
|
+
/** How the React Compiler decides which components to compile. */
|
|
24017
|
+
compilationMode?: "all" | "annotation" | "infer" | "syntax";
|
|
24018
|
+
/**
|
|
24019
|
+
* The module React is imported from.
|
|
24020
|
+
*
|
|
24021
|
+
* @default "react"
|
|
24022
|
+
*/
|
|
24023
|
+
importSource?: string;
|
|
24024
|
+
/**
|
|
24025
|
+
* The prop a polymorphic component uses to override its element.
|
|
24026
|
+
*
|
|
24027
|
+
* @default "as"
|
|
24028
|
+
*/
|
|
24029
|
+
polymorphicPropName?: string;
|
|
24030
|
+
/**
|
|
24031
|
+
* The React version to assume, rather than detecting it.
|
|
24032
|
+
*
|
|
24033
|
+
* @default "detect"
|
|
24034
|
+
*/
|
|
24035
|
+
version?: string;
|
|
24036
|
+
}
|
|
24037
|
+
type ReactConfig = OptionsOverridesTypeAware & ReactSettings & {
|
|
23951
24038
|
/**
|
|
23952
24039
|
* Whether to enable the React Compiler rules.
|
|
23953
24040
|
*
|
|
@@ -28737,357 +28824,357 @@ interface OxlintRenamedJsPluginRuleOptions {
|
|
|
28737
28824
|
'import-js/prefer-default-export'?: RuleOptions['import/prefer-default-export'];
|
|
28738
28825
|
/**
|
|
28739
28826
|
* Enforce `test` and `it` usage conventions
|
|
28740
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28827
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/consistent-test-it.md
|
|
28741
28828
|
*/
|
|
28742
28829
|
'jest-js/consistent-test-it'?: RuleOptions['jest/consistent-test-it'];
|
|
28743
28830
|
/**
|
|
28744
28831
|
* Enforce assertion to be made in a test body
|
|
28745
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28832
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/expect-expect.md
|
|
28746
28833
|
*/
|
|
28747
28834
|
'jest-js/expect-expect'?: RuleOptions['jest/expect-expect'];
|
|
28748
28835
|
/**
|
|
28749
28836
|
* Enforces a maximum number assertion calls in a test body
|
|
28750
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28837
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/max-expects.md
|
|
28751
28838
|
*/
|
|
28752
28839
|
'jest-js/max-expects'?: RuleOptions['jest/max-expects'];
|
|
28753
28840
|
/**
|
|
28754
28841
|
* Enforces a maximum depth to nested describe calls
|
|
28755
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28842
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/max-nested-describe.md
|
|
28756
28843
|
*/
|
|
28757
28844
|
'jest-js/max-nested-describe'?: RuleOptions['jest/max-nested-describe'];
|
|
28758
28845
|
/**
|
|
28759
28846
|
* Disallow alias methods
|
|
28760
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28847
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-alias-methods.md
|
|
28761
28848
|
*/
|
|
28762
28849
|
'jest-js/no-alias-methods'?: RuleOptions['jest/no-alias-methods'];
|
|
28763
28850
|
/**
|
|
28764
28851
|
* Disallow commented out tests
|
|
28765
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28852
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-commented-out-tests.md
|
|
28766
28853
|
*/
|
|
28767
28854
|
'jest-js/no-commented-out-tests'?: RuleOptions['jest/no-commented-out-tests'];
|
|
28768
28855
|
/**
|
|
28769
28856
|
* Disallow calling `expect` conditionally
|
|
28770
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28857
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-conditional-expect.md
|
|
28771
28858
|
*/
|
|
28772
28859
|
'jest-js/no-conditional-expect'?: RuleOptions['jest/no-conditional-expect'];
|
|
28773
28860
|
/**
|
|
28774
28861
|
* Disallow conditional logic in tests
|
|
28775
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28862
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-conditional-in-test.md
|
|
28776
28863
|
*/
|
|
28777
28864
|
'jest-js/no-conditional-in-test'?: RuleOptions['jest/no-conditional-in-test'];
|
|
28778
28865
|
/**
|
|
28779
28866
|
* Disallow confusing usages of jest.setTimeout
|
|
28780
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28867
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-confusing-set-timeout.md
|
|
28781
28868
|
*/
|
|
28782
28869
|
'jest-js/no-confusing-set-timeout'?: RuleOptions['jest/no-confusing-set-timeout'];
|
|
28783
28870
|
/**
|
|
28784
28871
|
* Disallow use of deprecated functions
|
|
28785
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28872
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-deprecated-functions.md
|
|
28786
28873
|
*/
|
|
28787
28874
|
'jest-js/no-deprecated-functions'?: RuleOptions['jest/no-deprecated-functions'];
|
|
28788
28875
|
/**
|
|
28789
28876
|
* Disallow disabled tests
|
|
28790
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28877
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-disabled-tests.md
|
|
28791
28878
|
*/
|
|
28792
28879
|
'jest-js/no-disabled-tests'?: RuleOptions['jest/no-disabled-tests'];
|
|
28793
28880
|
/**
|
|
28794
28881
|
* Disallow using a callback in asynchronous tests and hooks
|
|
28795
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28882
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-done-callback.md
|
|
28796
28883
|
*/
|
|
28797
28884
|
'jest-js/no-done-callback'?: RuleOptions['jest/no-done-callback'];
|
|
28798
28885
|
/**
|
|
28799
28886
|
* Disallow duplicate setup and teardown hooks
|
|
28800
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28887
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-duplicate-hooks.md
|
|
28801
28888
|
*/
|
|
28802
28889
|
'jest-js/no-duplicate-hooks'?: RuleOptions['jest/no-duplicate-hooks'];
|
|
28803
28890
|
/**
|
|
28804
28891
|
* Disallow using equality matchers on error types
|
|
28805
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28892
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-error-equal.md
|
|
28806
28893
|
*/
|
|
28807
28894
|
'jest-js/no-error-equal'?: RuleOptions['jest/no-error-equal'];
|
|
28808
28895
|
/**
|
|
28809
28896
|
* Disallow using `exports` in files containing tests
|
|
28810
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28897
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-export.md
|
|
28811
28898
|
*/
|
|
28812
28899
|
'jest-js/no-export'?: RuleOptions['jest/no-export'];
|
|
28813
28900
|
/**
|
|
28814
28901
|
* Disallow focused tests
|
|
28815
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28902
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-focused-tests.md
|
|
28816
28903
|
*/
|
|
28817
28904
|
'jest-js/no-focused-tests'?: RuleOptions['jest/no-focused-tests'];
|
|
28818
28905
|
/**
|
|
28819
28906
|
* Disallow setup and teardown hooks
|
|
28820
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28907
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-hooks.md
|
|
28821
28908
|
*/
|
|
28822
28909
|
'jest-js/no-hooks'?: RuleOptions['jest/no-hooks'];
|
|
28823
28910
|
/**
|
|
28824
28911
|
* Disallow identical titles
|
|
28825
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28912
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-identical-title.md
|
|
28826
28913
|
*/
|
|
28827
28914
|
'jest-js/no-identical-title'?: RuleOptions['jest/no-identical-title'];
|
|
28828
28915
|
/**
|
|
28829
28916
|
* Disallow string interpolation inside snapshots
|
|
28830
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28917
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-interpolation-in-snapshots.md
|
|
28831
28918
|
*/
|
|
28832
28919
|
'jest-js/no-interpolation-in-snapshots'?: RuleOptions['jest/no-interpolation-in-snapshots'];
|
|
28833
28920
|
/**
|
|
28834
28921
|
* Disallow Jasmine globals
|
|
28835
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28922
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-jasmine-globals.md
|
|
28836
28923
|
*/
|
|
28837
28924
|
'jest-js/no-jasmine-globals'?: RuleOptions['jest/no-jasmine-globals'];
|
|
28838
28925
|
/**
|
|
28839
28926
|
* Disallow large snapshots
|
|
28840
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28927
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-large-snapshots.md
|
|
28841
28928
|
*/
|
|
28842
28929
|
'jest-js/no-large-snapshots'?: RuleOptions['jest/no-large-snapshots'];
|
|
28843
28930
|
/**
|
|
28844
28931
|
* Disallow manually importing from `__mocks__`
|
|
28845
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28932
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-mocks-import.md
|
|
28846
28933
|
*/
|
|
28847
28934
|
'jest-js/no-mocks-import'?: RuleOptions['jest/no-mocks-import'];
|
|
28848
28935
|
/**
|
|
28849
28936
|
* Disallow specific `jest.` methods
|
|
28850
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28937
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-restricted-jest-methods.md
|
|
28851
28938
|
*/
|
|
28852
28939
|
'jest-js/no-restricted-jest-methods'?: RuleOptions['jest/no-restricted-jest-methods'];
|
|
28853
28940
|
/**
|
|
28854
28941
|
* Disallow specific matchers & modifiers
|
|
28855
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28942
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-restricted-matchers.md
|
|
28856
28943
|
*/
|
|
28857
28944
|
'jest-js/no-restricted-matchers'?: RuleOptions['jest/no-restricted-matchers'];
|
|
28858
28945
|
/**
|
|
28859
28946
|
* Disallow using `expect` outside of `it` or `test` blocks
|
|
28860
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28947
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-standalone-expect.md
|
|
28861
28948
|
*/
|
|
28862
28949
|
'jest-js/no-standalone-expect'?: RuleOptions['jest/no-standalone-expect'];
|
|
28863
28950
|
/**
|
|
28864
28951
|
* Require using `.only` and `.skip` over `f` and `x`
|
|
28865
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28952
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-test-prefixes.md
|
|
28866
28953
|
*/
|
|
28867
28954
|
'jest-js/no-test-prefixes'?: RuleOptions['jest/no-test-prefixes'];
|
|
28868
28955
|
/**
|
|
28869
28956
|
* Disallow explicitly returning from tests
|
|
28870
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28957
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-test-return-statement.md
|
|
28871
28958
|
*/
|
|
28872
28959
|
'jest-js/no-test-return-statement'?: RuleOptions['jest/no-test-return-statement'];
|
|
28873
28960
|
/**
|
|
28874
28961
|
* Disallow unnecessary assertions based on types
|
|
28875
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28962
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-unnecessary-assertion.md
|
|
28876
28963
|
*/
|
|
28877
28964
|
'jest-js/no-unnecessary-assertion'?: RuleOptions['jest/no-unnecessary-assertion'];
|
|
28878
28965
|
/**
|
|
28879
28966
|
* Disallow unnecessary async function wrapper for expected promises
|
|
28880
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28967
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-unneeded-async-expect-function.md
|
|
28881
28968
|
*/
|
|
28882
28969
|
'jest-js/no-unneeded-async-expect-function'?: RuleOptions['jest/no-unneeded-async-expect-function'];
|
|
28883
28970
|
/**
|
|
28884
28971
|
* Disallow using `jest.mock()` factories without an explicit type parameter
|
|
28885
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28972
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/no-untyped-mock-factory.md
|
|
28886
28973
|
*/
|
|
28887
28974
|
'jest-js/no-untyped-mock-factory'?: RuleOptions['jest/no-untyped-mock-factory'];
|
|
28888
28975
|
/**
|
|
28889
28976
|
* Enforce padding around `afterAll` blocks
|
|
28890
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28977
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-after-all-blocks.md
|
|
28891
28978
|
*/
|
|
28892
28979
|
'jest-js/padding-around-after-all-blocks'?: RuleOptions['jest/padding-around-after-all-blocks'];
|
|
28893
28980
|
/**
|
|
28894
28981
|
* Enforce padding around `afterEach` blocks
|
|
28895
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28982
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-after-each-blocks.md
|
|
28896
28983
|
*/
|
|
28897
28984
|
'jest-js/padding-around-after-each-blocks'?: RuleOptions['jest/padding-around-after-each-blocks'];
|
|
28898
28985
|
/**
|
|
28899
28986
|
* Enforce padding around Jest functions
|
|
28900
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28987
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-all.md
|
|
28901
28988
|
*/
|
|
28902
28989
|
'jest-js/padding-around-all'?: RuleOptions['jest/padding-around-all'];
|
|
28903
28990
|
/**
|
|
28904
28991
|
* Enforce padding around `beforeAll` blocks
|
|
28905
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28992
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-before-all-blocks.md
|
|
28906
28993
|
*/
|
|
28907
28994
|
'jest-js/padding-around-before-all-blocks'?: RuleOptions['jest/padding-around-before-all-blocks'];
|
|
28908
28995
|
/**
|
|
28909
28996
|
* Enforce padding around `beforeEach` blocks
|
|
28910
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
28997
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-before-each-blocks.md
|
|
28911
28998
|
*/
|
|
28912
28999
|
'jest-js/padding-around-before-each-blocks'?: RuleOptions['jest/padding-around-before-each-blocks'];
|
|
28913
29000
|
/**
|
|
28914
29001
|
* Enforce padding around `describe` blocks
|
|
28915
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29002
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-describe-blocks.md
|
|
28916
29003
|
*/
|
|
28917
29004
|
'jest-js/padding-around-describe-blocks'?: RuleOptions['jest/padding-around-describe-blocks'];
|
|
28918
29005
|
/**
|
|
28919
29006
|
* Enforce padding around `expect` groups
|
|
28920
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29007
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-expect-groups.md
|
|
28921
29008
|
*/
|
|
28922
29009
|
'jest-js/padding-around-expect-groups'?: RuleOptions['jest/padding-around-expect-groups'];
|
|
28923
29010
|
/**
|
|
28924
29011
|
* Enforce padding around `test` and `it` blocks
|
|
28925
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29012
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/padding-around-test-blocks.md
|
|
28926
29013
|
*/
|
|
28927
29014
|
'jest-js/padding-around-test-blocks'?: RuleOptions['jest/padding-around-test-blocks'];
|
|
28928
29015
|
/**
|
|
28929
29016
|
* Suggest using `toHaveBeenCalledWith()`
|
|
28930
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29017
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-called-with.md
|
|
28931
29018
|
*/
|
|
28932
29019
|
'jest-js/prefer-called-with'?: RuleOptions['jest/prefer-called-with'];
|
|
28933
29020
|
/**
|
|
28934
29021
|
* Suggest using the built-in comparison matchers
|
|
28935
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29022
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-comparison-matcher.md
|
|
28936
29023
|
*/
|
|
28937
29024
|
'jest-js/prefer-comparison-matcher'?: RuleOptions['jest/prefer-comparison-matcher'];
|
|
28938
29025
|
/**
|
|
28939
29026
|
* Prefer using `.each` rather than manual loops
|
|
28940
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29027
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-each.md
|
|
28941
29028
|
*/
|
|
28942
29029
|
'jest-js/prefer-each'?: RuleOptions['jest/prefer-each'];
|
|
28943
29030
|
/**
|
|
28944
29031
|
* Prefer having the last statement in a test be an assertion
|
|
28945
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29032
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-ending-with-an-expect.md
|
|
28946
29033
|
*/
|
|
28947
29034
|
'jest-js/prefer-ending-with-an-expect'?: RuleOptions['jest/prefer-ending-with-an-expect'];
|
|
28948
29035
|
/**
|
|
28949
29036
|
* Suggest using the built-in equality matchers
|
|
28950
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29037
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-equality-matcher.md
|
|
28951
29038
|
*/
|
|
28952
29039
|
'jest-js/prefer-equality-matcher'?: RuleOptions['jest/prefer-equality-matcher'];
|
|
28953
29040
|
/**
|
|
28954
29041
|
* Suggest using `expect.assertions()` OR `expect.hasAssertions()`
|
|
28955
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29042
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-expect-assertions.md
|
|
28956
29043
|
*/
|
|
28957
29044
|
'jest-js/prefer-expect-assertions'?: RuleOptions['jest/prefer-expect-assertions'];
|
|
28958
29045
|
/**
|
|
28959
29046
|
* Prefer `await expect(...).resolves` over `expect(await ...)` syntax
|
|
28960
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29047
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-expect-resolves.md
|
|
28961
29048
|
*/
|
|
28962
29049
|
'jest-js/prefer-expect-resolves'?: RuleOptions['jest/prefer-expect-resolves'];
|
|
28963
29050
|
/**
|
|
28964
29051
|
* Prefer having hooks in a consistent order
|
|
28965
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29052
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-hooks-in-order.md
|
|
28966
29053
|
*/
|
|
28967
29054
|
'jest-js/prefer-hooks-in-order'?: RuleOptions['jest/prefer-hooks-in-order'];
|
|
28968
29055
|
/**
|
|
28969
29056
|
* Suggest having hooks before any test cases
|
|
28970
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29057
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-hooks-on-top.md
|
|
28971
29058
|
*/
|
|
28972
29059
|
'jest-js/prefer-hooks-on-top'?: RuleOptions['jest/prefer-hooks-on-top'];
|
|
28973
29060
|
/**
|
|
28974
29061
|
* Prefer importing Jest globals
|
|
28975
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29062
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-importing-jest-globals.md
|
|
28976
29063
|
*/
|
|
28977
29064
|
'jest-js/prefer-importing-jest-globals'?: RuleOptions['jest/prefer-importing-jest-globals'];
|
|
28978
29065
|
/**
|
|
28979
29066
|
* Prefer `jest.mocked()` over `fn as jest.Mock`
|
|
28980
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29067
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-jest-mocked.md
|
|
28981
29068
|
*/
|
|
28982
29069
|
'jest-js/prefer-jest-mocked'?: RuleOptions['jest/prefer-jest-mocked'];
|
|
28983
29070
|
/**
|
|
28984
29071
|
* Enforce lowercase test names
|
|
28985
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29072
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-lowercase-title.md
|
|
28986
29073
|
*/
|
|
28987
29074
|
'jest-js/prefer-lowercase-title'?: RuleOptions['jest/prefer-lowercase-title'];
|
|
28988
29075
|
/**
|
|
28989
29076
|
* Prefer mock resolved/rejected shorthands for promises
|
|
28990
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29077
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-mock-promise-shorthand.md
|
|
28991
29078
|
*/
|
|
28992
29079
|
'jest-js/prefer-mock-promise-shorthand'?: RuleOptions['jest/prefer-mock-promise-shorthand'];
|
|
28993
29080
|
/**
|
|
28994
29081
|
* Prefer mock return shorthands
|
|
28995
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29082
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-mock-return-shorthand.md
|
|
28996
29083
|
*/
|
|
28997
29084
|
'jest-js/prefer-mock-return-shorthand'?: RuleOptions['jest/prefer-mock-return-shorthand'];
|
|
28998
29085
|
/**
|
|
28999
29086
|
* Prefer including a hint with external snapshots
|
|
29000
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29087
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-snapshot-hint.md
|
|
29001
29088
|
*/
|
|
29002
29089
|
'jest-js/prefer-snapshot-hint'?: RuleOptions['jest/prefer-snapshot-hint'];
|
|
29003
29090
|
/**
|
|
29004
29091
|
* Suggest using `jest.spyOn()`
|
|
29005
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29092
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-spy-on.md
|
|
29006
29093
|
*/
|
|
29007
29094
|
'jest-js/prefer-spy-on'?: RuleOptions['jest/prefer-spy-on'];
|
|
29008
29095
|
/**
|
|
29009
29096
|
* Suggest using `toStrictEqual()`
|
|
29010
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29097
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-strict-equal.md
|
|
29011
29098
|
*/
|
|
29012
29099
|
'jest-js/prefer-strict-equal'?: RuleOptions['jest/prefer-strict-equal'];
|
|
29013
29100
|
/**
|
|
29014
29101
|
* Suggest using `toBe()` for primitive literals
|
|
29015
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29102
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-be.md
|
|
29016
29103
|
*/
|
|
29017
29104
|
'jest-js/prefer-to-be'?: RuleOptions['jest/prefer-to-be'];
|
|
29018
29105
|
/**
|
|
29019
29106
|
* Suggest using `toContain()`
|
|
29020
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29107
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-contain.md
|
|
29021
29108
|
*/
|
|
29022
29109
|
'jest-js/prefer-to-contain'?: RuleOptions['jest/prefer-to-contain'];
|
|
29023
29110
|
/**
|
|
29024
29111
|
* Suggest using `toHaveBeenCalled`
|
|
29025
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29112
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-been-called.md
|
|
29026
29113
|
*/
|
|
29027
29114
|
'jest-js/prefer-to-have-been-called'?: RuleOptions['jest/prefer-to-have-been-called'];
|
|
29028
29115
|
/**
|
|
29029
29116
|
* Suggest using `toHaveBeenCalledTimes()`
|
|
29030
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29117
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-been-called-times.md
|
|
29031
29118
|
*/
|
|
29032
29119
|
'jest-js/prefer-to-have-been-called-times'?: RuleOptions['jest/prefer-to-have-been-called-times'];
|
|
29033
29120
|
/**
|
|
29034
29121
|
* Suggest using `toHaveLength()`
|
|
29035
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29122
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-to-have-length.md
|
|
29036
29123
|
*/
|
|
29037
29124
|
'jest-js/prefer-to-have-length'?: RuleOptions['jest/prefer-to-have-length'];
|
|
29038
29125
|
/**
|
|
29039
29126
|
* Suggest using `test.todo`
|
|
29040
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29127
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/prefer-todo.md
|
|
29041
29128
|
*/
|
|
29042
29129
|
'jest-js/prefer-todo'?: RuleOptions['jest/prefer-todo'];
|
|
29043
29130
|
/**
|
|
29044
29131
|
* Require setup and teardown code to be within a hook
|
|
29045
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29132
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-hook.md
|
|
29046
29133
|
*/
|
|
29047
29134
|
'jest-js/require-hook'?: RuleOptions['jest/require-hook'];
|
|
29048
29135
|
/**
|
|
29049
29136
|
* Require a message for `toThrow()`
|
|
29050
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29137
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-to-throw-message.md
|
|
29051
29138
|
*/
|
|
29052
29139
|
'jest-js/require-to-throw-message'?: RuleOptions['jest/require-to-throw-message'];
|
|
29053
29140
|
/**
|
|
29054
29141
|
* Require test cases and hooks to be inside a `describe` block
|
|
29055
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29142
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/require-top-level-describe.md
|
|
29056
29143
|
*/
|
|
29057
29144
|
'jest-js/require-top-level-describe'?: RuleOptions['jest/require-top-level-describe'];
|
|
29058
29145
|
/**
|
|
29059
29146
|
* Enforce unbound methods are called with their expected scope
|
|
29060
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29147
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/unbound-method.md
|
|
29061
29148
|
*/
|
|
29062
29149
|
'jest-js/unbound-method'?: RuleOptions['jest/unbound-method'];
|
|
29063
29150
|
/**
|
|
29064
29151
|
* Enforce valid `describe()` callback
|
|
29065
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29152
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-describe-callback.md
|
|
29066
29153
|
*/
|
|
29067
29154
|
'jest-js/valid-describe-callback'?: RuleOptions['jest/valid-describe-callback'];
|
|
29068
29155
|
/**
|
|
29069
29156
|
* Enforce valid `expect()` usage
|
|
29070
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29157
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect.md
|
|
29071
29158
|
*/
|
|
29072
29159
|
'jest-js/valid-expect'?: RuleOptions['jest/valid-expect'];
|
|
29073
29160
|
/**
|
|
29074
29161
|
* Require promises that have expectations in their chain to be valid
|
|
29075
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29162
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect-in-promise.md
|
|
29076
29163
|
*/
|
|
29077
29164
|
'jest-js/valid-expect-in-promise'?: RuleOptions['jest/valid-expect-in-promise'];
|
|
29078
29165
|
/**
|
|
29079
29166
|
* Require that `resolve` and `reject` modifiers are present (and only) for promise-like types
|
|
29080
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29167
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-expect-with-promise.md
|
|
29081
29168
|
*/
|
|
29082
29169
|
'jest-js/valid-expect-with-promise'?: RuleOptions['jest/valid-expect-with-promise'];
|
|
29083
29170
|
/**
|
|
29084
29171
|
* Disallow mocking of non-existing module paths
|
|
29085
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29172
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-mock-module-path.md
|
|
29086
29173
|
*/
|
|
29087
29174
|
'jest-js/valid-mock-module-path'?: RuleOptions['jest/valid-mock-module-path'];
|
|
29088
29175
|
/**
|
|
29089
29176
|
* Enforce valid titles
|
|
29090
|
-
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.
|
|
29177
|
+
* @see https://github.com/jest-community/eslint-plugin-jest/blob/v29.16.0/docs/rules/valid-title.md
|
|
29091
29178
|
*/
|
|
29092
29179
|
'jest-js/valid-title'?: RuleOptions['jest/valid-title'];
|
|
29093
29180
|
/**
|
|
@@ -32308,6 +32395,25 @@ type OxlintFactoryOptions = {
|
|
|
32308
32395
|
* enabling one category leaves the rest off.
|
|
32309
32396
|
*/
|
|
32310
32397
|
categories?: RuleCategories$1;
|
|
32398
|
+
/**
|
|
32399
|
+
* The directory holding this config, normally `import.meta.dirname`.
|
|
32400
|
+
*
|
|
32401
|
+
* Oxlint matches `overrides[].files` against paths relative to the config
|
|
32402
|
+
* that declares them, and nested configs replace their ancestors rather
|
|
32403
|
+
* than merging. A relaxation anchored on a directory name — `scripts`,
|
|
32404
|
+
* `tools`, `bin` — therefore cannot match from a config that already lives
|
|
32405
|
+
* inside that directory, because the anchor segment is not part of the path
|
|
32406
|
+
* being tested.
|
|
32407
|
+
*
|
|
32408
|
+
* Supplying this lets the factory emit an anchor-stripped variant alongside
|
|
32409
|
+
* each such pattern. Omit it and those relaxations are silently inert in
|
|
32410
|
+
* nested configs.
|
|
32411
|
+
*
|
|
32412
|
+
* Unlike ESLint, oxlint has no per-override base path to set instead:
|
|
32413
|
+
* `basePath` is rejected outright by its schema, and the upstream
|
|
32414
|
+
* equivalent is unresolved (oxc-project/oxc#24276).
|
|
32415
|
+
*/
|
|
32416
|
+
configDirectory?: string;
|
|
32311
32417
|
/**
|
|
32312
32418
|
* Extra jsPlugins to load, or `false` to run oxlint with native rules
|
|
32313
32419
|
* only.
|