@scayle/eslint-config-storefront 4.8.2 → 5.0.0

package/config/v3.mjs

@@ -0,0 +1,49 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils'
+import { storefront } from './index.mjs'
+import { vueConfig } from './v3/vue.mjs'
+import { vueI18nConfig } from './v3/vueI18n.mjs'
+import { vueComposableConfig } from './v3/vueComposable.mjs'
+import { storybookConfig } from './v3/storybook.mjs'
+import { tailwindConfig } from './v3/tailwind.mjs'
+
+/**
+ * @typedef {object} EslintConfigStorefrontV3Options
+ * @property {object} [typescript] Options forwarded to `typescriptConfig` (see `storefront`).
+ * @property {string} [typescript.tsconfigPath] Enables type-aware TypeScript rules when set.
+ * @property {object} tailwind Tailwind CSS settings.
+ * @property {string} tailwind.entryPoint Path to the project's Tailwind CSS entry point.
+ * @property {object} i18n `vue-i18n` linting settings.
+ * @property {string} i18n.localeDir Glob pointing at the project's locale JSON files.
+ * @property {string} [i18n.messageSyntaxVersion] `vue-i18n` message syntax version.
+ * @property {string[]} [i18n.unusedKeyIgnores] Regex-string patterns for dynamically-used keys.
+ * @property {object} [vue] Vue rule settings.
+ * @property {string[]} [vue.undefComponentIgnores] Custom element tag names exempt from `vue/no-undef-components`.
+ * @property {object} [vueComposable] `@scayle/vue-composable` rule settings.
+ * @property {string[]} [vueComposable.fallthroughAttrsIgnores] Path fragments exempt from `require-explicit-fallthrough-attrs`.
+ */
+
+/**
+ * Builds the SCAYLE Storefront ESLint flat config for the Storefront Application V3 stack
+ * (Hono + Inertia.js + Vue 3, not Nuxt). Extends `storefront()` with Vue language wiring,
+ * Vue rules, accessibility rules, `vue-i18n` rules, `@scayle/vue-composable` rules,
+ * Storybook file conventions, and Tailwind CSS class validation. Kept separate from
+ * `storefront()`/`storefrontNuxt()` since those two stay framework-agnostic.
+ *
+ * @param {EslintConfigStorefrontV3Options} config
+ * @returns {FlatConfigComposer<import('eslint').Linter.Config, never>} Returns a FlatConfigComposer object to be consumed in projects eslint.config.mjs files
+ */
+export const storefrontV3 = function (config) {
+  const { typescript, tailwind, i18n, vue, vueComposable } = config ?? {}
+
+  /** @type {FlatConfigComposer<import('eslint').Linter.Config, never>} */
+  const flatConfigComposer = new FlatConfigComposer()
+
+  return flatConfigComposer.append(
+    storefront({ typescript }),
+    ...tailwindConfig(tailwind),
+    ...storybookConfig(),
+    ...vueConfig(vue),
+    ...vueI18nConfig(i18n),
+    ...vueComposableConfig(vueComposable),
+  )
+}

package/config/v3.test.mjs

@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vitest'
+import { storefrontV3 } from './v3.mjs'
+
+describe('storefrontV3', () => {
+  it('throws without tailwind.entryPoint', () => {
+    expect(() =>
+      // @ts-expect-error missing required `tailwind`, exercising the runtime guard
+      storefrontV3({ i18n: { localeDir: './src/i18n/locales/*.json' } }),
+    ).toThrow('config.tailwind.entryPoint is required')
+  })
+
+  it('throws without i18n.localeDir', () => {
+    expect(() =>
+      // @ts-expect-error missing required `i18n`, exercising the runtime guard
+      storefrontV3({ tailwind: { entryPoint: './src/client/index.css' } }),
+    ).toThrow('config.i18n.localeDir is required')
+  })
+
+  it('returns a config with both required options set', async () => {
+    const config = storefrontV3({
+      tailwind: { entryPoint: './src/client/index.css' },
+      i18n: { localeDir: './src/i18n/locales/*.json' },
+    })
+
+    const resolved = await config.toConfigs()
+
+    expect(Array.isArray(resolved)).toBe(true)
+    expect(resolved.length).toBeGreaterThan(0)
+  })
+})

