@scayle/eslint-config-storefront 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @aboutyou/eslint-config-sfc
 
+## 4.7.0
+
+### Minor Changes
+
+- Re-enabled previously disabled promise rules that are now compatible with ESLint Flat Config, adding comprehensive promise rule coverage with proper error, warning, and off severity levels. Rules now include `promise/no-multiple-resolved`, `promise/no-new-statics`, `promise/no-return-wrap` (error level), and various other promise-related rules (warning level). Additionally, removed `eslint-plugin-no-unsanitized` and its associated rules to simplify the configuration and remove potential conflicts with other security-focused plugins.
+
+  These changes also improve ESLint runtime performance by reducing the number of plugins loaded and optimizing rule configuration structure through pre-defined constants and simplified configuration trees. The removal of YAML parsing and linting support further reduces plugin overhead and improves linting reliability by eliminating potential parsing conflicts, syntax errors, and stability issues that can occur when processing complex YAML files.
+
+### Patch Changes
+
+- Removed dependency `eslint-plugin-no-unsanitized@^4.1.2`
+
+## 4.6.1
+
+### Patch Changes
+
+- Added dependency `eslint-plugin-import-x@^4.16.1`
+- Updated dependency `typescript-eslint@8.35.1` to `typescript-eslint@8.36.0`
+
 ## 4.6.0
 
 ### Minor Changes
@@ -16,11 +35,6 @@
   - `'import-x/no-self-import': 'error'`
   - `'import-x/no-extraneous-dependencies': 'error'`
 
-### Patch Changes
-
-- Added dependency `eslint-plugin-import-x@^4.16.1`
-- Updated dependency `typescript-eslint@8.35.1` to `typescript-eslint@8.36.0`
-
 ## 4.5.14
 
 ### Patch Changes

package/config/flat/importX.mjs

@@ -0,0 +1,22 @@
+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

@@ -5,26 +5,18 @@ import {
   combine,
   comments,
   ignores,
-  imports,
   javascript,
   jsdoc,
   jsonc,
   node,
   test,
   typescript,
-  yaml,
 } from '@antfu/eslint-config'
 import gitignore from 'eslint-config-flat-gitignore'
-import { importX } from 'eslint-plugin-import-x'
 import tseslint from 'typescript-eslint'
 import { sonarjs } from './sonarjs.mjs'
 import { promise } from './promise.mjs'
-import { sanitized } from './sanitized.mjs'
-
-/*
- * NOTES - REMOVE BEFORE MERGE!
- * - https://www.npmjs.com/package/eslint-plugin-regexp
- */
+import { importX } from './importX.mjs'
 
 // Partial eslint config by `@antfu/eslint-config`
 // <https://github.com/antfu/eslint-config/blob/main/README.md>
@@ -34,7 +26,6 @@ import { sanitized } from './sanitized.mjs'
  * @param {boolean=} config.isNuxt
  * @param {object=} config.typescript
  * @param {string=} config.typescript.tsconfigPath
