@st1ggy/linter-config 2.41.0 → 3.0.0

package/README.md

@@ -1 +1,71 @@
-# linter-config
+# @st1ggy/linter-config
+
+Shared ESLint, Prettier and Stylelint configs for React, Next.js and Svelte projects.
+
+## Install
+
+```bash
+npm i -D @st1ggy/linter-config
+```
+
+Install only toolchain dependencies you actually use in your project (`eslint`, `prettier`, `stylelint`, framework packages).
+
+This package targets **ESLint 9–10**, **Prettier 3**, and **Stylelint 17**. Install matching majors in the consuming repo.
+
+### Migration (Stylelint)
+
+If you previously used Stylelint 16 with this preset, upgrade the consumer to **Stylelint 17** before depending on the latest release.
+
+### Development of this package
+
+When working on this repository, `npm install` uses [`.npmrc`](.npmrc) `legacy-peer-deps=true` because `eslint-import-resolver-custom-alias` still declares a peer on `eslint-plugin-import@>=2`, so npm may pull the legacy import plugin for resolution even though published presets use **eslint-plugin-import-x**. Consumer projects that only install `@st1ggy/linter-config` are unaffected.
+
+## Toolchain (this repo)
+
+Single entry points for all linters:
+
+```bash
+npm run lint      # eslint → stylelint → prettier --check
+npm run lint:fix  # eslint --fix → stylelint --fix → prettier --write
+```
+
+Individual steps: `npm run lint:eslint`, `npm run lint:stylelint`, `npm run lint:prettier`.
+
+In your application you can mirror the same pattern (sequential or parallel with `npm-run-all` / `concurrently`).
+
+## Tree-shaking friendly imports
+
+Prefer **subpath** imports so only the preset you need is loaded (smaller static import graph for Node and bundlers). The package is published with `sideEffects: false` and explicit `exports` per subpath.
+
+```js
+import eslintReact from '@st1ggy/linter-config/eslint-react'
+import prettierCommon from '@st1ggy/linter-config/prettier-common'
+import stylelintScss from '@st1ggy/linter-config/stylelint-scss'
+```
+
+The root entry re-exports every preset from one module; it is convenient but pulls the combined graph:
+
+```js
+import { eslintReact } from '@st1ggy/linter-config'
+```
+
+Use the root import only when you intentionally want that barrel.
+
+## Optional rule packs (not included by default)
+
+These are common next steps for stricter or more consistent code; add them in your own `eslint.config` if you need them:
+
+- **eslint-plugin-n** — Node.js-specific imports and `package.json` `exports` / `node:` protocol.
+- **eslint-plugin-jsx-a11y** — accessibility rules for React.
+- **eslint-plugin-perfectionist** — opinionated sorting (can overlap with import order / stylistic rules).
+- **typescript-eslint** `recommendedTypeChecked` — stricter type-aware rules (higher cost and stricter `tsconfig` requirements).
+
+## Available Configs
+
+- `@st1ggy/linter-config/eslint-common`
+- `@st1ggy/linter-config/eslint-react`
+- `@st1ggy/linter-config/eslint-next`
+- `@st1ggy/linter-config/eslint-svelte`
+- `@st1ggy/linter-config/prettier-common`
+- `@st1ggy/linter-config/prettier-svelte`
+- `@st1ggy/linter-config/stylelint-scss`

package/index.d.ts

@@ -1,7 +1,21 @@
-import { type ConfigArray } from 'eslint'
+import { type Linter } from 'eslint'
 import { type Config as PrettierConfig } from 'prettier'
 import { type Config as StylelintConfig } from 'stylelint'
 
