@frefly/eslint-config 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,97 @@
-# Temporary Holding Version
+# @frefly/eslint-config
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+前端 ESLint 共享配置，目前提供 uni-app Vue 3 预设。
+
+## 安装
+
+```bash
+pnpm add -D @frefly/eslint-config eslint@10.14.0 @eslint/js@10.0.1 globals@17.14.0 eslint-plugin-simple-import-sort@14.0.0 eslint-plugin-vue@10.12.1 vue-eslint-parser@10.4.2 eslint-config-prettier@10.1.8
+```
+
+## 使用
+
+### 步骤一：创建配置文件
+
+在项目根目录创建 `eslint.config.js`：
+
+```js
+import { createConfig } from '@frefly/eslint-config'
+
+export default createConfig({
+  ignores: ['some/path/to/ignore']
+})
+```
+
+也可以直接使用默认导出的配置：
+
+```js
+export { default } from '@frefly/eslint-config'
+```
+
+### 步骤二：添加 lint 脚本
+
+在 `package.json` 中添加：
+
+```json
+{
+  "scripts": {
+    "lint": "eslint \"src/**/*.{js,vue}\""
+  }
+}
+```
+
+### 步骤三：运行检查
+
+```bash
+pnpm lint
+```
+
+### 步骤四：配合 IDE 使用
+
+安装 VS Code ESLint 扩展（`dbaeumer.vscode-eslint`），保存时自动修复：
+
+```json
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  }
+}
+```
+
+## 配置说明
+
+配置基于 `@eslint/js` 推荐规则和 `eslint-plugin-vue` 的 `flat/recommended` 预设，仅作用于 `**/*.{js,vue}` 文件，并关闭与 Prettier 冲突的格式规则（通过 `eslint-config-prettier`）。
+
+关键规则：
+
+- `no-console: error` — 禁止 console 语句
+- `no-debugger: error` — 禁止 debugger 语句
+- `no-var: error` — 禁止 var 声明
+- `no-unused-vars: error` — 禁止未使用变量
+- `no-undef: error` — 禁止使用未声明变量
+- `eqeqeq: error` — 必须使用全等
+- `prefer-const: error` — 优先使用 const
+- `camelcase: error` — 强制驼峰命名
+- `vue/no-v-html: off` — 允许 v-html，业务中富文本渲染常见
+- `vue/no-v-text-v-html-on-component: off` — 组件上允许 v-html
+- `vue/multi-word-component-names: off` — 允许单词组件名（如 App、Layout）
+- `simple-import-sort/exports: error` — 导出成员自动排序
+- `simple-import-sort/imports` — 自定义分组排序：Node 内置模块 → @scoped → @/路径 → 副作用导入 → 父级 → 同级
+
+全局变量包含 `browser` + `node` + uni-app 变量（`uni`、`wx`、`getCurrentPages`、`getApp`、`UniApp`，均 `readonly`）。
+
+默认忽略目录：`node_modules`、`dist`、`.turbo`、`docs`、`types`、`__tests__`、`coverage`、`static`。
+
+## API
+
+### `createConfig(options?)`
+
+创建 uni-app Vue 3 ESLint flat config，返回 `Linter.Config[]`。
+
+| 参数      | 类型       | 默认值 | 说明         |
+| --------- | ---------- | ------ | ------------ |
+| `ignores` | `string[]` | `[]`   | 额外忽略路径 |
+
+### 默认导出
+
+`createConfig()` 的默认结果，等价于不带额外忽略项的配置。

package/index.js

@@ -0,0 +1,85 @@
+import importSort from 'eslint-plugin-simple-import-sort'
+import pluginVue from 'eslint-plugin-vue'
+import globals from 'globals'
+
+import js from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+
+const uniappGlobals = {
+  uni: 'readonly',
+  wx: 'readonly',
+  getCurrentPages: 'readonly',
+  getApp: 'readonly',
+  UniApp: 'readonly'
+}
+
+/**
+ * 创建 uniapp Vue 3 ESLint flat config
+ * @param {object} [options]
+ * @param {string[]} [options.ignores] - 忽略路径列表
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createConfig(options = {}) {
+  const { ignores = [] } = options
+
+  return [
+    js.configs.recommended,
+    ...pluginVue.configs['flat/recommended'],
+    {
+      files: ['**/*.{js,vue}'],
+      rules: {
+        'no-console': 'error',
+        'no-debugger': 'error',
+        'no-var': 'error',
+        'no-unused-vars': 'error',
+        'prefer-const': 'error',
+        eqeqeq: 'error',
+        camelcase: 'error',
+        'no-undef': 'error',
+        'vue/no-v-html': 'off',
+        'vue/no-v-text-v-html-on-component': 'off',
+        'vue/multi-word-component-names': 'off',
+        'simple-import-sort/exports': 'error',
+        'simple-import-sort/imports': [
+          'error',
+          {
+            groups: [
+              ['^\\w'], // Node 内置模块（如 fs, path）
+              ['^@\\w'], // @scoped 外部包（如 @vue/runtime-core）
+              ['^@/'], // 项目别名路径（如 @/utils）
+              ['^\\u0000'], // 副作用导入（如 import 'reset.css'）
+              ['^\\.\\.(?!/?$)', '^\\.\\./?$'], // 父级相对路径
+              ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'] // 同级相对路径
+            ]
+          }
+        ]
+      },
+      languageOptions: {
+        globals: {
+          ...globals.browser, // Vue 运行在浏览器环境
+          ...globals.node, // 构建工具（Vite）运行在 Node 环境
+          ...uniappGlobals // uniapp 全局变量
+        }
+      },
+      plugins: {
+        'simple-import-sort': importSort
+      }
+    },
+    {
+      ignores: [
+        '**/node_modules/**',
+        '**/dist/**',
+        '**/.turbo/**',
+        '**/docs/**',
+        '**/types/**',
+        '**/__tests__/**',
+        '**/coverage/**',
+        '**/static/**',
+        ...ignores
+      ]
+    },
+    prettier
+  ]
+}
+
+export default createConfig()

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@frefly/eslint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "前端 ESLint 共享配置",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@eslint/js": "10.0.1",
+    "eslint": "10.14.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-simple-import-sort": "14.0.0",
+    "eslint-plugin-vue": "10.12.1",
+    "vue-eslint-parser": "10.4.2",
+    "globals": "17.14.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.22.1"
+  },
+  "scripts": {
+    "release": "pnpm publish --no-git-checks"
+  }
 }