package/index.mjs

@@ -1,3 +1,4 @@
-import { eslintConfigStorefront } from './config/flat/index.mjs'
+import { storefront } from './config/index.mjs'
 
-export default eslintConfigStorefront
+export default storefront
+export { storefront }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/eslint-config-storefront",
-  "version": "4.8.2",
+  "version": "5.0.0",
   "description": "SCAYLE Commerce Engine specific eslint configuration",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -17,46 +17,65 @@
   "type": "module",
   "exports": {
     ".": "./index.mjs",
-    "./config/flat/index.mjs": "./config/flat/index.mjs",
-    "./config/flat/sonarjs": "./config/flat/sonarjs.mjs",
-    "./config/flat/promise.mjs": "./config/flat/promise.mjs",
-    "./config/flat/importX.mjs": "./config/flat/importX.mjs"
+    "./nuxt": "./storefront-nuxt.mjs",
+    "./v3": "./storefront-v3.mjs"
   },
   "main": "./index.mjs",
   "files": [
     "CHANGELOG.md",
     "README.md",
     "./index.mjs",
+    "./storefront-nuxt.mjs",
+    "./storefront-v3.mjs",
     "./config/"
   ],
   "engines": {
     "node": ">= 22.0.0"
   },
   "peerDependencies": {
-    "eslint": ">=9.0.0",
+    "eslint": ">=10.4.0",
     "typescript": ">=5.4.0"
   },
   "dependencies": {
-    "@antfu/eslint-config": "^9.0.0",
-    "@eslint/eslintrc": "^3.3.5",
-    "eslint-config-flat-gitignore": "^2.2.0",
+    "@e18e/eslint-plugin": "^0.8.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
+    "@eslint/js": "^10.0.0",
+    "@intlify/eslint-plugin-vue-i18n": "^4.5.1",
+    "@vitest/eslint-plugin": "^1.6.20",
+    "eslint-config-flat-gitignore": "^2.3.0",
     "eslint-flat-config-utils": "^3.2.0",
-    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-better-tailwindcss": "^4.7.0",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-jsdoc": "^64.2.1",
+    "eslint-plugin-jsonc": "^3.4.1",
+    "eslint-plugin-n": "^18.3.0",
+    "eslint-plugin-no-only-tests": "^3.4.0",
     "eslint-plugin-promise": "^7.3.0",
-    "eslint-plugin-sonarjs": "^4.0.3",
-    "local-pkg": "^1.2.1",
-    "typescript-eslint": "8.65.0"
+    "eslint-plugin-regexp": "^3.2.0",
+    "eslint-plugin-sonarjs": "^4.2.0",
+    "eslint-plugin-storybook": "^10.5.8",
+    "eslint-plugin-unicorn": "^73.0.0",
+    "eslint-plugin-vue": "^10.10.0",
+    "eslint-plugin-vuejs-accessibility": "^2.6.0",
+    "globals": "^17.7.0",
+    "typescript-eslint": "^8.67.0",
+    "vue-eslint-parser": "^10.4.1",
+    "@scayle/eslint-plugin-vue-composable": "1.2.1"
   },
   "devDependencies": {
-    "eslint": "10.8.0",
+    "@types/node": "^24",
+    "@vitest/coverage-v8": "4.1.11",
+    "eslint": "10.8.1",
     "eslint-formatter-gitlab": "7.2.0",
-    "publint": "0.3.22",
-    "typescript": "6.0.3"
+    "publint": "0.3.23",
+    "typescript": "6.0.3",
+    "vitest": "4.1.11"
   },
   "scripts": {
     "lint": "eslint .",
     "lint:ci": "eslint . --format gitlab",
     "lint:fix": "eslint . --fix",
-    "package:lint": "publint"
+    "package:lint": "publint",
+    "typecheck": "tsc"
   }
 }

package/storefront-nuxt.mjs

@@ -0,0 +1,4 @@
+import { storefrontNuxt } from './config/index.mjs'
+
+export default storefrontNuxt
+export { storefrontNuxt }

package/storefront-v3.mjs

