@prowise/eslint-config-linting-rules 2.4.6 → 3.0.0

package/rules/test-rules.js

@@ -1,331 +0,0 @@
-/*
- * ✅ recommended
- * 🔧 fixable
- * 💡 has suggestion
- */
-
-/**
- *  Rules for both test frameworks
- */
-const rules = {
-    /**
-     * Enforce the usage of "it" and "test" 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/HEAD/docs/rules/consistent-test-it.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md
-     */
-    "consistent-test-it": ["warn", { fn: "test", withinDescribe: "it" }],
-
-    /**
-     * Enforce to use an expectation in the test body. ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/expect-expect.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md
-     */
-    "expect-expect": "error",
-
-    /**
-     * Enforces a maximum number assertion calls in a test body
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-expects.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md
-     * Rule turned off: gives too many false positives
-     */
-    // "max-expects": ["off", { max: 10 }],
-
-    /**
-     * Enforces a maximum depth to nested describe calls
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-nested-describe.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md
-     */
-    "max-nested-describe": ["warn", { max: 5 }],
-
-    /**
-     * Disallow alias methods ✅ 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-alias-methods.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-alias-methods.md
-     */
-    "no-alias-methods": "warn",
-
-    /**
-     * Disallow commented out tests ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-commented-out-tests.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-commented-out-tests.md
-     */
-    "no-commented-out-tests": "error",
-
-    /**
-     * Disallow expects in a conditional block ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-expect.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
-     */
-    "no-conditional-expect": "error",
-
-    /**
-     * Disallow conditionals in a test block
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-in-test.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md
-     */
-    // "no-conditional-in-test": "off",
-
-    /**
-     * Disallow disabled tests ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-disabled-tests.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
-     */
-    "no-disabled-tests": "warn",
-
-    /**
-     * Disallow duplicate setup and teardown hooks
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-duplicate-hooks.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md
-     */
-    "no-duplicate-hooks": "error",
-
-    /**
-     * Disallow focused tests
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-focused-tests.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
-     */
-    "no-focused-tests": "error",
-
-    /**
-     * Disallow setup and teardown hooks
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-hooks.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-hooks.md
-     */
-    // "no-hooks": "off",
-
-    /**
-     * Disallow identical titles ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-identical-title.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md
-     */
-    "no-identical-title": "error",
-
-    /**
-     * Disallow string interpolation inside snapshots ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-interpolation-in-snapshots.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md
-     */
-    "no-interpolation-in-snapshots": "warn",
-
-    /**
-     * Disallow large snapshots
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-large-snapshots.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-large-snapshots.md
-     */
-    "no-large-snapshots": ["error", { maxSize: 30, inlineMaxSize: 10 }],
-
-    /**
-     * Disallow manually importing from __mocks__ ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-mocks-import.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-mocks-import.md
-     */
-    "no-mocks-import": "error",
-
-    /**
-     * Disallow specific matchers & modifiers
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-restricted-matchers.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-matchers.md
-     */
-    // "no-restricted-matchers": "off",
-
-    /**
-     * Disallow using expect outside of it or test blocks ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-standalone-expect.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md
-     */
-    "no-standalone-expect": "error",
-
-    /**
-     * Disallow using any prefixed to skip tests ✅ 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-prefixes.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-prefixes.md
-     */
-    "no-test-prefixes": "error",
-
-    /**
-     * Disallow explicitly returning from tests
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-return-statement.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md
-     */
-    "no-test-return-statement": "error",
-
-    /**
-     * Suggest using toBeCalledWith() or toHaveBeenCalledWith()
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-called-with.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md
-     */
-    "prefer-called-with": "warn",
-
-    /**
-     * Suggest using the built-in comparison matchers
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-comparison-matcher.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md
-     */
-    "prefer-comparison-matcher": "warn",
-
-    /**
-     * Prefer using .each rather than manual loops
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-each.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md
-     */
-    // "prefer-each": "off",
-
-    /**
-     * Suggest using the built-in equality matchers
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-equality-matcher.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-equality-matcher.md
-     */
-    "prefer-equality-matcher": "warn",
-
-    /**
-     * Suggest using expect assertions instead of callbacks
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-expect-assertions.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-assertions.md
-     */
-    // "prefer-expect-assertions": "off",
-
-    /**
-     * Suggest using expect().resolves over expect(await ...) syntax 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-expect-resolves.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md
-     */
-    "prefer-expect-resolves": "warn",
-
-    /**
-     * Prefer having hooks in consistent order
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-hooks-in-order.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
-     */
-    "prefer-hooks-in-order": "warn",
-
-    /**
-     * Suggest having hooks before any test cases
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-hooks-on-top.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md
-     */
-    "prefer-hooks-on-top": "warn",
-
-    /**
-     * Enforce lowercase test names
-     */
-    "prefer-lowercase-title": ["warn", { ignore: ["describe", "test"] }],
-
-    /**
-     * Prefer mock resolved/rejected shorthands for promises 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
-     */
-    "prefer-mock-promise-shorthand": "warn",
-
-    /**
-     * Prefer including a hint with external snapshots
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-snapshot-hint.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-snapshot-hint.md
-     */
-    // "prefer-snapshot-hint": "off",
-
-    /**
-     * Suggest using .spyOn()
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-spy-on.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
-     */
-    "prefer-spy-on": "warn",
-
-    /**
-     * Prefer strict equal over equal
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-strict-equal.md
-     * Vitest https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-equal.md
-     */
-    // "prefer-strict-equal": "off",
-
-    /**
-     * Suggest using toBe() for primitive literals 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-be.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be.md
-     */
-    "prefer-to-be": "warn",
-
-    /**
-     * Suggest using toContain() 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-contain.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-contain.md
-     */
-    "prefer-to-contain": "warn",
-
-    /**
-     * Suggest using toHaveLength() 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-have-length.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-have-length.md
-     */
-    "prefer-to-have-length": "warn",
-
-    /**
-     * Suggest using test.todo 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-todo.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-todo.md
-     */
-    "prefer-todo": "warn",
-
-    /**
-     * Require setup and teardown code to be within a hook
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-hook.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md
-     */
-    // "require-hook": "off",
-
-    /**
-     * Require a message for toThrow()
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-to-throw-message.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md
-     */
-    "require-to-throw-message": "warn",
-
-    /**
-     * Require test cases and hooks to be inside a describe block
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-top-level-describe.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-top-level-describe.md
-     */
-    // "require-top-level-describe": "off",
-
-    /**
-     * Enforce unbound methods are called with their expected scope
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/unbound-method.md
-     */
-    // "unbound-method": "off",
-
-    /**
-     * Enforce valid describe() ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-describe-callback.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-describe-callback.md
-     */
-    "valid-describe-callback": "error",
-
-    /**
-     * Enforce valid expect() usage ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md
-     */
-    "valid-expect": ["error", { alwaysAwait: true, asyncMatchers: ["toBeResolved", "toBeRejected"] }],
-
-    /**
-     * Enforce valid titles ✅ 🔧
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-title.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-title.md
-     */
-    "valid-title": "error",
-};
-
-/**
- * Make the global test rules readable for the jest/vitest plugin.
- *
- * @param framework Used test framework
- * @returns Testing rules.
- */
-export function commonRules(framework) {
-    const updated = {};
-    for (const key in rules) {
-        updated[`${framework}/${key}`] = rules[key];
-    }
-    return updated;
-}