feat: added rules for playwright and storybook

Signed-off-by: prisis <d.bannert@anolilab.de>

Author: prisis

packages/eslint-config/package.json

@@ -126,6 +126,7 @@
         "eslint-plugin-react": "^7.32.2",
         "eslint-plugin-react-hooks": "^4.6.0",
         "eslint-plugin-react-redux": "^4.0.0",
+        "eslint-plugin-storybook": "^0.6.11",
         "eslint-plugin-tailwindcss": "^3.12.1",
         "eslint-plugin-testing-library": "^5.11.0",
         "eslint-plugin-vitest": "^0.2.6",
@@ -150,6 +151,7 @@
         "eslint-plugin-jest-async": "^1.0.3",
         "eslint-plugin-jest-dom": "^5.0.1",
         "eslint-plugin-jest-formatting": "^3.1.0",
+        "eslint-plugin-playwright": "^0.15.1",
         "eslint-plugin-jsdoc": "^46.2.6",
         "eslint-plugin-jsx-a11y": "^6.7.1",
         "eslint-plugin-n": "^16.0.0",
@@ -158,6 +160,7 @@
         "eslint-plugin-react": "^7.32.2",
         "eslint-plugin-react-hooks": "^4.6.0",
         "eslint-plugin-react-redux": "^4.0.0",
+        "eslint-plugin-storybook": "^0.6.11",
         "eslint-plugin-tailwindcss": "^3.12.1",
         "eslint-plugin-testing-library": "^5.11.0",
         "eslint-plugin-tsdoc": "^0.2.17",

packages/eslint-config/src/config.ts

@@ -143,6 +143,14 @@ const pluginConfig: PackageRules = [
         configName: "ava",
         dependencies: ["ava", "eslint-plugin-ava"],
     },
+    {
+        configName: "storybook",
+        dependencies: ["storybook", "eslint-plugin-storybook"],
+    },
+    {
+        configName: "playwright",
+        dependencies: ["playwright", "eslint-plugin-playwright"],
+    },
 ];
 
 const loadedPlugins: string[] = [...internalPluginConfig];

packages/eslint-config/src/config/es6.ts

@@ -90,10 +90,33 @@ const config: Linter.Config = {
         // disallow specific imports
         // https://eslint.org/docs/rules/no-restricted-imports
         "no-restricted-imports": [
-            "off",
+            "error",
             {
-                paths: [],
-                patterns: [],
+                paths: [
+                    {
+                        name: "lodash.isequal",
+                        message:
+                            "Lodash modularised (and lodash < 4.17.11) have CVE vulnerabilities. Please use tree-shakeable imports like lodash/xxx instead",
+                    },
+                    {
+                        name: "lodash.uniqueId",
+                        message:
+                            "Lodash modularised (and lodash < 4.17.11) have CVE vulnerabilities. Please use tree-shakeable imports like lodash/xxx instead",
+                    },
+                    {
+                        name: "lodash.mergewith",
+                        message:
+                            "Lodash modularised (and lodash < 4.17.11) have CVE vulnerabilities. Please use tree-shakeable imports like lodash/xxx instead",
+                    },
+                    {
+                        name: "lodash.pick",
+                        message:
+                            "Lodash modularised (and lodash < 4.17.11) have CVE vulnerabilities. Please use tree-shakeable imports like lodash/xxx instead",
+                    },
+                ],
+                // catch-all for any lodash modularized.
+                // The CVE is listed against the entire family for lodash < 4.17.11
+                patterns: ["lodash.*"],
             },
         ],
 

packages/eslint-config/src/config/plugins/jsx-a11y.ts

@@ -1,5 +1,12 @@
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 
+let hasStorybook = false;
+
+if (hasDevDependency("storybook") || hasDependency("storybook")) {
+    hasStorybook = true;
+}
+
 const config: Linter.Config = {
     plugins: ["jsx-a11y", "react"],
 
@@ -234,9 +241,9 @@ const config: Linter.Config = {
         "jsx-a11y/anchor-is-valid": [
             "error",
             {
-                components: ["Link"],
+                components: ["A", "LinkTo", "Link"],
                 specialLink: ["to"],
-                aspects: ["noHref", "invalidHref", "preferButton"],
+                aspects: ["noHref", "invalidHref", "preferButton", ...(hasStorybook ? ["overrideParams", "kind", "story", "to"] : [])],
             },
         ],
 

packages/eslint-config/src/config/plugins/playwright.ts

@@ -0,0 +1,31 @@
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
+import type { Linter } from "eslint";
+
+let hasJest = false;
+
+if (hasDependency("jest") || hasDevDependency("jest") || hasDevDependency("eslint-plugin-jest") || hasDevDependency("@types/jest")) {
+    hasJest = true;
+}
+
+// @see https://github.com/playwright-community/eslint-plugin-playwright
+const config: Linter.Config = {
+    env: {
+        browser: true,
+        es6: true,
+        node: true,
+    },
+    overrides: [
+        {
+            // To ensure best performance enable only on e2e test files
+            files: ["**/e2e/**/*.test.{js,ts}"],
+            extends: [hasJest ? "plugin:playwright/jest-playwright" : "plugin:playwright/recommended"],
+            rules: {
+                "@typescript-eslint/no-non-null-assertion": "off",
+                "@typescript-eslint/no-object-literal-type-assertion": "off",
+                "@typescript-eslint/no-empty-function": "off",
+            },
+        },
+    ],
+};
+
+export default config;

packages/eslint-config/src/config/plugins/storybook.ts

@@ -0,0 +1,19 @@
+import type { Linter } from "eslint";
+
+// @see https://github.com/storybookjs/eslint-plugin-storybook
+const config: Linter.Config = {
+    env: {
+        browser: true,
+        es6: true,
+        node: true,
+    },
+    overrides: [
+        {
+            // For performance run storybook/recommended on test files, not regular code
+            files: ["**/*.stories.{ts,tsx,mdx}"],
+            extends: ["plugin:storybook/recommended"],
+        },
+    ],
+};
+
+export default config;

packages/eslint-config/src/config/style.ts

@@ -463,7 +463,7 @@ const config: Linter.Config = {
         "no-underscore-dangle": [
             "error",
             {
-                allow: ["__DEV__"],
+                allow: ["__DEV__", "__STORYBOOK_CLIENT_API__", "__STORYBOOK_ADDONS_CHANNEL__", "__STORYBOOK_STORY_STORE__"],
                 allowAfterThis: false,
                 allowAfterSuper: false,
                 enforceInMethodNames: true,