@rotki/eslint-config 2.1.0 → 2.3.0

package/dist/index.cjs

@@ -580,7 +580,7 @@ function imports(options = {}) {
       }
     },
     {
-      files: [`**/*.config.${GLOB_SRC_EXT}`, `**/*.config.*.${GLOB_SRC_EXT}`],
+      files: [`**/*.config.${GLOB_SRC_EXT}`, `**/*.config.*.${GLOB_SRC_EXT}`, `**/.vitepress/config.${GLOB_SRC}`],
       rules: {
         "import/no-default-export": "off",
         "no-console": "off"
@@ -1021,8 +1021,8 @@ function node() {
         "node/no-exports-assign": "error",
         "node/no-new-require": "error",
         "node/no-path-concat": "error",
-        "node/prefer-global/buffer": ["warn", "never"],
-        "node/prefer-global/process": ["warn", "never"],
+        "node/prefer-global/buffer": ["error", "never"],
+        "node/prefer-global/process": ["error", "never"],
         "node/process-exit-as-throw": "error"
       }
     }
@@ -1589,6 +1589,12 @@ function unicorn() {
         "unicorn/prefer-type-error": "error",
         "unicorn/throw-new-error": "error"
       }
+    },
+    {
+      files: [".github/**/*.md"],
+      rules: {
+        "unicorn/filename-case": "off"
+      }
     }
   ];
 }
@@ -2025,6 +2031,49 @@ async function yaml(options = {}) {
   ];
 }
 
+// src/configs/storybook.ts
+async function storybook(options = {}) {
+  const {
+    overrides = {}
+  } = options;
+  await ensurePackages(["eslint-plugin-storybook"]);
+  const [pluginStorybook] = await Promise.all([
+    interopDefault(import("eslint-plugin-storybook"))
+  ]);
+  return [
+    {
+      plugins: {
+        storybook: pluginStorybook
+      }
+    },
+    {
+      files: [
+        `*.stories.${GLOB_SRC_EXT}`,
+        `*.story.${GLOB_SRC_EXT}`
+      ],
+      rules: {
+        "import/no-anonymous-default-export": "off",
+        "storybook/await-interactions": "error",
+        "storybook/context-in-play-function": "error",
+        "storybook/default-exports": "error",
+        "storybook/hierarchy-separator": "warn",
+        "storybook/no-redundant-story-name": "warn",
+        "storybook/prefer-pascal-case": "warn",
+        "storybook/story-exports": "error",
+        "storybook/use-storybook-expect": "error",
+        "storybook/use-storybook-testing-library": "error",
+        ...overrides
+      }
+    },
+    {
+      files: [`.storybook/main.${GLOB_SRC_EXT}`],
+      rules: {
+        "storybook/no-uninstalled-addons": "error"
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -2049,6 +2098,7 @@ async function rotki(options = {}, ...userConfigs) {
     gitignore: enableGitignore = true,
     isInEditor = !!((import_node_process4.default.env.VSCODE_PID || import_node_process4.default.env.JETBRAINS_IDE || import_node_process4.default.env.VIM) && !import_node_process4.default.env.CI),
     rotki: enableRotki,
+    storybook: enableStorybook,
     typescript: enableTypeScript = (0, import_local_pkg2.isPackageExists)("typescript"),
     vue: enableVue = VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i)),
     vueI18n: enableVueI18n,
@@ -2136,6 +2186,11 @@ async function rotki(options = {}, ...userConfigs) {
       typescript: !!enableTypeScript
     }));
   }
