@lzear/eslint-config 4.0.2 → 4.1.0

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.js

@@ -409,6 +409,7 @@ var packageJson = () => ({
 });
 
 // configs/prettier.ts
+import "eslint";
 import prettierConfig from "eslint-plugin-prettier/recommended";
 var prettier = {
   ...prettierConfig,
@@ -434,7 +435,6 @@ var react = async (config) => {
     reactHooksPlugin,
     reactPerfPlugin,
     reactPlugin,
-    nextPlugin,
     reactXPlugin,
     reactDomPlugin,
     reactWebApiPlugin
@@ -443,7 +443,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"))
@@ -456,7 +455,6 @@ var react = async (config) => {
     name: "lzear/react",
     files,
     plugins: {
-      "@next/next": nextPlugin,
       react: reactPlugin,
       "react-compiler": reactCompilerPlugin,
       "react-dom": reactDomPlugin,
@@ -472,8 +470,6 @@ 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"] }],
       ...config.typescript ? reactXPlugin.configs["recommended-typescript"].rules : reactXPlugin.configs.recommended.rules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lzear/eslint-config",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Shared ESLint flat config for lzear repos",
   "repository": {
     "type": "git",
@@ -29,7 +29,6 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4",
     "@eslint/js": "^9",
-    "@next/eslint-plugin-next": "^16",
     "@vitest/eslint-plugin": "^1",
     "eslint-config-prettier": "^10",
     "eslint-import-resolver-typescript": "^4",
@@ -58,7 +57,7 @@
     "typescript-eslint": "^8"
   },
   "devDependencies": {
-    "@lzear/configs": "4.0.2",
+    "@lzear/configs": "4.1.0",
     "@vitest/coverage-v8": "^4",
     "eslint": "^9",
     "tsup": "^8",