@@ -0,0 +1,4 @@
+import { storefrontV3 } from './config/v3.mjs'
+
+export default storefrontV3
+export { storefrontV3 }

package/config/flat/importX.mjs

@@ -1,22 +0,0 @@
-import { importX as pluginImportX } from 'eslint-plugin-import-x'
-
-// Pre-defined rule configurations for better performance
-const IMPORT_X_RULES = {
-  'import-x/consistent-type-specifier-style': ['error', 'prefer-top-level'],
-  'import-x/first': 'error',
-  'import-x/no-duplicates': 'error',
-  'import-x/no-mutable-exports': 'error',
-  'import-x/no-named-default': 'error',
-  'import-x/no-self-import': 'error',
-  'import-x/no-extraneous-dependencies': 'error',
-}
-
-export function importX() {
-  return [
-    {
-      name: 'storefront/import-x/rules',
-      plugins: { 'import-x': pluginImportX },
-      rules: IMPORT_X_RULES,
-    },
-  ]
-}

package/config/flat/index.mjs

@@ -1,155 +0,0 @@
-import { FlatConfigComposer } from 'eslint-flat-config-utils'
-import { isPackageExists } from 'local-pkg'
-import {
-  GLOB_TESTS,
-  combine,
-  comments,
-  ignores,
-  javascript,
-  jsdoc,
-  jsonc,
-  node,
-  test,
-  typescript,
-} from '@antfu/eslint-config'
-import gitignore from 'eslint-config-flat-gitignore'
-import tseslint from 'typescript-eslint'
-import { sonarjs } from './sonarjs.mjs'
-import { promise } from './promise.mjs'
-import { importX } from './importX.mjs'
-
-// Partial eslint config by `@antfu/eslint-config`
-// <https://github.com/antfu/eslint-config/blob/main/README.md>
-
-/**
- * @param {object=} config
- * @param {boolean=} config.isNuxt
- * @param {object=} config.typescript
- * @param {string=} config.typescript.tsconfigPath
- * @returns {FlatConfigComposer<Linter.FlatConfig<Linter.RulesRecord>, never>} Returns a FlatConfigComposer object to be consumed in projects eslint.config.mjs files
- */
-export const eslintConfigStorefront = function (
-  config = {
-    isNuxt: isPackageExists('@nuxt/eslint'),
-    typescript: { tsconfigPath: undefined },
-  },
-) {
-  const flatConfigComposer = new FlatConfigComposer()
-  const isNuxtProject = config.isNuxt
-
-  // Pre-defined rule configurations for better performance
-  const TYPESCRIPT_JSON_RULES = {
-    '@typescript-eslint/ban-ts-comment': 'off',
-    '@typescript-eslint/no-array-constructor': 'off',
-    '@typescript-eslint/no-duplicate-enum-values': 'off',
-    '@typescript-eslint/no-empty-object-type': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/no-extra-non-null-assertion': 'off',
-    '@typescript-eslint/no-misused-new': 'off',
-    '@typescript-eslint/no-namespace': 'off',
-    '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
-    '@typescript-eslint/no-require-imports': 'off',
-    '@typescript-eslint/no-this-alias': 'off',
-    '@typescript-eslint/no-unnecessary-type-constraint': 'off',
-    '@typescript-eslint/no-unsafe-declaration-merging': 'off',
-    '@typescript-eslint/no-unsafe-function-type': 'off',
-    '@typescript-eslint/no-unused-expressions': 'off',
-    '@typescript-eslint/no-unused-vars': 'off',
-    '@typescript-eslint/no-wrapper-object-types': 'off',
-    '@typescript-eslint/prefer-as-const': 'off',
-    '@typescript-eslint/prefer-namespace-keyword': 'off',
-    '@typescript-eslint/triple-slash-reference': 'off',
-  }
-
-  const CURLY_RULE = ['error', 'all']
-
-  const TYPESCRIPT_RULES = {
-    curly: CURLY_RULE,
-    '@typescript-eslint/no-explicit-any': ['warn', { ignoreRestArgs: true }],
-    '@typescript-eslint/no-empty-object-type': [
-      'error',
-      {
-        allowInterfaces: 'always',
-      },
-    ],
-    '@typescript-eslint/no-unused-vars': [
-      'error',
-      {
-        args: 'all',
-        argsIgnorePattern: '^_',
-        caughtErrors: 'all',
-        caughtErrorsIgnorePattern: '^_',
-        destructuredArrayIgnorePattern: '^_',
-        varsIgnorePattern: '^_',
-        ignoreRestSiblings: true,
-      },
-    ],
-  }
-
-  const BASE_CONFIGS = [
-    comments(),
-    node(),
-    jsonc(),
-    test(),
-    sonarjs(),
-    promise(),
-  ]
-
-  const GLOBAL_RULES = {
-    curly: CURLY_RULE,
-    'node/prefer-global/process': 'off',
-  }
-
-  const TEST_RULES = {
-    'no-console': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-    'promise/avoid-new': 'off',
-  }
-
-  const IGNORE_PATTERNS = ['**/fixtures/**/*', '**/*.jsonc']
-
-  // The following rules are already handled by `@nuxt/eslint` and
-  // don't need to be extended from `@antfu/eslint-config` if it is used
-  const nonNuxtRules = !isNuxtProject
-    ? combine(
-        gitignore(),
-        ignores(),
-        importX(),
-        javascript(),
-        typescript(config.typescript),
-        jsdoc(),
-        tseslint.configs.recommended,
-        [{ rules: TYPESCRIPT_RULES }],
-      )
-    : {}
-
-  const configs = [
-    combine(...BASE_CONFIGS),
-    nonNuxtRules,
-    {
-      rules: GLOBAL_RULES,
-      ignores: [IGNORE_PATTERNS[0]],
-    },
-    {
-      files: ['**/*.json'],
-      rules: TYPESCRIPT_JSON_RULES,
-    },
-    {
-      files: GLOB_TESTS,
-      rules: TEST_RULES,
-    },
-    { ignores: [IGNORE_PATTERNS[1]] },
-    // Set tsconfigRootDir for all TypeScript files to support monorepo structure
-    // This ensures ESLint uses the correct tsconfig.json when multiple exist
-    {
-      files: ['**/*.mjs', '**/*.cjs', '**/*.ts', '**/*.tsx'],
-      languageOptions: {
-        parserOptions: {
-          tsconfigRootDir: process.cwd(),
-        },
-      },
-    },
-  ]
-
-  return flatConfigComposer.append(...configs)
-}