+type ConfigArray = Linter.Config[]
+
+declare module '@st1ggy/linter-config' {
+  export const eslintCommon: ConfigArray
+  export const eslintReact: ConfigArray
+  export const eslintNext: ConfigArray
+  export const eslintSvelte: ConfigArray
+
+  export const prettierCommon: PrettierConfig
+  export const prettierSvelte: PrettierConfig
+
+  export const stylelintScss: StylelintConfig
+}
+
 declare module '@st1ggy/linter-config/eslint-next' {
   const config: ConfigArray
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@st1ggy/linter-config",
-  "version": "2.41.0",
+  "version": "3.0.0",
   "description": "ESLint, Stylelint and Prettier configs for React, Vue [WIP] and Svelte [WIP]",
   "private": false,
   "repository": {
@@ -19,48 +19,79 @@
   },
   "homepage": "https://github.com/St1ggy/linter-config#readme",
   "dependencies": {
-    "@eslint/compat": "^1.4.1",
-    "@eslint/js": "^9.39.0",
-    "@stylistic/eslint-plugin": "^5.5.0",
-    "@stylistic/eslint-plugin-migrate": "^4.4.1",
-    "eslint": "^9.39.0",
-    "eslint-config-next": "^16.0.1",
+    "@next/eslint-plugin-next": "^16.2.3",
+    "@eslint/compat": "^2.0.5",
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint": "^10.2.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-custom-alias": "^1.3.2",
     "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-sonarjs": "^3.0.5",
-    "eslint-plugin-svelte": "^3.13.0",
-    "eslint-plugin-unicorn": "^62.0.0",
+    "eslint-plugin-sonarjs": "^4.0.2",
+    "eslint-plugin-svelte": "^3.17.0",
+    "eslint-plugin-unicorn": "^64.0.0",
     "find-up-simple": "^1.0.1",
-    "patch-package": "^8.0.1",
-    "prettier": "^3.6.2",
-    "prettier-plugin-svelte": "^3.4.0",
-    "stylelint": "^16.25.0",
-    "stylelint-config-clean-order": "^7.0.0",
-    "stylelint-config-prettier": "^9.0.5",
-    "stylelint-config-recommended": "^17.0.0",
-    "stylelint-config-recommended-scss": "^16.0.2",
-    "stylelint-config-sass-guidelines": "^12.1.0",
-    "stylelint-no-unsupported-browser-features": "^8.0.5",
-    "stylelint-order": "^7.0.0",
+    "prettier": "^3.8.2",
+    "prettier-plugin-svelte": "^3.5.1",
+    "stylelint": "^17.6.0",
+    "stylelint-config-clean-order": "^8.0.1",
+    "stylelint-config-recommended": "^18.0.0",
+    "stylelint-config-recommended-scss": "^17.0.1",
+    "stylelint-config-sass-guidelines": "^13.0.0",
+    "stylelint-no-unsupported-browser-features": "^8.1.1",
+    "stylelint-order": "^8.1.1",
     "stylelint-prettier": "^5.0.3",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.2"
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.1"
   },
+  "types": "./index.d.ts",
   "type": "module",
+  "sideEffects": false,
   "exports": {
-    ".": "./src/index.js",
-    "./eslint-next": "./src/eslint/eslint.config.next.js",
-    "./eslint-react": "./src/eslint/eslint.config.react.js",
-    "./eslint-svelte": "./src/eslint/eslint.config.svelte.js",
-    "./eslint-common": "./src/eslint/eslint.config.common.js",
-    "./prettier-common": "./src/prettier/prettier.config.common.js",
-    "./prettier-svelte": "./src/prettier/prettier.config.svelte.js",
-    "./stylelint-scss": "./src/stylelint/stylelint.config.scss.js"
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./eslint-next": {
+      "types": "./index.d.ts",
+      "import": "./src/eslint/eslint.config.next.js",
+      "default": "./src/eslint/eslint.config.next.js"
+    },
+    "./eslint-react": {
+      "types": "./index.d.ts",
+      "import": "./src/eslint/eslint.config.react.js",
+      "default": "./src/eslint/eslint.config.react.js"
+    },
+    "./eslint-svelte": {
+      "types": "./index.d.ts",
+      "import": "./src/eslint/eslint.config.svelte.js",
+      "default": "./src/eslint/eslint.config.svelte.js"
+    },
+    "./eslint-common": {
+      "types": "./index.d.ts",
+      "import": "./src/eslint/eslint.config.common.js",
+      "default": "./src/eslint/eslint.config.common.js"
+    },
+    "./prettier-common": {
+      "types": "./index.d.ts",
+      "import": "./src/prettier/prettier.config.common.js",
+      "default": "./src/prettier/prettier.config.common.js"
+    },
+    "./prettier-svelte": {
+      "types": "./index.d.ts",
+      "import": "./src/prettier/prettier.config.svelte.js",
+      "default": "./src/prettier/prettier.config.svelte.js"
+    },
+    "./stylelint-scss": {
+      "types": "./index.d.ts",
+      "import": "./src/stylelint/stylelint.config.scss.js",
+      "default": "./src/stylelint/stylelint.config.scss.js"
+    }
   },
   "files": [
     "src",
@@ -68,11 +99,41 @@
     "index.d.ts"
   ],
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:eslint": "eslint .",
+    "lint:stylelint": "stylelint \"**/*.{css,scss}\" --config ./src/stylelint/stylelint.config.scss.js --allow-empty-input",
+    "lint:prettier": "prettier --check .",
+    "lint": "npm run lint:eslint && npm run lint:stylelint && npm run lint:prettier",
+    "lint:fix": "eslint . --fix && stylelint \"**/*.{css,scss}\" --config ./src/stylelint/stylelint.config.scss.js --fix --allow-empty-input && prettier --write ."
   },
   "peerDependencies": {
-    "react": "^19.0.0",
-    "svelte": "^5.23.0"
+    "eslint": "^9.0.0 || ^10.0.0",
+    "next": "^16.0.0",
+    "prettier": "^3.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "stylelint": "^17.0.0",
+    "svelte": "^4.0.0 || ^5.0.0"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin-migrate": "^4.4.1"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    },
+    "prettier": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "stylelint": {
+      "optional": true
+    },
+    "svelte": {
+      "optional": true
+    }
   }
 }