+  if (enableStorybook) {
+    configs.push(storybook({
+      overrides: getOverrides(options, "storybook")
+    }));
+  }
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({

package/dist/index.d.cts

@@ -16,6 +16,55 @@ export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 
+interface AwaitInteractionsRule {
+    'await-interactions': RuleConfig<[]>;
+}
+interface ContextInPlayFunctionRule {
+    'context-in-play-function': RuleConfig<[]>;
+}
+interface CsfComponentsRule {
+    'csf-component': RuleConfig<[]>;
+}
+interface DefaultExportsRule {
+    'default-exports': RuleConfig<[]>;
+}
+interface HierarchySeparatorRule {
+    'hierarchy-separator': RuleConfig<[]>;
+}
+interface MetaInlinePropertiesRule {
+    'meta-inline-properties': RuleConfig<[{
+        csfVersion?: number;
+    }]>;
+}
+interface NoRedundantStoryNameRule {
+    'no-redundant-story-name': RuleConfig<[]>;
+}
+interface NoStoriesOfRule {
+    'no-stories-of': RuleConfig<[]>;
+}
+interface NoTitlePropertyInMetaRule {
+    'no-title-property-in-met': RuleConfig<[]>;
+}
+interface NoUninstalledAddonRule {
+    'no-uninstalled-addons': RuleConfig<[{
+        packageJsonLocation?: string;
+        ignore?: string[];
+    }]>;
+}
+interface PreferPascalCaseRule {
+    'prefer-pascal-case': RuleConfig<[]>;
+}
+interface StoryExportsRule {
+    'prefer-pascal-case': RuleConfig<[]>;
+}
+interface UseStorybookExpectRule {
+    'use-storybook-expect': RuleConfig<[]>;
+}
+interface UseStorybookTestingLibraryRule {
+    'use-storybook-testing-library': RuleConfig<[]>;
+}
+type StorybookRules = AwaitInteractionsRule & ContextInPlayFunctionRule & CsfComponentsRule & DefaultExportsRule & HierarchySeparatorRule & MetaInlinePropertiesRule & NoRedundantStoryNameRule & NoStoriesOfRule & NoTitlePropertyInMetaRule & NoUninstalledAddonRule & PreferPascalCaseRule & StoryExportsRule & UseStorybookExpectRule & UseStorybookTestingLibraryRule;
+
 type ValidVLostConfiguration = [
     {
         allowModifiers?: boolean;
@@ -184,7 +233,7 @@ type WrapRuleConfig<T extends {
     [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
 };
 type Awaitable<T> = T | Promise<T>;
-type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-eslint/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, '@stylestic'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$1 & EslintCommentsRules & {
+type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-eslint/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, '@stylistic/'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$1 & EslintCommentsRules & {
     'test/no-only-tests': RuleConfig<[]>;
 } & {
     'cypress/no-assigning-return-values': RuleConfig<[]>;
@@ -195,7 +244,7 @@ type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-e
     'cypress/no-pause': RuleConfig<[]>;
 } & {
     '@rotki/no-deprecated-classes': RuleConfig<[]>;
-} & VuetifyRules & Prefix<VueI18nRules, '@intlify/vue-i18n/'>>>;
+} & VuetifyRules & Prefix<VueI18nRules, '@intlify/vue-i18n/'> & Prefix<StorybookRules, 'storybook/'>>>;
 type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     plugins?: Record<string, any>;
 };
@@ -432,6 +481,14 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default false
      */
     vueI18n?: boolean | OptionsVueI18n;
+    /**
+     * Enable storybook linting support
+     *
+     * Requires installing
+     * - `eslint-plugin-storybook
+     *
+     */
+    storybook?: boolean | OptionsOverrides;
     /**
        * Control to disable some rules in editors.
        * @default auto-detect based on the process.env

package/dist/index.d.ts

@@ -16,6 +16,55 @@ export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 
+interface AwaitInteractionsRule {
+    'await-interactions': RuleConfig<[]>;
+}
+interface ContextInPlayFunctionRule {
+    'context-in-play-function': RuleConfig<[]>;
+}
+interface CsfComponentsRule {
+    'csf-component': RuleConfig<[]>;
+}
+interface DefaultExportsRule {
+    'default-exports': RuleConfig<[]>;
+}
+interface HierarchySeparatorRule {
+    'hierarchy-separator': RuleConfig<[]>;
+}
+interface MetaInlinePropertiesRule {
+    'meta-inline-properties': RuleConfig<[{
+        csfVersion?: number;
+    }]>;
+}
+interface NoRedundantStoryNameRule {
+    'no-redundant-story-name': RuleConfig<[]>;
+}
+interface NoStoriesOfRule {
+    'no-stories-of': RuleConfig<[]>;
+}
+interface NoTitlePropertyInMetaRule {
+    'no-title-property-in-met': RuleConfig<[]>;
+}
+interface NoUninstalledAddonRule {
+    'no-uninstalled-addons': RuleConfig<[{
+        packageJsonLocation?: string;
+        ignore?: string[];
+    }]>;
+}
+interface PreferPascalCaseRule {
+    'prefer-pascal-case': RuleConfig<[]>;
+}
+interface StoryExportsRule {
+    'prefer-pascal-case': RuleConfig<[]>;
+}
+interface UseStorybookExpectRule {
+    'use-storybook-expect': RuleConfig<[]>;
+}
+interface UseStorybookTestingLibraryRule {
+    'use-storybook-testing-library': RuleConfig<[]>;
+}
+type StorybookRules = AwaitInteractionsRule & ContextInPlayFunctionRule & CsfComponentsRule & DefaultExportsRule & HierarchySeparatorRule & MetaInlinePropertiesRule & NoRedundantStoryNameRule & NoStoriesOfRule & NoTitlePropertyInMetaRule & NoUninstalledAddonRule & PreferPascalCaseRule & StoryExportsRule & UseStorybookExpectRule & UseStorybookTestingLibraryRule;
+
 type ValidVLostConfiguration = [
     {
         allowModifiers?: boolean;
@@ -184,7 +233,7 @@ type WrapRuleConfig<T extends {
     [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
 };
 type Awaitable<T> = T | Promise<T>;
-type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-eslint/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, '@stylestic'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$1 & EslintCommentsRules & {
+type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-eslint/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, '@stylistic/'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$1 & EslintCommentsRules & {
     'test/no-only-tests': RuleConfig<[]>;
 } & {
     'cypress/no-assigning-return-values': RuleConfig<[]>;
@@ -195,7 +244,7 @@ type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-e
     'cypress/no-pause': RuleConfig<[]>;
 } & {
     '@rotki/no-deprecated-classes': RuleConfig<[]>;
-} & VuetifyRules & Prefix<VueI18nRules, '@intlify/vue-i18n/'>>>;
+} & VuetifyRules & Prefix<VueI18nRules, '@intlify/vue-i18n/'> & Prefix<StorybookRules, 'storybook/'>>>;
 type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     plugins?: Record<string, any>;
 };
@@ -432,6 +481,14 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default false
      */
     vueI18n?: boolean | OptionsVueI18n;
+    /**
+     * Enable storybook linting support
+     *
+     * Requires installing
+     * - `eslint-plugin-storybook
+     *
+     */
+    storybook?: boolean | OptionsOverrides;
     /**
        * Control to disable some rules in editors.
        * @default auto-detect based on the process.env

package/dist/index.js

@@ -487,7 +487,7 @@ function imports(options = {}) {
       }
     },
     {
-      files: [`**/*.config.${GLOB_SRC_EXT}`, `**/*.config.*.${GLOB_SRC_EXT}`],
+      files: [`**/*.config.${GLOB_SRC_EXT}`, `**/*.config.*.${GLOB_SRC_EXT}`, `**/.vitepress/config.${GLOB_SRC}`],
       rules: {
         "import/no-default-export": "off",
         "no-console": "off"
@@ -928,8 +928,8 @@ function node() {
         "node/no-exports-assign": "error",
         "node/no-new-require": "error",
         "node/no-path-concat": "error",
-        "node/prefer-global/buffer": ["warn", "never"],
-        "node/prefer-global/process": ["warn", "never"],
+        "node/prefer-global/buffer": ["error", "never"],
+        "node/prefer-global/process": ["error", "never"],
         "node/process-exit-as-throw": "error"
       }
     }
@@ -1496,6 +1496,12 @@ function unicorn() {
         "unicorn/prefer-type-error": "error",
         "unicorn/throw-new-error": "error"
       }
+    },
+    {
+      files: [".github/**/*.md"],
+      rules: {
+        "unicorn/filename-case": "off"
+      }
     }
   ];
 }
@@ -1932,6 +1938,49 @@ async function yaml(options = {}) {
   ];
 }
 
+// src/configs/storybook.ts
+async function storybook(options = {}) {
+  const {
+    overrides = {}
+  } = options;
+  await ensurePackages(["eslint-plugin-storybook"]);
+  const [pluginStorybook] = await Promise.all([
+    interopDefault(import("eslint-plugin-storybook"))
+  ]);
+  return [
+    {
+      plugins: {
+        storybook: pluginStorybook
+      }
+    },
+    {
+      files: [
+        `*.stories.${GLOB_SRC_EXT}`,
+        `*.story.${GLOB_SRC_EXT}`
+      ],
+      rules: {
+        "import/no-anonymous-default-export": "off",
+        "storybook/await-interactions": "error",
+        "storybook/context-in-play-function": "error",
+        "storybook/default-exports": "error",
+        "storybook/hierarchy-separator": "warn",
+        "storybook/no-redundant-story-name": "warn",
+        "storybook/prefer-pascal-case": "warn",
+        "storybook/story-exports": "error",
+        "storybook/use-storybook-expect": "error",
+        "storybook/use-storybook-testing-library": "error",
+        ...overrides
+      }
+    },
+    {
+      files: [`.storybook/main.${GLOB_SRC_EXT}`],
+      rules: {
+        "storybook/no-uninstalled-addons": "error"
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -1956,6 +2005,7 @@ async function rotki(options = {}, ...userConfigs) {
     gitignore: enableGitignore = true,
     isInEditor = !!((process4.env.VSCODE_PID || process4.env.JETBRAINS_IDE || process4.env.VIM) && !process4.env.CI),
     rotki: enableRotki,
+    storybook: enableStorybook,
     typescript: enableTypeScript = isPackageExists2("typescript"),
     vue: enableVue = VuePackages.some((i) => isPackageExists2(i)),
     vueI18n: enableVueI18n,
@@ -2043,6 +2093,11 @@ async function rotki(options = {}, ...userConfigs) {
       typescript: !!enableTypeScript
     }));
   }
+  if (enableStorybook) {
+    configs.push(storybook({
+      overrides: getOverrides(options, "storybook")
+    }));
+  }
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rotki/eslint-config",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "packageManager": "pnpm@8.14.1",
   "type": "module",
   "license": "AGPL-3.0",
@@ -28,6 +28,7 @@
     "@rotki/eslint-plugin": ">=0.0.3",
     "eslint": ">=8.56.0",
     "eslint-plugin-cypress": ">=2.15.0",
+    "eslint-plugin-storybook": "^0.6.15",
     "eslint-plugin-vuetify": "^1 || ^2"
   },
   "peerDependenciesMeta": {
@@ -40,6 +41,9 @@
     "eslint-plugin-cypress": {
       "optional": true
     },
+    "eslint-plugin-storybook": {
+      "optional": true
+    },
     "eslint-plugin-vuetify": {
       "optional": true
     }
@@ -49,18 +53,18 @@
     "@antfu/install-pkg": "0.3.1",
     "@eslint-types/typescript-eslint": "6.18.1",
     "@eslint-types/unicorn": "50.0.1",
-    "@stylistic/eslint-plugin": "1.5.3",
-    "@typescript-eslint/eslint-plugin": "6.18.1",
-    "@typescript-eslint/parser": "6.18.1",
+    "@stylistic/eslint-plugin": "1.5.4",
+    "@typescript-eslint/eslint-plugin": "6.19.0",
+    "@typescript-eslint/parser": "6.19.0",
     "eslint-config-flat-gitignore": "0.1.2",
     "eslint-config-prettier": "9.1.0",
     "eslint-merge-processors": "0.1.0",
-    "eslint-plugin-antfu": "2.1.1",
+    "eslint-plugin-antfu": "2.1.2",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-format": "0.1.0",
     "eslint-plugin-html": "7.1.0",
     "eslint-plugin-i": "2.29.1",
-    "eslint-plugin-jsonc": "2.11.2",
+    "eslint-plugin-jsonc": "2.12.2",
     "eslint-plugin-markdown": "3.0.1",
     "eslint-plugin-n": "16.6.2",
     "eslint-plugin-no-only-tests": "3.1.0",
@@ -70,24 +74,24 @@
     "eslint-plugin-unused-imports": "3.0.0",
     "eslint-plugin-vitest": "0.3.20",
     "eslint-plugin-vue": "9.20.1",
-    "eslint-plugin-yml": "1.11.0",
+    "eslint-plugin-yml": "1.12.2",
     "eslint-processor-vue-blocks": "0.1.1",
     "globals": "13.24.0",
     "jsonc-eslint-parser": "2.4.0",
     "local-pkg": "0.5.0",
-    "prettier": "3.2.2",
+    "prettier": "3.2.4",
     "prompts": "2.4.2",
-    "vue-eslint-parser": "9.4.0",
+    "vue-eslint-parser": "9.4.1",
     "yaml-eslint-parser": "1.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.4.4",
-    "@commitlint/config-conventional": "18.4.4",
+    "@commitlint/cli": "18.5.0",
+    "@commitlint/config-conventional": "18.5.0",
     "@rotki/eslint-config": "*",
     "@types/eslint": "8.56.2",
-    "@types/node": "20.11.2",
+    "@types/node": "20.11.5",
     "@types/prompts": "2.4.9",
-    "bumpp": "9.2.1",
+    "bumpp": "9.3.0",
     "eslint": "8.56.0",
     "eslint-flat-config-viewer": "0.1.11",
     "husky": "8.0.3",