@icebreakers/eslint-config 1.5.2 → 1.5.3

package/README.md

@@ -1,45 +1,102 @@
 # @icebreakers/eslint-config
 
-> extend [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config) and add `tailwindcss` , `mdx` , and `prettier` format support!
+- [简体中文指南](./README.zh.md)
 
-## Usage
+## Overview
+
+`@icebreakers/eslint-config` extends the `@antfu/eslint-config` flat presets and layers extra rules for Tailwind CSS, MDX, Vue accessibility, and Icebreaker specific TypeScript defaults. It returns a `FlatConfigComposer`, so you can opt into only the presets you need and keep adding workspace specific overrides.
+
+## Requirements
+
+- Node.js 18 or newer
+- ESLint 9 with flat config support
+- Install optional peer plugins when you turn on Tailwind (`eslint-plugin-tailwindcss` or `eslint-plugin-better-tailwindcss`), MDX (`eslint-plugin-mdx`), or UnoCSS (`@unocss/eslint-plugin`)
+
+## Installation
 
 ```bash
-pnpm i -D eslint @icebreakers/eslint-config
+pnpm add -D eslint @icebreakers/eslint-config
 ```
 
+## Quick Start
+
+Create `eslint.config.ts` (or `.mjs`) in your project root:
+
 ```ts
-// eslint.config.mjs
 import { icebreaker } from '@icebreakers/eslint-config'
 
 export default icebreaker()
 ```
 
-`icebreaker()` returns a `FlatConfigComposer`, so you can opt into extra presets by passing the options documented below and still append workspace-specific rules.
+Run ESLint via your package manager:
+
+```bash
+pnpm eslint "src/**/*.ts"
+```
+
+If you need the legacy array config, call `icebreakerLegacy()` instead.
+
+## Enabling Presets
 
-## Available options
+Each optional preset mirrors the flags in `@antfu/eslint-config` and adds Icebreaker tweaks:
 
 ```ts
 import { icebreaker } from '@icebreakers/eslint-config'
 
 export default icebreaker({
-  vue: true,
+  vue: true, // or { vueVersion: 2 }
+  react: true,
   typescript: true,
+  test: true,
   tailwindcss: {
     tailwindConfig: './tailwind.config.ts',
   },
-  mdx: process.env.ENABLE_MDX === 'true',
-  a11y: true, // load JSX + Vue accessibility helpers
+  mdx: process.env.LINT_MDX === 'true',
+  a11y: true,
+  nestjs: true,
+  ionic: true,
+  weapp: true,
+  formatters: true,
 })
 ```
 
-- `tailwindcss` – enable Tailwind presets (`true`) or provide entry paths for Tailwind v3/v4.
-- `mdx` – enable linting for `.mdx` files with Remark-powered processors.
-- `a11y` – adds accessibility rules for whichever of `vue`/`react` you enable via @antfu.
-- `vue`, `typescript`, `javascript`, `test` – extend the upstream `@antfu/eslint-config` options; the defaults bundle stricter unused checks and Vue fixes for Ionic/Weapp projects.
+- `vue` – enables Vue + optionally version specific overrides (Vue 2/3) and ionic/weapp adjustments.
+- `react` – defers to the upstream React preset and unlocks accessibility helpers when `a11y` is enabled.
+- `tailwindcss` – pass `true` to use the built-in Tailwind flat config or provide `{ entryPoint, tailwindConfig }` for Tailwind v4/v3 projects.
+- `mdx` – activates MDX linting via `eslint-plugin-mdx`.
+- `a11y` – wires in JSX (React) and Vue accessibility plugins.
+- `typescript` – extends the TypeScript preset and applies stricter unused diagnostics plus NestJS conveniences when `nestjs` is true.
+- `formatters` – keeps the built-in formatting rules enabled by default.
+- `test` – relaxes certain Vitest/Jest style rules (`test/prefer-lowercase-title`).
+
+## Adding Extra Config Items
+
+Because `icebreaker()` returns a composer you can append overrides:
+
+```ts
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker(
+  { typescript: true },
+  {
+    files: ['*.vue'],
+    rules: {
+      'vue/no-undef-components': 'off',
+    },
+  },
+)
+```
+
+You may also pass other flat configs (e.g. from in-house presets) as additional arguments.
+
+## IDE Integration
 
-## VS Code support
+- Install the VS Code ESLint extension (`>=3.0.10`).
+- Set `"eslint.experimental.useFlatConfig": true` for older VS Code builds.
+- Use `pnpm lint -- --fix` in a pre-commit hook for consistent formatting.
 
-Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+## Troubleshooting
 
-Version: ( >=`3.0.10`)
+- Missing plugin errors usually mean the optional dependency is not installed in the current workspace. Add it with `pnpm add -D`.
+- When combining legacy `.eslintrc` projects, prefer `icebreakerLegacy()` and move overrides into flat config format incrementally.
+- Tailwind class validation reads from your `tailwind.config.*`; double check the path when using monorepo roots or custom build tooling.

package/README.zh.md

