@lzear/eslint-config 4.0.3 → 4.1.1

package/README.md

@@ -0,0 +1,101 @@
+# @lzear/eslint-config
+
+[![npm](https://img.shields.io/npm/v/@lzear/eslint-config)](https://www.npmjs.com/package/@lzear/eslint-config)
+[![license](https://img.shields.io/npm/l/@lzear/eslint-config)](../../LICENSE)
+
+Shared ESLint flat config for lzear repos. Includes rules for TypeScript, React, Node, Vitest, imports, accessibility, and more.
+
+## Install
+
+```sh
+npm install -D @lzear/eslint-config eslint
+# or
+yarn add -D @lzear/eslint-config eslint
+```
+
+Requires Node ≥ 20, ESLint ≥ 9.
+
+## Usage
+
+**Minimal `eslint.config.ts`:**
+
+```ts
+import lzearConfig from '@lzear/eslint-config'
+
+export default await lzearConfig()
+```
+
+**With options** — disable feature sets you don't use:
+
+```ts
+import lzearConfig from '@lzear/eslint-config'
+
+export default await lzearConfig({
+  react: false,   // not a React project
+  vitest: false,  // no tests
+})
+```
+
+| Option       | Default | Description                              |
+|--------------|---------|------------------------------------------|
+| `typescript` | `true`  | TypeScript rules via `typescript-eslint` |
+| `react`      | `true`  | React, hooks, a11y, compiler rules       |
+| `node`       | `true`  | Node.js rules via `eslint-plugin-n`      |
+| `vitest`     | `true`  | Vitest rules via `@vitest/eslint-plugin` |
+
+**Extend with extra rules, overrides, and ignores:**
+
+```ts
+import type { Linter } from 'eslint'
+import lzearConfig from '@lzear/eslint-config'
+
+const base = await lzearConfig({ react: false })
+
+const config: Linter.Config[] = [
+  ...base,
+
+  // Extra rules applied to all files
+  {
+    rules: {
+      'no-console': 'error',
+      'unicorn/filename-case': ['error', { case: 'kebabCase' }],
+    },
+  },
+
+  // Turn off or downgrade specific rules
+  {
+    rules: {
+      'sonarjs/cognitive-complexity': 'off',
+      'import-x/order': 'warn',
+    },
+  },
+
+  // Override rules for specific files
+  {
+    files: ['scripts/**/*.ts'],
+    rules: {
+      'no-console': 'off',
+      'unicorn/no-process-exit': 'off',
+    },
+  },
+
+  // Ignore generated files and specific folders
+  {
+    ignores: [
+      'src/generated/**',
+      'public/**',
+      '**/*.min.js',
+    ],
+  },
+]
+
+export default config
+```
+
+## Included plugins
+
+`@eslint/js` · `typescript-eslint` · `eslint-plugin-unicorn` · `eslint-plugin-sonarjs` · `eslint-plugin-import-x` · `eslint-plugin-promise` · `eslint-plugin-regexp` · `eslint-plugin-react` · `eslint-plugin-react-hooks` · `eslint-plugin-jsx-a11y` · `eslint-plugin-n` · `@vitest/eslint-plugin` · `eslint-plugin-package-json` · `eslint-config-prettier` · and more.
+
+## Part of forge
+
+This package is part of [forge](https://github.com/lzear/forge) — shared dev tooling for lzear repos.

package/dist/index.d.ts

@@ -5,6 +5,7 @@ interface ConfigOptions {
     react: boolean;
     typescript: boolean;
     vitest: boolean;
+    local?: string;
 }
 declare const configGenerator: (options?: Partial<ConfigOptions>) => Promise<Linter.Config[]>;
 

package/dist/index.js

@@ -23,11 +23,13 @@ var a11y = (config) => {
 // configs/core.ts
 import js from "@eslint/js";
 import eslintCommentsPlugin from "@eslint-community/eslint-plugin-eslint-comments";
+import stylistic from "@stylistic/eslint-plugin";
 import deMorganPlugin from "eslint-plugin-de-morgan";
 import importXPlugin from "eslint-plugin-import-x";
 import preferArrowPlugin from "eslint-plugin-prefer-arrow";
 import promisePlugin from "eslint-plugin-promise";
 import regexpPlugin from "eslint-plugin-regexp";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
 import sonarjsPlugin from "eslint-plugin-sonarjs";
 import unicornPlugin from "eslint-plugin-unicorn";
 import globals from "globals";
@@ -237,7 +239,8 @@ var plugin = {
 };
 
 // configs/core.ts
-var core = () => {
+var core = (local) => {
+  const l = local?.replaceAll(/[$()*+.?[\\\]^{|}]/g, String.raw`\$&`);
   const files = [
     "**/*.js",
     "**/*.cjs",
@@ -254,15 +257,33 @@ var core = () => {
     ...eslintCommentsPlugin.configs.recommended.rules,
     "@eslint-community/eslint-comments/disable-enable-pair": 0,
     "@eslint-community/eslint-comments/no-unlimited-disable": 0,
+    ...stylistic.configs.recommended.rules,
+    "@stylistic/arrow-parens": 0,
+    "@stylistic/brace-style": 0,
+    "@stylistic/jsx-self-closing-comp": [2, { component: true, html: true }],
     ...deMorganPlugin.configs.recommended.rules,
     ...importXPlugin.configs.recommended.rules,
+    "import-x/newline-after-import": 2,
+    "import-x/no-duplicates": [2, { "prefer-inline": true }],
+    "import-x/no-extraneous-dependencies": 2,
     "import-x/no-named-as-default-member": 0,
+    "import-x/no-relative-packages": 2,
     "import-x/no-unresolved": 0,
-    "import-x/order": [
+    "import-x/order": 0,
+    "simple-import-sort/exports": 2,
+    "simple-import-sort/imports": [
       2,
       {
-        alphabetize: { order: "asc", orderImportKind: "asc" },
-        "newlines-between": "never"
+        groups: [
+          [
+            "^node:",
+            l && String.raw`^@?(?!` + l + String.raw`\/)\w`,
+            l && String.raw`^@` + l + String.raw`\/`,
+            "^",
+            String.raw`^\.`,
+            String.raw`^.+\.s?css$`
+          ].filter(Boolean)
+        ]
       }
     ],
     "lzear/prefer-relative-imports": 2,
@@ -277,9 +298,17 @@ var core = () => {
     ...promisePlugin.configs.recommended.rules,
     ...regexpPlugin.configs.recommended.rules,
     ...sonarRules,
+    "sonarjs/argument-type": 0,
+    // ?
     "sonarjs/fixme-tag": 0,
+    "sonarjs/function-return-type": 0,
+    // ?
+    "sonarjs/jsx-no-leaked-render": 0,
+    // false positives (not checking types)
     "sonarjs/no-invariant-returns": 0,
     // annoying
+    "sonarjs/no-nested-conditional": 0,
+    // unnecessary
     "sonarjs/no-os-command-from-path": 0,
     // annoying
     "sonarjs/os-command": 0,
@@ -310,12 +339,14 @@ var core = () => {
     },
     plugins: {
       "@eslint-community/eslint-comments": eslintCommentsPlugin,
+      "@stylistic": stylistic,
       "de-morgan": deMorganPlugin,
       "import-x": importXPlugin,
       lzear: plugin,
       "prefer-arrow": preferArrowPlugin,
       promise: promisePlugin,
       regexp: regexpPlugin,
+      "simple-import-sort": simpleImportSort,
       sonarjs: sonarjsPlugin,
       unicorn: unicornPlugin
     },
@@ -435,7 +466,6 @@ var react = async (config) => {
     reactHooksPlugin,
     reactPerfPlugin,
     reactPlugin,
-    nextPlugin,
     reactXPlugin,
     reactDomPlugin,
     reactWebApiPlugin
@@ -444,7 +474,6 @@ var react = async (config) => {
     interopDefault(import("eslint-plugin-react-hooks")),
     interopDefault(import("eslint-plugin-react-perf")),
     interopDefault(import("eslint-plugin-react")),
-    interopDefault(import("@next/eslint-plugin-next")),
     interopDefault(import("eslint-plugin-react-x")),
     interopDefault(import("eslint-plugin-react-dom")),
     interopDefault(import("eslint-plugin-react-web-api"))
@@ -457,7 +486,6 @@ var react = async (config) => {
     name: "lzear/react",
     files,
     plugins: {
-      "@next/next": nextPlugin,
       react: reactPlugin,
       "react-compiler": reactCompilerPlugin,
       "react-dom": reactDomPlugin,
@@ -473,10 +501,8 @@ var react = async (config) => {
       "react-perf/jsx-no-new-function-as-prop": 0,
       "react-perf/jsx-no-new-object-as-prop": 0,
       ...reactPlugin.configs.recommended.rules,
-      ...nextPlugin.configs.recommended.rules,
-      ...nextPlugin.configs["core-web-vitals"].rules,
       "react/react-in-jsx-scope": 0,
-      "react/no-unknown-property": ["error", { ignore: ["jsx", "global"] }],
+      "react/no-unknown-property": [2, { ignore: ["jsx", "global"] }],
       ...config.typescript ? reactXPlugin.configs["recommended-typescript"].rules : reactXPlugin.configs.recommended.rules,
       ...reactDomPlugin.configs.recommended.rules,
       ...reactWebApiPlugin.configs.recommended.rules
@@ -517,6 +543,10 @@ var typescript = async (config) => {
     ],
     files,
     rules: {
+      "@typescript-eslint/no-misused-promises": [
+        2,
+        { checksVoidReturn: { attributes: false } }
+      ],
       "@typescript-eslint/no-unnecessary-condition": [
         2,
         { allowConstantLoopConditions: "only-allowed-literals" }
@@ -607,7 +637,7 @@ var configGenerator = async (options = {}) => {
   ]);
   return [
     { name: "lzear/ignores", ignores },
-    core(),
+    core(config.local),
     a11y(config),
     reactConfig,
     nodeConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lzear/eslint-config",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Shared ESLint flat config for lzear repos",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4",
     "@eslint/js": "^9",
-    "@next/eslint-plugin-next": "^16",
+    "@stylistic/eslint-plugin": "^5",
     "@vitest/eslint-plugin": "^1",
     "eslint-config-prettier": "^10",
     "eslint-import-resolver-typescript": "^4",
@@ -37,7 +37,7 @@
     "eslint-plugin-de-morgan": "^2",
     "eslint-plugin-import-x": "^4",
     "eslint-plugin-jsx-a11y": "^6",
-    "eslint-plugin-n": "^17",
+    "eslint-plugin-n": "^18",
     "eslint-plugin-package-json": "^0.91",
     "eslint-plugin-prefer-arrow": "^1",
     "eslint-plugin-prettier": "^5",
@@ -50,6 +50,7 @@
     "eslint-plugin-react-web-api": "^5",
     "eslint-plugin-react-x": "^5",
     "eslint-plugin-regexp": "^3",
+    "eslint-plugin-simple-import-sort": "^13",
     "eslint-plugin-sonarjs": "^4",
     "eslint-plugin-unicorn": "^64",
     "globals": "^17",
@@ -58,7 +59,7 @@
     "typescript-eslint": "^8"
   },
   "devDependencies": {
-    "@lzear/configs": "4.0.3",
+    "@lzear/configs": "workspace:*",
     "@vitest/coverage-v8": "^4",
     "eslint": "^9",
     "tsup": "^8",
@@ -74,4 +75,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}