@scayle/eslint-config-storefront 3.2.6 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @aboutyou/eslint-config-sfc
 
+## 4.0.0
+
+### Major Changes
+
+- We migrated to `eslint@9` and [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files), to provide improved organization and composition.
+  Additionally we simplified the configuration setup by adapting some configurations provided by [@antfu/eslint-config](https://github.com/antfu/eslint-config).
+
+  Following example can be checked to see how to use this configuration package in your projects `eslint.config.mjs` configuration file:
+
+  For "pure" TypeScript / Node projects:
+
+  ```js
+  // eslint.config.mjs
+  import eslintConfigStorefront from "@scayle/eslint-config-storefront";
+
+  export default eslintConfigStorefront();
+  ```
+
+  For Nuxt projects using `@nuxt/eslint` module:
+
+  ```js
+  import withNuxt from "./.nuxt/eslint.config.mjs";
+  import eslintConfigStorefront from "@scayle/eslint-config-storefront";
+
+  export default withNuxt(eslintConfigStorefront());
+  ```
+
+  The `@scayle/eslint-config-storefront` package exports a factory function `eslintConfigStorefront()`. The factory function is able to automatically detect if a project is using the `@nuxt/eslint` package and automatically disables certain duplicate rules that are provided by `@nuxt/eslint`. This can also manually be adjusted by passing `{ isNuxt: true }` as parameter to `eslintConfigStorefront()`.
+
+  More details about the `@nuxt/eslint` module can be found within the [official module documentation](https://eslint.nuxt.com/packages/module).
+
+  Should you want to upgrade from `eslint@8` to `eslint@9`, you can check the official [Eslint Migration Guide](https://eslint.org/docs/latest/use/configure/migration-guide).
+
+  Should you require support for `eslint@8`, please use `@scayle/eslint-config-storefront@3`.
+
+## 3.2.7
+
+### Patch Changes
+
+- Format code with dprint
+
 ## 3.2.6
 
 ### Patch Changes
@@ -51,7 +92,7 @@
 
 ### Minor Changes
 
-- - Replaced `enums` with the companion object pattern approach.
+- Replaced `enums` with the companion object pattern approach.
 
 ## 3.0.0
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 SCAYLE GmbH
+Copyright (c) 2024 SCAYLE GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,233 +1,143 @@
-# eslint-config-storefront
+# @scayle/eslint-config-storefront
 
-A [shared `eslint` config](https://eslint.org/docs/latest/extend/shareable-configs#creating-a-shareable-config) for SCAYLE Storefront Core v2 and SCAYLE frontend projects.
+A [shared `eslint` config](https://eslint.org/docs/latest/extend/shareable-configs#creating-a-shareable-config) for SCAYLE Storefront projects and packages.
+Provides SCAYLE-specific `eslint` configuration for Frontend and Node.js projects using TypeScript.
 
----
-
-## ESLint
+We migrated to `eslint@9` and [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files), to provide improved organization and composition.
 
-> ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.
+Should you require support for `eslint@8`, please use `@scayle/eslint-config-storefront@3`.
 
+- Partially based on [@antfu/eslint-config](https://github.com/antfu/eslint-config)
 - [Official ESLint Documentation](https://eslint.org/docs/latest/)
 
-### Provides shared configurations
-
-#### Default config / `@scayle/eslint-config-storefront`
-
-Provides Scayle-specific `eslint` configuration for Frontend and Node.js projects using TypeScript.
-
-#### Nuxt 2 config / `@scayle/eslint-config-storefront/nuxt/nuxt2`
-
-Provides a Vue2- and Nuxt2-specific partial configuration for `eslint`.
-Based on `plugin:vue/recommended` and should be used with [`@scayle/eslint-config-storefront`](#default-config)
-
-#### Nuxt 3 config / `@scayle/eslint-config-storefront/nuxt/nuxt`
-
-Provides a Vue3- and Nuxt2-specific partial configuration for `eslint`.
-Based on `plugin:vue/vue-3recommended` and should be used with [`@scayle/eslint-config-storefront`](#default-config)
-
-### Used plugins and configurations
-
-#### `@rushstack/eslint-patch`
-
-> A patch that improves how ESLint loads plugins when working in a monorepo with a reusable toolchain
-
-**Why?**
-This patch allows a shared config to include its own `eslint` plugins instead of having them required as peer dependencies for every package that uses this config, which by itself is not yet supported by `eslint`.
-
-- License: [**MIT**](https://github.com/microsoft/rushstack/blob/main/eslint/eslint-patch/LICENSE)
-- [README](https://github.com/microsoft/rushstack/blob/main/eslint/eslint-patch/README.md)
-- [Repository](https://github.com/microsoft/rushstack/tree/main/eslint/eslint-patch)
-
-#### `@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser`
-
-> The tooling that enables ESLint and Prettier to support TypeScript.
-
-**Why?**
-Enables support for parsing and linting TypeScript files.
-
-- License: [**Use and redistribution without modification**](https://github.com/typescript-eslint/typescript-eslint/blob/main/LICENSE)
-- [Documentation](https://typescript-eslint.io/)
-- [Repository](https://github.com/typescript-eslint/typescript-eslint)
-
-#### `eslint-config-prettier`
-
-> Turns off all rules that are unnecessary or might conflict with Prettier.
-
-**Why?**
-Disables all relevant `eslint` rules that are covered by `prettier`, thus avoiding conflicts between tools.
-
-- [**MIT**](https://github.com/prettier/eslint-config-prettier/blob/main/LICENSE)
-- [Readme](https://github.com/prettier/eslint-config-prettier/blob/main/README.md)
-- [Repository](https://github.com/prettier/eslint-config-prettier)
-
-#### `eslint-config-standard`
-
-> An ESLint Shareable Config for JavaScript Standard Style
-
-**Why?**
-Provides JavaScript Standard code style compliant ruleset.
-
-- License: [**MIT**](https://github.com/standard/eslint-config-standard/blob/master/LICENSE)
-- [JavaScript Standard Style Documentation](https://standardjs.com/)
-- [Repository](https://github.com/standard/eslint-config-standard)
-
-#### `eslint-plugin-eslint-comments`
-
-> Additional ESLint rules for ESLint directive comments (e.g.`//eslint-disable-line`).
-
-**Why?**
-Provides linting rule targeted at disabling `eslint` code comments, thus allowing fain-grained control what is allowed to be disabled and what needs to be addressed instead.
-
-- License: [**MIT**](https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/LICENSE)
-- [Documentation](https://mysticatea.github.io/eslint-plugin-eslint-comments/)
-- [Repository](https://github.com/mysticatea/eslint-plugin-eslint-comments)
-
-#### `eslint-plugin-html`
-
-> A ESLint plugin to lint and fix inline scripts contained in HTML files.
-
-**Why?**
-Allows to lint code within `<script>` tags in HTML markup.
-
-- License: [**Use and redistribution without modification**](https://github.com/BenoitZugmeyer/eslint-plugin-html/blob/main/LICENSE)
-- [README](https://github.com/BenoitZugmeyer/eslint-plugin-html/blob/main/README.md)
-- [Repository](https://github.com/BenoitZugmeyer/eslint-plugin-html)
-
-#### `eslint-plugin-import`
-
-> This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, and prevent issues with misspelling of file paths and import names.
-
-**Why?**
-Extends the linting ruleset to support ES6+ import/export syntax, thus reducing amount of false-positives in default `eslint` setup.
-
-- License: [**MIT**](https://github.com/import-js/eslint-plugin-import/blob/main/LICENSE)
-- [README](https://github.com/import-js/eslint-plugin-import/blob/main/README.md)
-- [Repository](https://github.com/import-js/eslint-plugin-import)
-
-#### `eslint-plugin-jsonc` & `jsonc-eslint-parser`
-
-> This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using JSON, JSONC and JSON5.
-
-**Why?**
-Enables support for parsing and extends linting of JSON-based files.
-
-- License: [**MIT**](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/LICENSE)
-- [eslint-plugin-jsonc Documentation](https://ota-meshi.github.io/eslint-plugin-jsonc/)
-- [eslint-plugin-jsonc Repository](https://github.com/ota-meshi/eslint-plugin-jsonc)
-- [jsonc-eslint-parser Repository](https://github.com/ota-meshi/jsonc-eslint-parser)
-
-#### `eslint-plugin-markdown`
-
-> Lint JS, JSX, TypeScript, and more inside Markdown.
-
-**Why?**
-Allows to lint code blocks within Markdown files.
-
-- License: [**MIT**](https://github.com/eslint/eslint-plugin-markdown/blob/main/LICENSE)
-- [README](https://github.com/eslint/eslint-plugin-markdown/blob/main/README.md)
-- [Repository](https://github.com/eslint/eslint-plugin-markdown)
-
-#### `eslint-plugin-n`
-
-> Additional ESLint's rules for Node.js
+---
 
-**Why?**
-Provides support for Node.js specifics code and compatibility checks.
+## Install
 
-- License: [**MIT**](https://github.com/eslint-community/eslint-plugin-n/blob/master/LICENSE)
-- [README](https://github.com/eslint-community/eslint-plugin-n/blob/master/README.md)
-- [Repository](https://github.com/eslint-community/eslint-plugin-n)
+Add the `@scayle/eslint-config-storefront` manually to your project:
 
-#### `eslint-plugin-no-unsanitized`
+`pnpm i -D eslint @scayle/eslint-config-storefront`
 
-> These rules disallow unsafe coding practices that may result into security vulnerabilities.
+`yarn add -D eslint @scayle/eslint-config-storefront`
 
-**Why?**
-Will disallow assignments (e.g., to `innerHTML`) as well as calls (e.g., to `insertAdjacentHTML`) without the use of a pre-defined escaping function.
+And create a `eslint.config.mjs` in your project root:
 
-- License: [**Mozilla Public License 2.0**](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/LICENSE)
-- [README](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/README.md)
-- [Repository](https://github.com/mozilla/eslint-plugin-no-unsanitized)
+```js
+// eslint.config.mjs
+import eslintConfigStorefront from '@scayle/eslint-config-storefront'
 
-#### `eslint-plugin-nuxt`
+export default eslintConfigStorefront()
+```
 
-> ESLint plugin for Nuxt.js
+### Add script for package.json
 
-**Why?**
-Provides Nuxt.js-specific linting ruleset and configuration.
+For example:
 
-- License: [**MIT**](https://github.com/nuxt/eslint-plugin-nuxt/blob/master/LICENSE)
-- [README](https://github.com/nuxt/eslint-plugin-nuxt/blob/master/README.md)
-- [Repository](https://github.com/nuxt/eslint-plugin-nuxt)
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
 
-#### `eslint-plugin-promise`
+## VS Code support (auto fix on save)
 
-> Enforce best practices for JavaScript promises.
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
-**Why?**
-Provides ruleset to enforce best practices for JavaScript promises.
+Add the following settings to your `.vscode/settings.json`:
 
-- License: [**ISC**](https://github.com/eslint-community/eslint-plugin-promise/blob/main/LICENSE.md)
-- [README](https://github.com/eslint-community/eslint-plugin-promise/blob/main/README.md)
-- [Repository](https://github.com/eslint-community/eslint-plugin-promise)
+```jsonc
+{
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
 
-#### `eslint-plugin-sonarjs`
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
 
-**NOTE: Currently not enabled!**
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+}
+```
 
-> SonarJS rules for ESLint to detect bugs and suspicious patterns in your code.
+## Customization
 
-**Why**
-Provides ruleset to detect possibler code smells and common sources for bugs.
+### Provides shared configurations
 
-- License: [**LGPL-3.0**](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/master/LICENSE)
-- [README](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/master/README.md)
-- [Repository](https://github.com/SonarSource/eslint-plugin-sonarjs)
+#### Default config / `@scayle/eslint-config-storefront`
 
-#### `eslint-plugin-unicorn`
+Normally you only need to import the antfu preset:
 
-**NOTE: Currently not enabled!**
+```js
+// eslint.config.mjs
+import eslintConfigStorefront from '@scayle/eslint-config-storefront'
 
-> More than 100 powerful ESLint rules for best practice and security purposes
+export default eslintConfigStorefront()
+```
 
-**Why**
-...
+### Extended Configuration
 
-- License: [**MIT**](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/license)
-- [README](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/readme.md)
-- [Repository](https://github.com/sindresorhus/eslint-plugin-unicorn)
+```js
+// eslint.config.mjs
+import eslintConfigStorefront from '@scayle/eslint-config-storefront'
 
-#### `eslint-plugin-unused-imports`
+export default eslintConfigStorefront({
+  // If set to `true` removes all rule configurations
+  // that are provided by the `@nuxt/eslint` package
+  isNuxt: true, // Default via auto-detection of package `@nuxt/eslint`
 
-> Find and remove unused es6 module imports
+  // If set to `true` adds `eslint-plugin-tailwind`
+  isTailwind: true, // Default via auto-detection of package `eslint-plugin-tailwind`
 
-**Why?**
-Extends analysis of ES6+ module imports by hooking into `no-unused-vars` for JavaScript and TypeScript files.
+  typescript: {
+    // Enables type-aware rules
+    // Only works if `isNuxt` is `false`!
+    // <https://github.com/antfu/eslint-config?tab=readme-ov-file#type-aware-rules>
+    tsconfigPath: 'path/to/tsconfig.ts',
+  },
+})
+```
 
-- License: [**MIT**](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/license)
-- [README](https://github.com/sweepline/eslint-plugin-unused-imports/blob/master/README.md)
-- [Repository](https://github.com/sweepline/eslint-plugin-unused-imports)
+### Plugins Renaming
 
-#### `eslint-plugin-vue`
+Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
 
-> Official ESLint plugin for Vue.js.
+| New Prefix | Original Prefix        | Source Plugin                                                                              |
+| ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `import/*` | `import-x/*`           | [eslint-plugin-import-x](https://github.com/un-es/eslint-plugin-import-x)                  |
+| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                     |
+| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                        |
+| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `test/*`   | `vitest/*`             | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)                    |
+| `test/*`   | `no-only-tests/*`      | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests)  |
 
-**Why?**
-Provides Vue-specific linting ruleset and configuration. Supports both Vue2 and Vue3.
+When you want to override rules, or disable them inline, you need to update to the new prefix:
 
-- License: [**MIT**](https://github.com/vuejs/eslint-plugin-vue/blob/master/LICENSE)
-- [Documentation](https://eslint.vuejs.org/)
-- [Repository](https://github.com/vuejs/eslint-plugin-vue)
+```diff
+-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
++// eslint-disable-next-line ts/consistent-type-definitions
+type foo = { bar: 2 }
+```
 
-#### `eslint-plugin-yml` & `yaml-eslint-parser`
+## View what rules are enabled
 
-> eslint-plugin-yml is ESLint plugin provides linting rules for YAML.
+[Anthony Fu](https://github.com/antfu) built a visual tool to help you view what rules are enabled in your project and apply them to what files, [@eslint/config-inspector](https://github.com/eslint/config-inspector).
 
-**Why?**
-Enables support for parsing and extends linting of YAML-based files.
+Go into your project root that contains eslint.config.js and run:
 
-- License: [**MIT**](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/LICENSE)
-- [eslint-plugin-yml Documentation](https://ota-meshi.github.io/eslint-plugin-yml/)
-- [eslint-plugin-yml Repository](https://github.com/ota-meshi/eslint-plugin-yml)
-- [yaml-eslint-parser Repository](https://github.com/ota-meshi/yaml-eslint-parser)
+`npx @eslint/config-inspector`

package/config/flat/index.mjs

@@ -0,0 +1,81 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils'
+import { isPackageExists } from 'local-pkg'
+import {
+  combine,
+  comments,
+  ignores,
+  imports,
+  javascript,
+  jsdoc,
+  jsonc,
+  node,
+  test,
+  typescript,
+  yaml,
+} from '@antfu/eslint-config'
+import gitignore from 'eslint-config-flat-gitignore'
+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
+ */
+
+// 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
+ * @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 = {
+  isNuxt: isPackageExists('@nuxt/eslint'),
+  typescript: { tsconfigPath: undefined },
+}) {
+  const flatConfigComposer = new FlatConfigComposer()
+
+  // 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
+    ? combine(
+      gitignore(),
+      ignores(),
+      imports(),
+      javascript(),
+      typescript(config.typescript),
+      jsdoc(),
+    )
+    : {}
+
+  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(),
+    ),
+    nonNuxtRules,
+    {
+      // Disable default rules by imported @antfu/eslint-config
+      rules: {
+        'node/prefer-global/process': 'off',
+        'yaml/plain-scalar': 'warn',
+      },
+      ignores: ['**/fixtures/**/*'],
+    },
+  ]
+
+  return flatConfigComposer.append(
+    ...configs,
+  )
+}

package/config/flat/promise.mjs

@@ -0,0 +1,20 @@
+import pluginPromise from 'eslint-plugin-promise'
+
+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',
+      },
+    },
+  ]
+}

package/config/flat/sanitized.mjs

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

package/config/flat/sonarjs.mjs

@@ -0,0 +1,26 @@
+import pluginSonarjs from 'eslint-plugin-sonarjs'
+
+export function sonarjs() {
+  return [
+    {
+      name: 'storefront/sonarjs/rules',
+      // Legacy: eslint-plugin-sonarjs
+      // Support for FlatConfig: <https://github.com/SonarSource/SonarJS/issues/3968>
+      // Disabling currently incompatible rules per recommendation:
+      // <https://github.com/SonarSource/eslint-plugin-sonarjs/issues/454#issuecomment-2051659694>
+      plugins: {
+        sonarjs: pluginSonarjs,
+      },
+      rules: {
+        'sonarjs/no-gratuitous-expressions': 'off',
+        'sonarjs/no-empty-collection': 'off',
+        'sonarjs/no-unused-collection': 'off',
+        'security/detect-child-process': 'off',
+        'sonarjs/no-use-of-empty-return-value': 'off',
+        'sonarjs/no-extra-arguments': 'off',
+        'sonarjs/no-redundant-jump': 'off',
+        'sonarjs/no-one-iteration-loop': 'off',
+      },
+    },
+  ]
+}

package/index.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/eslint-config-storefront",
-  "version": "3.2.6",
+  "version": "4.0.0",
   "description": "SCAYLE Commerce Engine specific eslint configuration",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -8,59 +8,46 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
+  "type": "module",
   "exports": {
-    ".": "./index.js",
-    "./nuxt/nuxt2": "./nuxt/nuxt2.cjs",
-    "./nuxt/nuxt": "./nuxt/nuxt.cjs",
-    "./config/eslint-config-yml.cjs": "./config/eslint-config-yml.cjs",
-    "./config/eslint-config-json.cjs": "./config/eslint-config-json.cjs",
-    "./config/eslint-config-vue-base.cjs": "./config/eslint-config-vue-base.cjs"
+    ".": "./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/sanitized.mjs": "./config/flat/sanitized.mjs"
   },
-  "main": "./index.js",
+  "main": "./index.mjs",
   "files": [
     "CHANGELOG.md",
-    "./index.js",
-    "./config/",
-    "./nuxt/"
+    "README.md",
+    "./index.mjs",
+    "./config/"
   ],
   "scripts": {
-    "format": "prettier --ignore-unknown --log-level warn --check .",
-    "format:fix": "prettier --ignore-unknown --log-level warn --write .",
+    "format": "dprint check",
+    "format:fix": "dprint fmt",
     "lint": "eslint . --format gitlab",
     "lint:fix": "eslint . --fix",
     "package:lint": "publint"
   },
   "peerDependencies": {
-    "eslint": "^8.55.0",
-    "typescript": "^5.3.3"
+    "eslint": "^9.0.0",
+    "typescript": "^5.4.0"
   },
   "dependencies": {
-    "@rushstack/eslint-patch": "1.6.0",
-    "@typescript-eslint/eslint-plugin": "6.14.0",
-    "@typescript-eslint/parser": "6.14.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-config-standard": "17.1.0",
-    "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-html": "7.1.0",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-n": "16.4.0",
+    "local-pkg": "0.5.0",
+    "@antfu/eslint-config": "2.14.0",
+    "@eslint/eslintrc": "3.0.2",
+    "eslint-flat-config-utils": "0.2.3",
+    "eslint-config-flat-gitignore": "0.1.5",
     "eslint-plugin-no-unsanitized": "4.0.2",
-    "eslint-plugin-nuxt": "4.0.0",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-sonarjs": "0.23.0",
-    "eslint-plugin-unicorn": "49.0.0",
-    "eslint-plugin-unused-imports": "3.0.0",
-    "eslint-plugin-vue": "9.19.2",
-    "eslint-plugin-yml": "1.10.0",
-    "jsonc-eslint-parser": "2.4.0",
-    "yaml-eslint-parser": "1.2.2"
+    "eslint-plugin-sonarjs": "0.25.1"
   },
   "devDependencies": {
-    "@scayle/prettier-config-storefront": "2.0.2",
-    "@types/eslint": "8.44.9",
-    "eslint": "8.55.0",
+    "dprint": "0.45.1",
+    "eslint": "9.0.0",
     "eslint-formatter-gitlab": "5.1.0",
-    "prettier": "3.0.0",
-    "publint": "0.2.6"
+    "publint": "0.2.7"
   }
 }

package/config/eslint-config-json.cjs

@@ -1,112 +0,0 @@
-/**
- * Shared eslint config for codeblocks within MD / Markdown
- * https://eslint.org/docs/latest/
- *
- * Partially based on
- * - https://github.com/antfu/eslint-config/blob/main/packages/eslint-config-basic
- */
-
-// A patch that improves how ESLint loads plugins when
-// working in a monorepo with a reusable toolchain.
-// https://github.com/microsoft/rushstack/tree/main/eslint/eslint-patch
-require('@rushstack/eslint-patch/modern-module-resolution')
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: ['plugin:jsonc/recommended-with-jsonc'],
-  overrides: [
-    {
-      // JSON(C) specific rule overrides
-      // https://ota-meshi.github.io/eslint-plugin-jsonc/
-      // https://github.com/ota-meshi/jsonc-eslint-parser
-      files: ['*.json', '*.json5'],
-      parser: 'jsonc-eslint-parser',
-      rules: {
-        'jsonc/array-bracket-spacing': ['error', 'never'],
-        'jsonc/comma-dangle': ['error', 'never'],
-        'jsonc/comma-style': ['error', 'last'],
-        'jsonc/indent': ['error', 2],
-        'jsonc/key-spacing': [
-          'error',
-          { beforeColon: false, afterColon: true },
-        ],
-        'jsonc/no-octal-escape': 'error',
-        'jsonc/object-curly-newline': [
-          'error',
-          { multiline: true, consistent: true },
-        ],
-        'jsonc/object-curly-spacing': ['error', 'always'],
-        'jsonc/object-property-newline': [
-          'error',
-          { allowMultiplePropertiesPerLine: true },
-        ],
-      },
-    },
-    {
-      // package.json specific rule overrides
-      // https://ota-meshi.github.io/eslint-plugin-jsonc/rules/sort-keys.html
-      files: ['package.json'],
-      parser: 'jsonc-eslint-parser',
-      rules: {
-        'jsonc/sort-keys': [
-          'error',
-          {
-            pathPattern: '^$',
-            order: [
-              'publisher',
-              'name',
-              'displayName',
-              'type',
-              'version',
-              'private',
-              'packageManager',
-              'description',
-              'author',
-              'license',
-              'funding',
-              'homepage',
-              'repository',
-              'bugs',
-              'keywords',
-              'categories',
-              'sideEffects',
-              'exports',
-              'main',
-              'module',
-              'unpkg',
-              'types',
-              'typesVersions',
-              'bin',
-              'icon',
-              'files',
-              'engines',
-              'activationEvents',
-              'contributes',
-              'scripts',
-              'peerDependencies',
-              'peerDependenciesMeta',
-              'dependencies',
-              'optionalDependencies',
-              'devDependencies',
-              'pnpm',
-              'overrides',
-              'resolutions',
-              'husky',
-              'simple-git-hooks',
-              'lint-staged',
-              'eslintConfig',
-            ],
-          },
-          {
-            pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
-            order: { type: 'asc' },
-          },
-          {
-            pathPattern: '^exports.*$',
-            order: ['types', 'require', 'import'],
-          },
-        ],
-      },
-    },
-  ],
-}

package/config/eslint-config-vue-base.cjs

@@ -1,57 +0,0 @@
-/**
- * Shared eslint config for Vue
- * https://eslint.org/docs/latest/
- *
- */
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  overrides: [
-    {
-      files: ['*.vue'],
-      parser: 'vue-eslint-parser',
-      parserOptions: {
-        parser: '@typescript-eslint/parser',
-      },
-      // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended.ts
-      rules: {
-        'no-unused-vars': 'off',
-        'constructor-super': 'off', // ts(2335) & ts(2377)
-        'getter-return': 'off', // ts(2378)
-        'no-const-assign': 'off', // ts(2588)
-        'no-dupe-args': 'off', // ts(2300)
-        'no-dupe-class-members': 'off', // ts(2393) & ts(2300)
-        'no-dupe-keys': 'off', // ts(1117)
-        'no-func-assign': 'off', // ts(2539)
-        'no-import-assign': 'off', // ts(2539) & ts(2540)
-        'no-new-symbol': 'off', // ts(7009)
-        'no-obj-calls': 'off', // ts(2349)
-        'no-redeclare': 'off', // ts(2451)
-        'no-setter-return': 'off', // ts(2408)
-        'no-this-before-super': 'off', // ts(2376)
-        'no-undef': 'off', // ts(2304)
-        'no-unreachable': 'off', // ts(7027)
-        'no-unsafe-negation': 'off', // ts(2365) & ts(2360) & ts(2358)
-        'no-var': 'error', // ts transpiles let/const to var, so no need for vars any more
-        'prefer-const': 'error', // ts provides better types with const
-        'prefer-rest-params': 'error', // ts provides better types with rest args over arguments
-        'prefer-spread': 'error', // ts transpiles spread to apply, so no need for manual apply
-        'valid-typeof': 'off', // ts(2367)
-      },
-    },
-
-    {
-      files: [
-        // These pages are not used directly by users so they can have one-word names.
-        // https://github.com/nuxt/eslint-config/blob/main/packages/eslint-config/index.js#L66
-        '**/pages/**/*.{js,ts,jsx,tsx,vue}',
-        '**/layouts/**/*.{js,ts,jsx,tsx,vue}',
-        '**/app.{js,ts,jsx,tsx,vue}',
-        '**/error.{js,ts,jsx,tsx,vue}',
-        // These files should have multiple words in their names as they are within subdirectories.
-        '**/components/*/**/*.{js,ts,jsx,tsx,vue}',
-      ],
-      rules: { 'vue/multi-word-component-names': 'off' },
-    },
-  ],
-}

package/config/eslint-config-yml.cjs

@@ -1,29 +0,0 @@
-/**
- * Shared eslint config for codeblocks within MD / Markdown
- * https://eslint.org/docs/latest/
- *
- * Partially based on
- * - https://github.com/antfu/eslint-config/blob/main/packages/eslint-config-basic
- */
-
-// A patch that improves how ESLint loads plugins when
-// working in a monorepo with a reusable toolchain.
-// https://github.com/microsoft/rushstack/tree/main/eslint/eslint-patch
-require('@rushstack/eslint-patch/modern-module-resolution')
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: ['plugin:yml/standard', 'plugin:yml/prettier'],
-  overrides: [
-    {
-      // YAML specific rule overrides
-      // https://ota-meshi.github.io/eslint-plugin-yml/
-      // https://github.com/ota-meshi/yaml-eslint-parser
-      files: ['*.yaml', '*.yml'],
-      parser: 'yaml-eslint-parser',
-      rules: {
-        'spaced-comment': 'off',
-      },
-    },
-  ],
-}

package/index.js

@@ -1,240 +0,0 @@
-/**
- * Shared eslint config
- * https://eslint.org/docs/latest/
- *
- * Partially based on
- * - https://github.com/antfu/eslint-config/blob/main/packages/eslint-config-basic
- */
-
-// A patch that improves how ESLint loads plugins when
-// working in a monorepo with a reusable toolchain.
-// https://github.com/microsoft/rushstack/tree/main/eslint/eslint-patch
-require('@rushstack/eslint-patch/modern-module-resolution')
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  parserOptions: {
-    ecmaVersion: '2018',
-    parser: {
-      js: 'espree',
-      jsx: 'espree',
-      // eslint-disable-next-line sonarjs/no-duplicate-string
-      ts: '@typescript-eslint/parser',
-      tsx: '@typescript-eslint/parser',
-    },
-    extraFileExtensions: ['.vue'],
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-  env: {
-    es6: true,
-    browser: true,
-    node: true,
-  },
-  // Reports errors for unused `eslint-disable directives`
-  // when no problems would be reported in the disabled area
-  // https://eslint.org/docs/latest/integrate/nodejs-api#linterverify
-  reportUnusedDisableDirectives: true,
-  ignorePatterns: [
-    '__snapshots__',
-    '.nuxt',
-    '.output',
-    '*.d.ts',
-    '*.min.*',
-    'build',
-    'CHANGELOG.md',
-    'coverage',
-    'dist',
-    'LICENSE*',
-    'node_modules',
-    'out',
-    'output',
-    'package-lock.json',
-    'pnpm-lock.yaml',
-    'public',
-    'temp',
-    'yarn.lock',
-    // ignore for in lint-staged
-    '*.css',
-    '*.png',
-    '*.ico',
-    '*.toml',
-    '*.patch',
-    '*.txt',
-    '*.crt',
-    '*.csr',
-    '*.key',
-    'Dockerfile',
-    '!.vscode',
-  ],
-  extends: [
-    'plugin:@typescript-eslint/eslint-recommended',
-    'standard',
-    // 'plugin:n/recommended', // Disabled to to config collision with 'standard'
-    'plugin:import/recommended',
-    'plugin:import/typescript',
-    'plugin:eslint-comments/recommended',
-    'plugin:sonarjs/recommended',
-    'plugin:no-unsanitized/DOM',
-    // 'plugin:unicorn/recommended',
-    './config/eslint-config-yml.cjs',
-    'prettier',
-  ],
-  plugins: [
-    '@typescript-eslint',
-    'html',
-    'promise',
-    'unused-imports',
-    'sonarjs',
-  ],
-  // Shared configuration for rules
-  settings: {
-    'import/resolver': {
-      node: {
-        extensions: ['.js', '.jsx', '.mjs', 'cjs', '.ts', '.tsx', '.d.ts'],
-      },
-    },
-  },
-  rules: {
-    /** General Code Rules **/
-    // Handled by unused-imports/no-unused-imports
-    '@typescript-eslint/no-unused-vars': 'off',
-    'no-redeclare': 'off',
-    '@typescript-eslint/no-redeclare': [
-      'error',
-      { ignoreDeclarationMerge: true },
-    ],
-    // 'n/no-missing-import': 0,
-    // 'n/no-missing-require': 0,
-    // Enforce import order
-    'import/order': 'error',
-    // Imports should come first
-    'import/first': 'error',
-    // Exporting mutable variables
-    'import/no-mutable-exports': 'error',
-    // Allow unresolved imports
-    'import/no-unresolved': 'off',
-    // Allow debugger during development
-    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
-    // 'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
-    // Prefer const over let
-    'prefer-const': [
-      'error',
-      {
-        destructuring: 'any',
-        ignoreReadBeforeAssign: false,
-      },
-    ],
-    // No single if in an "else" block
-    'no-lonely-if': 'error',
-    // Force curly braces for control flow, including if blocks with a single statement
-    curly: ['error', 'all'],
-    // No async function without await
-    'require-await': 'error',
-    // Force dot notation when possible
-    'dot-notation': 1,
-    // Warn for void usage
-    'no-void': 1,
-    'no-var': 'error',
-    // Force object shorthand where possible
-    'object-shorthand': 'error',
-    // No useless destructuring/importing/exporting renames
-    'no-useless-rename': 'error',
-    // Per the docs, the root no-unused-vars should be disabled:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md
-    // '@typescript-eslint/no-unused-vars': ['error', { args: 'all', argsIgnorePattern: '^_' }],
-    'no-unused-vars': 'off',
-    // https://github.com/typescript-eslint/typescript-eslint/blob/1cf9243/docs/getting-started/linting/FAQ.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
-    'no-undef': 'off',
-
-    /** Formatting (not handled by Prettier) **/
-    // Deprecated
-    'newline-before-return': 'off',
-    // Deprecated
-    'newline-after-var': 'off',
-    // https://eslint.org/docs/latest/rules/padding-line-between-statements
-    'padding-line-between-statements': [
-      'error',
-      { blankLine: 'always', prev: 'var', next: 'return' },
-      { blankLine: 'always', prev: 'var', next: 'block' },
-      { blankLine: 'always', prev: 'block', next: 'return' },
-    ],
-
-    /** Performance Tweaks for ESLint ***/
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/TROUBLESHOOTING.md#eslint-plugin-import
-    indent: 0,
-    '@typescript-eslint/indent': 0,
-    // Disable to increase eslint performance as TypeScript covers its usecase
-    'import/no-named-as-default-member': 0,
-    // Disable to increase eslint performance as TypeScript covers its usecase
-    'import/default': 0,
-    // Allow unverifiable namespaces of imports
-    // Disable to increase eslint performance as TypeScript covers its usecase
-    'import/namespace': 0,
-    // Name imports result sometimes in errors, as type definitions are incomplete
-    // Disable to increase eslint performance as TypeScript covers its usecase
-    'import/named': 0,
-    'import/no-named-as-default': 0,
-
-    /** Additional Rule Tweaks **/
-    'eslint-comments/no-unlimited-disable': 1,
-    // Use node internals and types to check for extraneous imports of dependencies
-    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
-    'import/no-extraneous-dependencies': [
-      'error',
-      { includeInternal: true, includeTypes: true },
-    ],
-
-    /** Prettier Compatibility **/
-    'space-before-function-paren': 0,
-
-    /** Disallowed Imports **/
-    'no-restricted-imports': [
-      'error',
-      // Forbid importing "Lodash" package since it's replaced with "Radash"
-      {
-        paths: [
-          {
-            name: 'lodash',
-            message: 'Usage radash instead of lodash ',
-          },
-        ],
-        patterns: [
-          {
-            group: ['lodash/*', 'lodash-es/*'],
-            message: 'Usage radash instead of lodash',
-          },
-        ],
-      },
-    ],
-  },
-  overrides: [
-    {
-      files: ['*.ts', '*.tsx'],
-      parser: '@typescript-eslint/parser',
-    },
-    {
-      files: ['*.ts', '*.tsx', '*.mts', '*.cts', '*.vue'],
-      rules: {
-        // The rule `no-unused-vars` of `eslint:recommended`
-        // does not work with TypeScripts type definitions.
-        // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md
-        'no-unused-vars': 'off',
-        // https://github.com/typescript-eslint/typescript-eslint/blob/1cf9243/docs/getting-started/linting/FAQ.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
-        'no-undef': 'off',
-        '@typescript-eslint/no-unused-vars': [
-          'error',
-          { varsIgnorePattern: '^_', argsIgnorePattern: '^_' },
-        ],
-      },
-    },
-    {
-      // TypeScript Definitions specific overrides
-      files: ['*.d.ts'],
-      rules: {
-        'import/no-duplicates': 'off',
-      },
-    },
-  ],
-}

package/nuxt/nuxt.cjs

@@ -1,27 +0,0 @@
-/**
- * Shared eslint config for Vue3
- * https://eslint.org/docs/latest/
- *
- */
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: [
-    '../config/eslint-config-vue-base.cjs',
-    'plugin:vue/vue3-recommended',
-  ],
-  rules: {
-    'vue/no-reserved-component-names': 'error',
-  },
-  overrides: [
-    {
-      // Pages and layouts are required to have a single root element if transitions are enabled.
-      // https://github.com/nuxt/eslint-config/blob/main/packages/eslint-config/index.js#L77
-      files: [
-        '**/pages/**/*.{js,ts,jsx,tsx,vue}',
-        '**/layouts/**/*.{js,ts,jsx,tsx,vue}',
-      ],
-      rules: { 'vue/no-multiple-template-root': 'error' },
-    },
-  ],
-}

package/nuxt/nuxt2.cjs

@@ -1,24 +0,0 @@
-/**
- * Shared eslint config for Vue2
- * https://eslint.org/docs/latest/
- *
- */
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: ['../config/eslint-config-vue-base.cjs', 'plugin:vue/recommended'],
-  rules: {
-    'vue/no-reserved-component-names': 'error',
-  },
-  overrides: [
-    {
-      // Pages and layouts are required to have a single root element if transitions are enabled.
-      // https://github.com/nuxt/eslint-config/blob/main/packages/eslint-config/index.js#L77
-      files: [
-        '**/pages/**/*.{js,ts,jsx,tsx,vue}',
-        '**/layouts/**/*.{js,ts,jsx,tsx,vue}',
-      ],
-      rules: { 'vue/no-multiple-template-root': 'error' },
-    },
-  ],
-}