package/config/flat/promise.mjs

@@ -1,28 +0,0 @@
-import pluginPromise from 'eslint-plugin-promise'
-
-// Pre-defined rule configurations for better performance
-const PROMISE_RULES = {
-  'promise/no-multiple-resolved': 'error',
-  'promise/no-new-statics': 'error',
-  'promise/no-return-wrap': 'error',
-  'promise/always-return': 'warn',
-  'promise/avoid-new': 'warn',
-  'promise/catch-or-return': 'warn',
-  'promise/no-callback-in-promise': 'warn',
-  'promise/no-nesting': 'warn',
-  'promise/no-promise-in-callback': 'warn',
-  'promise/no-return-in-finally': 'warn',
-  'promise/param-names': 'warn',
-  'promise/valid-params': 'warn',
-  'promise/no-native': 'off',
-}
-
-export function promise() {
-  return [
-    {
-      name: 'storefront/promise/rules',
-      plugins: { promise: pluginPromise },
-      rules: PROMISE_RULES,
-    },
-  ]
-}

package/config/flat/sonarjs.mjs

@@ -1,19 +0,0 @@
-import pluginSonarjs from 'eslint-plugin-sonarjs'
-
-// Pre-defined rule configurations for better performance
-const SONARJS_RULES = {
-  'sonarjs/no-duplicate-string': 'off',
-  'sonarjs/todo-tag': 'warn',
-  'sonarjs/fixme-tag': 'warn',
-}
-
-export function sonarjs() {
-  return [
-    pluginSonarjs.configs.recommended,
-    {
-      name: 'storefront/sonarjs/rules',
-      plugins: { pluginSonarjs },
-      rules: SONARJS_RULES,
-    },
-  ]
-}