@@ -0,0 +1,100 @@
+# @icebreakers/eslint-config
+
+## 简介
+
+`@icebreakers/eslint-config` 基于 `@antfu/eslint-config` 的 flat config 预设，额外补充了 Tailwind CSS、MDX、Vue 无障碍以及 Icebreaker 团队常用的 TypeScript 默认规则。它返回一个 `FlatConfigComposer`，可以按需启用不同预设，并继续追加工作区特定的覆盖项。
+
+## 环境要求
+
+- Node.js 18 或更高版本
+- 支持 Flat Config 的 ESLint 9
+- 如需启用 Tailwind、MDX、UnoCSS 等，可安装对应的可选依赖：`eslint-plugin-tailwindcss` / `eslint-plugin-better-tailwindcss`、`eslint-plugin-mdx`、`@unocss/eslint-plugin`
+
+## 安装
+
+```bash
+pnpm add -D eslint @icebreakers/eslint-config
+```
+
+## 快速上手
+
+在项目根目录创建 `eslint.config.ts`（或 `.mjs`）：
+
+```ts
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker()
+```
+
+使用包管理器运行 ESLint：
+
+```bash
+pnpm eslint "src/**/*.ts"
+```
+
+如果仍需兼容旧的 `.eslintrc` 流程，可改用 `icebreakerLegacy()`。
+
+## 启用可选预设
+
+所有可选项与 `@antfu/eslint-config` 保持一致，并叠加 Icebreaker 的调整：
+
+```ts
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker({
+  vue: true, // 或 { vueVersion: 2 }
+  react: true,
+  typescript: true,
+  test: true,
+  tailwindcss: {
+    tailwindConfig: './tailwind.config.ts',
+  },
+  mdx: process.env.LINT_MDX === 'true',
+  a11y: true,
+  nestjs: true,
+  ionic: true,
+  weapp: true,
+  formatters: true,
+})
+```
+
+- `vue`：启用 Vue 规则，可根据 Vue 2/3 自动切换，并在 `ionic`、`weapp` 选项开启时追加对应覆盖。
+- `react`：复用上游 React 预设，配合 `a11y` 注入无障碍插件。
+- `tailwindcss`：传入 `true` 使用内置 Tailwind flat 配置，或通过对象指定 Tailwind v4 的入口文件 / v3 的配置文件路径。
+- `mdx`：激活 `eslint-plugin-mdx` 处理 `.mdx` 文件。
+- `a11y`：按需引入 JSX 与 Vue 的无障碍规则。
+- `typescript`：开启 TypeScript 预设，并在 `nestjs` 为 `true` 时放宽 NestJS 场景常见限制。
+- `formatters`：默认启用格式化辅助规则。
+- `test`：放宽 Vitest / Jest 常见规则，例如关闭 `test/prefer-lowercase-title`。
+
+## 追加自定义配置
+
+`icebreaker()` 返回的 composer 支持继续拼接 Flat Config：
+
+```ts
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker(
+  { typescript: true },
+  {
+    files: ['*.vue'],
+    rules: {
+      'vue/no-undef-components': 'off',
+    },
+  },
+)
+```
+
+亦可追加其它第三方或内部预设，统一合并。
+
+## IDE 集成
+
+- VS Code 安装 ESLint 扩展（版本需 ≥ 3.0.10）。
+- 老版本 VS Code 需在设置中启用 `"eslint.experimental.useFlatConfig": true`。
+- 在 Git 钩子或 CI 中执行 `pnpm lint -- --fix` 确保格式一致。
+
+## 常见问题
+
+- 如果提示缺少插件，说明当前工作区未安装对应可选依赖，可通过 `pnpm add -D` 补齐。
+- 与旧版 `.eslintrc` 混用时建议先改用 `icebreakerLegacy()`，逐步迁移至 Flat Config。
+- Tailwind 校验依赖 `tailwind.config.*`，Monorepo 或自定义构建路径时请确认配置文件位置。

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "@icebreakers/eslint-config",
   "type": "module",
-  "version": "1.5.2",
-  "description": "icebreakers's eslint config",
+  "version": "1.5.3",
+  "description": "ESLint preset from Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sonofmagic/eslint-config.git",
-    "directory": "packages/icebreaker"
+    "url": "git+https://github.com/sonofmagic/dev-configs.git",
+    "directory": "packages/eslint"
   },
   "bugs": {
-    "url": "https://github.com/sonofmagic/eslint-config/issues"
+    "url": "https://github.com/sonofmagic/dev-configs/issues"
   },
   "keywords": [
+    "dev-configs",
     "eslint-config",
     "icebreaker"
   ],
@@ -42,12 +43,12 @@
   "dependencies": {
     "@antfu/eslint-config": "6.0.0",
     "@eslint-react/eslint-plugin": "^2.2.2",
-    "@next/eslint-plugin-next": "^15.5.5",
+    "@next/eslint-plugin-next": "^15.5.6",
     "eslint-plugin-better-tailwindcss": "^3.7.10",
     "eslint-plugin-format": "1.0.2",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react-hooks": "^7.0.0",
-    "eslint-plugin-react-refresh": "^0.4.23",
+    "eslint-plugin-react-refresh": "^0.4.24",
     "eslint-plugin-tailwindcss": "3.18.2",
     "eslint-plugin-vuejs-accessibility": "^2.4.1"
   },