@kazupon/eslint-config 0.18.0 → 0.20.0

package/dist/types/gens/vitest.d.ts

@@ -1,377 +0,0 @@
-import type { Linter } from 'eslint';
-export interface VitestRules {
-    /**
-     * require .spec test file pattern
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
-     */
-    'vitest/consistent-test-filename'?: Linter.RuleEntry<VitestConsistentTestFilename>;
-    /**
-     * enforce using test or it but not both
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md
-     */
-    'vitest/consistent-test-it'?: Linter.RuleEntry<VitestConsistentTestIt>;
-    /**
-     * enforce having expectation in test body
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md
-     */
-    'vitest/expect-expect'?: Linter.RuleEntry<VitestExpectExpect>;
-    /**
-     * Enforce padding around afterAll blocks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/index.md
-     */
-    'vitest/index'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce a maximum number of expect per test
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md
-     */
-    'vitest/max-expects'?: Linter.RuleEntry<VitestMaxExpects>;
-    /**
-     * require describe block to be less than set max value or default value
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md
-     */
-    'vitest/max-nested-describe'?: Linter.RuleEntry<VitestMaxNestedDescribe>;
-    /**
-     * disallow alias methods
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-alias-methods.md
-     */
-    'vitest/no-alias-methods'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow commented out tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-commented-out-tests.md
-     */
-    'vitest/no-commented-out-tests'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow conditional expects
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
-     */
-    'vitest/no-conditional-expect'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow conditional tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md
-     */
-    'vitest/no-conditional-in-test'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow conditional tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-tests.md
-     */
-    'vitest/no-conditional-tests'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow disabled tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
-     */
-    'vitest/no-disabled-tests'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow using a callback in asynchronous tests and hooks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-done-callback.md
-     * @deprecated
-     */
-    'vitest/no-done-callback'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow duplicate hooks and teardown hooks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md
-     */
-    'vitest/no-duplicate-hooks'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow focused tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
-     */
-    'vitest/no-focused-tests'?: Linter.RuleEntry<VitestNoFocusedTests>;
-    /**
-     * disallow setup and teardown hooks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-hooks.md
-     */
-    'vitest/no-hooks'?: Linter.RuleEntry<VitestNoHooks>;
-    /**
-     * disallow identical titles
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md
-     */
-    'vitest/no-identical-title'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow importing `node:test`
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
-     */
-    'vitest/no-import-node-test'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow string interpolation in snapshots
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md
-     */
-    'vitest/no-interpolation-in-snapshots'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow large snapshots
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-large-snapshots.md
-     */
-    'vitest/no-large-snapshots'?: Linter.RuleEntry<VitestNoLargeSnapshots>;
-    /**
-     * disallow importing from __mocks__ directory
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-mocks-import.md
-     */
-    'vitest/no-mocks-import'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow the use of certain matchers
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-matchers.md
-     */
-    'vitest/no-restricted-matchers'?: Linter.RuleEntry<VitestNoRestrictedMatchers>;
-    /**
-     * disallow specific `vi.` methods
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md
-     */
-    'vitest/no-restricted-vi-methods'?: Linter.RuleEntry<VitestNoRestrictedViMethods>;
-    /**
-     * disallow using `expect` outside of `it` or `test` blocks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md
-     */
-    'vitest/no-standalone-expect'?: Linter.RuleEntry<VitestNoStandaloneExpect>;
-    /**
-     * disallow using `test` as a prefix
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-prefixes.md
-     */
-    'vitest/no-test-prefixes'?: Linter.RuleEntry<[]>;
-    /**
-     * disallow return statements in tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md
-     */
-    'vitest/no-test-return-statement'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using `toBeCalledWith()` or `toHaveBeenCalledWith()`
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md
-     */
-    'vitest/prefer-called-with'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using the built-in comparison matchers
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md
-     */
-    'vitest/prefer-comparison-matcher'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using `each` rather than manual loops
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md
-     */
-    'vitest/prefer-each'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using the built-in quality matchers
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-equality-matcher.md
-     */
-    'vitest/prefer-equality-matcher'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using expect assertions instead of callbacks
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-assertions.md
-     */
-    'vitest/prefer-expect-assertions'?: Linter.RuleEntry<VitestPreferExpectAssertions>;
-    /**
-     * enforce using `expect().resolves` over `expect(await ...)` syntax
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md
-     */
-    'vitest/prefer-expect-resolves'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce having hooks in consistent order
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
-     */
-    'vitest/prefer-hooks-in-order'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce having hooks before any test cases
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md
-     */
-    'vitest/prefer-hooks-on-top'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce lowercase titles
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-lowercase-title.md
-     */
-    'vitest/prefer-lowercase-title'?: Linter.RuleEntry<VitestPreferLowercaseTitle>;
-    /**
-     * enforce mock resolved/rejected shorthands for promises
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
-     */
-    'vitest/prefer-mock-promise-shorthand'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce including a hint with external snapshots
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-snapshot-hint.md
-     */
-    'vitest/prefer-snapshot-hint'?: Linter.RuleEntry<VitestPreferSnapshotHint>;
-    /**
-     * enforce using `vi.spyOn`
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
-     */
-    'vitest/prefer-spy-on'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce strict equal over equal
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-equal.md
-     */
-    'vitest/prefer-strict-equal'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using toBe()
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be.md
-     */
-    'vitest/prefer-to-be'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using toBeFalsy()
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-falsy.md
-     */
-    'vitest/prefer-to-be-falsy'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using toBeObject()
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-object.md
-     */
-    'vitest/prefer-to-be-object'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using `toBeTruthy`
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-truthy.md
-     */
-    'vitest/prefer-to-be-truthy'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using toContain()
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-contain.md
-     */
-    'vitest/prefer-to-contain'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using toHaveLength()
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-have-length.md
-     */
-    'vitest/prefer-to-have-length'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce using `test.todo`
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-todo.md
-     */
-    'vitest/prefer-todo'?: Linter.RuleEntry<[]>;
-    /**
-     * require setup and teardown to be within a hook
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md
-     */
-    'vitest/require-hook'?: Linter.RuleEntry<VitestRequireHook>;
-    /**
-     * require local Test Context for concurrent snapshot tests
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-local-test-context-for-concurrent-snapshots.md
-     */
-    'vitest/require-local-test-context-for-concurrent-snapshots'?: Linter.RuleEntry<[]>;
-    /**
-     * require toThrow() to be called with an error message
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-to-throw-message.md
-     */
-    'vitest/require-to-throw-message'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce that all tests are in a top-level describe
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-top-level-describe.md
-     */
-    'vitest/require-top-level-describe'?: Linter.RuleEntry<VitestRequireTopLevelDescribe>;
-    /**
-     * enforce valid describe callback
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-describe-callback.md
-     */
-    'vitest/valid-describe-callback'?: Linter.RuleEntry<[]>;
-    /**
-     * enforce valid `expect()` usage
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md
-     */
-    'vitest/valid-expect'?: Linter.RuleEntry<VitestValidExpect>;
-    /**
-     * enforce valid titles
-     * @see https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-title.md
-     */
-    'vitest/valid-title'?: Linter.RuleEntry<VitestValidTitle>;
-}
-type VitestConsistentTestFilename = [] | [
-    {
-        pattern?: string;
-        allTestPattern?: string;
-    }
-];
-type VitestConsistentTestIt = [] | [
-    {
-        fn?: ("test" | "it");
-        withinDescribe?: ("test" | "it");
-    }
-];
-type VitestExpectExpect = [] | [
-    {
-        assertFunctionNames?: [] | [string];
-        additionalTestBlockFunctions?: string[];
-    }
-];
-type VitestMaxExpects = [] | [
-    {
-        max?: number;
-    }
-];
-type VitestMaxNestedDescribe = [] | [
-    {
-        max?: number;
-    }
-];
-type VitestNoFocusedTests = [] | [
-    {
-        fixable?: boolean;
-    }
-];
-type VitestNoHooks = [] | [
-    {
-        allow?: unknown[];
-    }
-];
-type VitestNoLargeSnapshots = [] | [
-    {
-        maxSize?: number;
-        inlineMaxSize?: number;
-        allowedSnapshots?: {
-            [k: string]: unknown[] | undefined;
-        };
-    }
-];
-type VitestNoRestrictedMatchers = [] | [
-    {
-        [k: string]: (string | null) | undefined;
-    }
-];
-type VitestNoRestrictedViMethods = [] | [
-    {
-        [k: string]: (string | null) | undefined;
-    }
-];
-type VitestNoStandaloneExpect = [] | [
-    {
-        additionaltestblockfunctions?: string[];
-        [k: string]: unknown | undefined;
-    }
-];
-type VitestPreferExpectAssertions = [] | [
-    {
-        onlyFunctionsWithAsyncKeyword?: boolean;
-        onlyFunctionsWithExpectInLoop?: boolean;
-        onlyFunctionsWithExpectInCallback?: boolean;
-    }
-];
-type VitestPreferLowercaseTitle = [] | [
-    {
-        ignore?: ("describe" | "test" | "it")[];
-        allowedPrefixes?: string[];
-        ignoreTopLevelDescribe?: boolean;
-        lowercaseFirstCharacterOnly?: boolean;
-    }
-];
-type VitestPreferSnapshotHint = [] | [("always" | "multi")];
-type VitestRequireHook = [] | [
-    {
-        allowedFunctionCalls?: string[];
-    }
-];
-type VitestRequireTopLevelDescribe = [] | [
-    {
-        maxNumberOfTopLevelDescribes?: number;
-    }
-];
-type VitestValidExpect = [] | [
-    {
-        alwaysAwait?: boolean;
-        asyncMatchers?: string[];
-        minArgs?: number;
-        maxArgs?: number;
-    }
-];
-type VitestValidTitle = [] | [
-    {
-        ignoreTypeOfDescribeName?: boolean;
-        allowArguments?: boolean;
-        disallowedWords?: string[];
-        [k: string]: (string | [string] | [string, string] | {
-            [k: string]: (string | [string] | [string, string]) | undefined;
-        });
-    }
-];
-export {};