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

package/rules/plugin-vitest-rules.js

@@ -1,5 +1,4 @@
 import vitestPlugin from "@vitest/eslint-plugin";
-import { commonRules } from "./test-rules.js";
 
 export default {
     plugins: { vitest: vitestPlugin },
@@ -25,8 +24,6 @@ export default {
     },
 
     rules: {
-        ...commonRules("vitest"),
-
         /**
          * Forbidden test file pattern: default only "test" accepted
          * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
@@ -34,40 +31,231 @@ export default {
         "vitest/consistent-test-filename": ["warn", { pattern: ".*\\.test\\.[tj]sx?$" }],
 
         /**
-         * Do not use conditionals to run tests
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-tests.md
+         * Enforce the usage of "it" and "test" 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md
          */
-        // "vitest/no-conditional-tests": "off",
+        "vitest/consistent-test-it": ["warn", { fn: "test", withinDescribe: "it" }],
 
         /**
-         * Disallow importing node:test ✅ 🔧
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
+         * Enforce to use an expectation in the test body. ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md
          */
-        "vitest/no-import-node-test": "error",
+        "vitest/expect-expect": "error",
+
+        /**
+         * Enforces a maximum depth to nested describe calls
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md
+         */
+        "vitest/max-nested-describe": ["warn", { max: 5 }],
+
+        /**
+         * Disallow alias methods ✅ 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-alias-methods.md
+         */
+        "vitest/no-alias-methods": "error",
+
+        /**
+         * Disallow commented out tests ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-commented-out-tests.md
+         */
+        "vitest/no-commented-out-tests": "error",
+
+        /**
+         * Disallow expects in a conditional block ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
+         */
+        "vitest/no-conditional-expect": "error",
+
+        /**
+         * Disallow disabled tests ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
+         */
+        "vitest/no-disabled-tests": "warn",
+
+        /**
+         * Disallow duplicate setup and teardown hooks
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md
+         */
+        "vitest/no-duplicate-hooks": "error",
+
+        /**
+         * Disallow focused tests
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
+         */
+        "vitest/no-focused-tests": "error",
+
+        /**
+         * Disallow identical titles ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md
+         */
+        "vitest/no-identical-title": "error",
+
+        /**
+         * Disallow string interpolation inside snapshots ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md
+         */
+        "vitest/no-interpolation-in-snapshots": "warn",
+
+        /**
+         * Disallow large snapshots
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-large-snapshots.md
+         */
+        "vitest/no-large-snapshots": ["error", { maxSize: 30, inlineMaxSize: 10 }],
+
+        /**
+         * Disallow manually importing from __mocks__ ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-mocks-import.md
+         */
+        "vitest/no-mocks-import": "error",
+
+        /**
+         * Disallow using expect outside of it or test blocks ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md
+         */
+        "vitest/no-standalone-expect": "error",
+
+        /**
+         * Disallow using any prefixed to skip tests ✅ 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-prefixes.md
+         */
+        "vitest/no-test-prefixes": "error",
+
+        /**
+         * Disallow explicitly returning from tests
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md
+         */
+        "vitest/no-test-return-statement": "error",
+
+        /**
+         * Enforce using `toBeCalledTimes(1)` or `toHaveBeenCalledTimes(1)`
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-times.md
+         */
+        "vitest/prefer-called-times": "warn",
+
+        /**
+         * Suggest using toBeCalledWith() or toHaveBeenCalledWith()
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md
+         */
+        "vitest/prefer-called-with": "warn",
 
         /**
-         * Disallow specific vi. methods
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md
+         * Suggest using the built-in comparison matchers
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md
          */
-        // "vitest/no-restricted-vi-methods": "off",
+        "vitest/prefer-comparison-matcher": "warn",
 
         /**
-         * Suggest using toBeFalsy() 🔧
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-falsy.md
+         * Suggest using the built-in equality matchers
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-equality-matcher.md
          */
-        // "vitest/prefer-to-be-falsy)": "off",
+        "vitest/prefer-equality-matcher": "warn",
 
         /**
-         * Prefer toBeObject() 🔧
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-object.md
+         * Suggest using expect().resolves over expect(await ...) syntax 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md
          */
-        // "vitest/prefer-to-be-object": "off",
+        "vitest/prefer-expect-resolves": "warn",
 
         /**
-         * Suggest using toBeTruthy 🔧
-         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-truthy.md
+         * Enforce using `each` rather than manual loops
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md
          */
-        // "vitest/prefer-to-be-truthy": "off",
+        "vitest/prefer-each": "error",
+
+        /**
+         * Prefer having hooks in consistent order
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
+         */
+        "vitest/prefer-hooks-in-order": "warn",
+
+        /**
+         * Suggest having hooks before any test cases
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md
+         */
+        "vitest/prefer-hooks-on-top": "warn",
+
+        /**
+         * Enforce lowercase test names
+         */
+        "vitest/prefer-lowercase-title": ["warn", { ignore: ["describe", "test"] }],
+
+        /**
+         * Prefer mock resolved/rejected shorthands for promises 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
+         */
+        "vitest/prefer-mock-promise-shorthand": "warn",
+
+        /**
+         * Suggest using .spyOn()
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
+         */
+        "vitest/prefer-spy-on": "warn",
+
+        /**
+         * Enforce using `toBe(true)` and `toBe(false)` over matchers that coerce types to boolean
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-boolean-matchers.md
+         */
+        "vitest/prefer-strict-boolean-matchers": "warn",
+
+        /**
+         * Suggest using toBe() for primitive literals 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be.md
+         */
+        "vitest/prefer-to-be": "warn",
+
+        /**
+         * Suggest using toContain() 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-contain.md
+         */
+        "vitest/prefer-to-contain": "warn",
+
+        /**
+         * Suggest using toHaveLength() 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-have-length.md
+         */
+        "vitest/prefer-to-have-length": "warn",
+
+        /**
+         * Suggest using test.todo 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-todo.md
+         */
+        "vitest/prefer-todo": "warn",
+
+        /**
+         * Require a message for toThrow()
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md
+         */
+        "vitest/require-to-throw-message": "warn",
+
+        /**
+         * Enforce valid describe() ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-describe-callback.md
+         */
+        "vitest/valid-describe-callback": "error",
+
+        /**
+         * Require promises that have expectations in their chain to be valid ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-expect-in-promise.md
+         */
+        "vitest/valid-expect-in-promise": "error",
+
+        /**
+         * Enforce valid expect() usage ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md
+         */
+        "vitest/valid-expect": ["error", { alwaysAwait: true, asyncMatchers: ["toBeResolved", "toBeRejected"] }],
+
+        /**
+         * Enforce valid titles ✅ 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-title.md
+         */
+        "vitest/valid-title": "error",
+
+        /**
+         * Disallow importing node:test ✅ 🔧
+         * https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
+         */
+        "vitest/no-import-node-test": "error",
 
         /**
          * Require local Test Context for concurrent snapshot tests ✅

package/eslint.back.js

@@ -1,9 +0,0 @@
-import base from "./base.js";
-import node from "./rules/plugin-node-rules.js";
-
-export default [base, node, {
-    rules: {
-        "import/no-named-as-default-member": "off",
-        "import/no-named-as-default": "off",
-    },
-}];

package/rules/plugin-solid-rules.js

@@ -1,136 +0,0 @@
-import solidPlugin from "eslint-plugin-solid";
-
-export default {
-    /*
-     * ✅ recommended
-     * 🔧 fixable
-     * 💡 has suggestion
-     */
-
-    plugins: {
-        solid: solidPlugin,
-    },
-
-    rules: {
-        /**
-         * Disallow early returns in components. ✅ 🔧
-         * Solid components only run once, and so conditionals should be inside JSX.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/components-return-once.md
-         */
-        "solid/components-return-once": "warn",
-
-        /**
-         * Enforce naming DOM element event handlers consistently and prevent ✅ 🔧
-         * Solid's analysis from misunderstanding whether a prop should be an event handler.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/event-handlers.md
-         */
-        "solid/event-handlers": "warn",
-
-        /**
-         * Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store". ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/imports.md
-         */
-        "solid/imports": "warn",
-
-        /**
-         * Disallow passing the same prop twice in JSX. ✅
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-duplicate-props.md
-         */
-        "solid/jsx-no-duplicate-props": "error",
-
-        /**
-         * Disallow javascript: URLs. ✅
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-script-url.md
-         */
-        "solid/jsx-no-script-url": "error",
-
-        /**
-         * Disallow references to undefined variables in JSX. Handles custom directives. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-undef.md
-         */
-        "solid/jsx-no-undef": "error",
-
-        /**
-         * Prevent variables used in JSX from being marked as unused. ✅
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-uses-vars.md
-         */
-        "solid/jsx-uses-vars": "error",
-
-        /**
-         * Disallow usage of type-unsafe event handlers.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-array-handlers.md
-         */
-        // "solid/no-array-handlers": "off",
-
-        /**
-         * Disallow destructuring props. ✅ 🔧
-         * In Solid, props must be used with property accesses (props.foo) to preserve reactivity.
-         * This rule only tracks destructuring in the parameter list.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-destructure.md
-         */
-        "solid/no-destructure": "error",
-
-        /**
-         * Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-innerhtml.md
-         */
-        "solid/no-innerhtml": "error",
-
-        /**
-         * Disallow usage of APIs that use ES6 Proxies, only to target environments that don't support them.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-proxy-apis.md
-         */
-        // "solid/no-proxy-apis": "off",
-
-        /**
-         * Disallow usage of dependency arrays in createEffect and createMemo. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-deps.md
-         */
-        "solid/no-react-deps": "warn",
-
-        /**
-         * Disallow usage of React-specific className/htmlFor props, which were deprecated in v1.4.0. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-specific-props.md
-         */
-        "solid/no-react-specific-props": "warn",
-
-        /**
-         * Enforce using only Solid-specific namespaced attribute names (i.e. 'on:' in <div on:click={...} />). ✅
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unknown-namespaces.md
-         */
-        "solid/no-unknown-namespaces": "error",
-
-        /**
-         * Enforce using Solid's <For /> component for mapping an array to JSX elements. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/prefer-for.md
-         */
-        "solid/prefer-for": "error",
-
-        /**
-         * Enforce using Solid's <Show /> component for conditionally showing content. 🔧
-         * Solid's compiler covers this case, so it's a stylistic rule only.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/prefer-show.md
-         */
-        // "solid/prefer-show": "off",
-
-        /**
-         * Enforce that reactivity (props, signals, memos, etc.) is properly used, ✅
-         * so changes in those values will be tracked and update the view as expected.
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/reactivity.md
-         */
-        "solid/reactivity": "warn",
-
-        /**
-         * Disallow extra closing tags for components without children. ✅ 🔧
-         * https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/self-closing-comp.md
-         */
-        "solid/self-closing-comp": "warn",
-
-        /**
-         * Require CSS properties in the style prop to be valid and kebab-cased (ex. 'font-size'), ✅ 🔧
-         * not camel-cased (ex. 'fontSize') like in React, and that property values with dimensions
-         * are strings, not numbers with implicit 'px' units.
-         */
-        "solid/style-prop": "warn",
-    },
-};