package/src/eslint/configs/config.gitignore.js

@@ -6,4 +6,6 @@ import { fileURLToPath } from 'node:url'
 
 const gitignorePath = findUpSync('.gitignore', { cwd: process.cwd() })
 
-export default defineConfig([includeIgnoreFile(fileURLToPath(new URL(gitignorePath, import.meta.url)))])
+export default defineConfig(
+  gitignorePath ? [includeIgnoreFile(fileURLToPath(new URL(gitignorePath, import.meta.url)))] : [],
+)

package/src/eslint/configs/config.import.js

@@ -1,16 +1,16 @@
 import { defineConfig } from 'eslint/config'
-import importPlugin from 'eslint-plugin-import'
+import { flatConfigs } from 'eslint-plugin-import-x'
 
 import { files } from './constants.js'
 
 export default defineConfig([
-  importPlugin.flatConfigs.recommended,
-  importPlugin.flatConfigs.typescript,
+  flatConfigs.recommended,
+  flatConfigs.typescript,
   {
     files,
     rules: {
-      'import/newline-after-import': 'error',
-      'import/order': [
+      'import-x/newline-after-import': 'error',
+      'import-x/order': [
         'error',
         {
           'newlines-between': 'always',
@@ -28,14 +28,14 @@ export default defineConfig([
           },
         },
       ],
-      'import/no-duplicates': [
+      'import-x/no-duplicates': [
         'error',
         {
           considerQueryString: true,
         },
       ],
-      'import/prefer-default-export': 'off',
-      'import/extensions': [
+      'import-x/prefer-default-export': 'off',
+      'import-x/extensions': [
         'error',
         'never',
         {
@@ -43,10 +43,10 @@ export default defineConfig([
           json: 'ignorePackages',
         },
       ],
-      'import/no-unresolved': ['error', {}],
+      'import-x/no-unresolved': ['error', {}],
     },
     settings: {
-      'import/resolver': {
+      'import-x/resolver': {
         typescript: true,
         node: true,
       },

package/src/eslint/configs/config.next.js

@@ -1,8 +1,11 @@
+/* eslint-disable import-x/no-named-as-default-member -- @next/eslint-plugin-next is CJS; no ESM named export for configs */
 import nextPlugin from '@next/eslint-plugin-next'
 import { defineConfig } from 'eslint/config'
 
 import { files } from './constants.js'
 
+const { configs: nextConfigs } = nextPlugin
+
 export default defineConfig([
   {
     files,
@@ -10,8 +13,8 @@ export default defineConfig([
       '@next/next': nextPlugin,
     },
     rules: {
-      ...nextPlugin.configs.recommended.rules,
-      ...nextPlugin.configs['core-web-vitals'].rules,
+      ...nextConfigs.recommended.rules,
+      ...nextConfigs['core-web-vitals'].rules,
     },
   },
 ])

package/src/eslint/configs/config.react.js

@@ -1,4 +1,3 @@
-import stylistic from '@stylistic/eslint-plugin'
 import { defineConfig } from 'eslint/config'
 import reactPlugin from 'eslint-plugin-react'
 import reactHooksPlugin from 'eslint-plugin-react-hooks'
@@ -8,7 +7,6 @@ import { files } from './constants.js'
 export default defineConfig([
   reactPlugin.configs.flat.recommended,
   reactPlugin.configs.flat['jsx-runtime'],
-  stylistic.configs.recommended,
   {
     files,
     plugins: { 'react-hooks': reactHooksPlugin },

package/src/eslint/configs/config.svelte.js

@@ -11,8 +11,8 @@ export default defineConfig([
   {
     files,
     rules: {
-      'import/named': 'off',
-      'import/no-cycle': 'off',
+      'import-x/named': 'off',
+      'import-x/no-cycle': 'off',
     },
     languageOptions: {
       parserOptions: {
@@ -23,11 +23,11 @@ export default defineConfig([
       },
     },
     settings: {
-      // 'import/parsers': {
+      // 'import-x/parsers': {
       //   'svelte-eslint-parser': ['.svelte'],
       //   espree: extensions,
       // },
-      'import/resolver': {
+      'import-x/resolver': {
         'eslint-import-resolver-custom-alias': {
           alias: {
             $lib: 'src/lib',

package/src/eslint/eslint.config.next.js

@@ -1,4 +1,4 @@
-import nextConfig from './eslint.config.next.js'
+import nextConfig from './configs/config.next.js'
 import reactConfig from './eslint.config.react.js'
 
 export default [...reactConfig, ...nextConfig]

package/src/examples/example.ts

@@ -1 +1 @@
-export {}
+export const example = true

package/scripts/patch.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-npx patch-package --patch-dir "$(dirname "$0")/../patches"