- * @param {object=} config.custom
  * @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 = {
@@ -42,132 +33,103 @@ export const eslintConfigStorefront = function(config = {
   typescript: { tsconfigPath: undefined },
 }) {
   const flatConfigComposer = new FlatConfigComposer()
+  const isNuxtProject = config.isNuxt
 
-  const importXConfig = {
-    plugins: {
-      'import-x': importX,
-    },
-    files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
-    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',
-    },
+  // 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' }
+
+  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 = !config.isNuxt
+  const nonNuxtRules = !isNuxtProject
     ? combine(
       gitignore(),
       ignores(),
-      imports(),
+      importX(),
       javascript(),
       typescript(config.typescript),
       jsdoc(),
       tseslint.configs.recommended,
-      [{
-        rules: {
-          // https://eslint.org/docs/latest/rules/curly
-          'curly': ['error', 'all'],
-          // https://typescript-eslint.io/rules/no-explicit-any/
-          '@typescript-eslint/no-explicit-any': ['warn', {
-            ignoreRestArgs: true,
-          }],
-          // https://typescript-eslint.io/rules/no-empty-object-type/
-          '@typescript-eslint/no-empty-object-type': ['error', {
-            'allowInterfaces': 'always',
-          }],
-          // https://typescript-eslint.io/rules/no-unused-vars/
-          '@typescript-eslint/no-unused-vars': [
-            'error',
-            {
-              'args': 'all',
-              'argsIgnorePattern': '^_',
-              'caughtErrors': 'all',
-              'caughtErrorsIgnorePattern': '^_',
-              'destructuredArrayIgnorePattern': '^_',
-              'varsIgnorePattern': '^_',
-              'ignoreRestSiblings': true,
-            },
-          ],
-        },
-      }],
-      importXConfig,
+      [{ rules: TYPESCRIPT_RULES }],
     )
     : {}
 
   const configs = [
-    combine(
-      comments(), // https://github.com/antfu/eslint-config/blob/main/src/configs/comments.ts
-      node(), // https://github.com/antfu/eslint-config/blob/main/src/configs/node.ts
-      jsonc(), // https://github.com/antfu/eslint-config/blob/main/src/configs/jsonc.ts
-      yaml(), // https://github.com/antfu/eslint-config/blob/main/src/configs/yaml.ts
-      test(), // https://github.com/antfu/eslint-config/blob/main/src/configs/test.ts
-      sonarjs(),
-      promise(),
-      sanitized(),
-      importXConfig,
-    ),
+    combine(...BASE_CONFIGS),
     nonNuxtRules,
     {
-      rules: {
-        // https://eslint.org/docs/latest/rules/curly
-        'curly': ['error', 'all'],
-      },
+      rules: GLOBAL_RULES,
+      ignores: [IGNORE_PATTERNS[0]],
     },
-    {
-      // Disable default rules by imported @antfu/eslint-config
-      rules: {
-        'node/prefer-global/process': 'off',
-        'yaml/plain-scalar': 'off',
-      },
-      ignores: ['**/fixtures/**/*'],
-    },
-    // Disable TypeScript ESLint rules for JSON files
     {
       files: ['**/*.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',
-      },
+      rules: TYPESCRIPT_JSON_RULES,
     },
-    // Specific rules handling for test files
     {
-      // See https://github.com/antfu/eslint-config/blob/main/src/globs.ts#L34
       files: GLOB_TESTS,
-      rules: {
-        'no-console': 'off',
-      },
-    },
-    {
-      ignores: ['**/*.jsonc'],
+      rules: TEST_RULES,
     },
+    { ignores: [IGNORE_PATTERNS[1]] },
   ]
 
   return flatConfigComposer.append(

package/config/flat/promise.mjs

@@ -1,19 +1,37 @@
 import pluginPromise from 'eslint-plugin-promise'
 
+// Pre-defined rule configurations for better performance
+const ERROR_RULES = {
+  'promise/no-multiple-resolved': 'error',
+  'promise/no-new-statics': 'error',
+  'promise/no-return-wrap': 'error',
+}
+
+const WARN_RULES = {
+  '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',
+}
+
+const OFF_RULES = {
+  'promise/no-native': 'off',
+}
+
 export function promise() {
   return [
     {
       name: 'storefront/promise/rules',
-      // eslint-plugin-promise
-      // Support for FlatConfig: <https://github.com/eslint-community/eslint-plugin-promise/issues/449>
-      // Disabling currently incompatible rules per recommendation:
-      // <https://github.com/eslint-community/eslint-plugin-promise/issues/449#issuecomment-2051655694>
       plugins: { promise: pluginPromise },
       rules: {
-        'promise/no-return-wrap': 'off',
-        'promise/no-promise-in-callback': 'off',
-        'promise/no-nesting': 'off',
-        'promise/no-callback-in-promise': 'off',
+        ...ERROR_RULES,
+        ...WARN_RULES,
+        ...OFF_RULES,
       },
     },
   ]

package/config/flat/sonarjs.mjs

@@ -1,20 +1,19 @@
 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',
-      // Legacy: eslint-plugin-sonarjs
-      // Support for FlatConfig: <https://github.com/SonarSource/SonarJS/issues/3968>
-      'plugins': {
-        pluginSonarjs,
-      },
-      rules: {
-        'sonarjs/no-duplicate-string': 'off',
-        'sonarjs/todo-tag': 'warn',
-        'sonarjs/fixme-tag': 'warn',
-      },
+      plugins: { pluginSonarjs },
+      rules: SONARJS_RULES,
     },
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/eslint-config-storefront",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "SCAYLE Commerce Engine specific eslint configuration",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -20,7 +20,7 @@
     "./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/sanitized.mjs": "./config/flat/sanitized.mjs"
+    "./config/flat/importX.mjs": "./config/flat/importX.mjs"
   },
   "main": "./index.mjs",
   "files": [
@@ -39,7 +39,6 @@
     "eslint-config-flat-gitignore": "^2.0.0",
     "eslint-flat-config-utils": "^2.0.0",
     "eslint-plugin-import-x": "^4.16.1",
-    "eslint-plugin-no-unsanitized": "^4.1.2",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-sonarjs": "^3.0.1",
     "local-pkg": "^1.0.0",

package/config/flat/sanitized.mjs

@@ -1,13 +0,0 @@
-import pluginNoUnsanitized from 'eslint-plugin-no-unsanitized'
-
-export function sanitized() {
-  return [
-    {
-      name: 'storefront/sanitized/rules',
-      plugins: {
-        sanitized: pluginNoUnsanitized,
-      },
-      rules: {},
-    },
-  ]
-}