@frefly/cspell-config 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,85 @@
-# Temporary Holding Version
+# @frefly/cspell-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.
+前端 CSpell 共享配置，用于单词拼写检查。
+
+## 安装
+
+```bash
+pnpm add -D @frefly/cspell-config @cspell/dict-lorem-ipsum@4.0.5 cspell@10.4.1
+```
+
+## 使用
+
+### 使用默认配置
+
+#### 步骤一：创建配置文件
+
+在项目根目录创建 `cspell.config.js`：
+
+```js
+import { createConfig } from '@frefly/cspell-config'
+
+export default createConfig()
+```
+
+#### 步骤二：创建自定义词典
+
+在项目根目录创建 `.cspell/custom-words.txt` 文件，用于存放项目自定义词汇（每行一个单词）：
+
+```
+frefly
+vitepress
+```
+
+当 CSpell 遇到未知单词时，可将其添加到此文件中，避免误报。
+
+#### 步骤三：添加拼写检查脚本
+
+在 `package.json` 中添加：
+
+```json
+{
+  "scripts": {
+    "spellcheck": "cspell lint --dot --gitignore --color --cache --show-suggestions \"src/**/*.{js,ts,vue,json,md}\""
+  }
+}
+```
+
+#### 步骤四：运行检查
+
+```bash
+pnpm spellcheck
+```
+
+#### 步骤五：配合 IDE 使用
+
+安装 VS Code Code Spell Checker 扩展（`streetsidesoftware.code-spell-checker`），实时显示拼写错误。
+
+### 添加忽略路径
+
+通过 `ignorePaths` 选项忽略不需要检查的文件或目录：
+
+```js
+import { createConfig } from '@frefly/cspell-config'
+
+export default createConfig({
+  ignorePaths: ['src/generated/**', '**/*.min.js']
+})
+```
+
+## 默认配置
+
+- 引入 `@cspell/dict-lorem-ipsum` 词典
+- 大小写不敏感（`caseSensitive: false`）
+- 自定义词典指向 `.cspell/custom-words.txt`，且开启 `addWords` 自动添加
+- 默认忽略 `node_modules`、`dist`、`.turbo`、`docs`、`__tests__`、`coverage`
+
+## API
+
+### `createConfig(options?)`
+
+创建 CSpell 配置对象。
+
+| 参数          | 类型       | 默认值 | 说明         |
+| ------------- | ---------- | ------ | ------------ |
+| `ignorePaths` | `string[]` | `[]`   | 额外忽略路径 |

package/index.js

@@ -0,0 +1,33 @@
+/**
+ * 创建 CSpell 配置
+ * @param {object} [options]
+ * @param {string[]} [options.ignorePaths] - 额外的忽略路径
+ * @returns {import('cspell').CSpellSettings}
+ */
+export function createConfig(options = {}) {
+  const { ignorePaths = [] } = options
+
+  return {
+    import: ['@cspell/dict-lorem-ipsum/cspell-ext.json'], // 排除 lorem ipsum 占位文本的拼写误报
+    caseSensitive: false,
+    dictionaries: ['custom-words'],
+    dictionaryDefinitions: [
+      {
+        name: 'custom-words',
+        path: './.cspell/custom-words.txt',
+        addWords: true
+      }
+    ],
+    ignorePaths: [
+      '**/node_modules/**',
+      '**/dist/**',
+      '**/.turbo/**',
+      '**/docs/**',
+      '**/__tests__/**',
+      '**/coverage/**',
+      ...ignorePaths
+    ] // package.json 中常含非标准拼写
+  }
+}
+
+export default createConfig()

package/package.json

@@ -1,6 +1,28 @@
 {
   "name": "@frefly/cspell-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "description": "前端 CSpell 共享配置",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@cspell/dict-lorem-ipsum": "4.0.5",
+    "cspell": "10.4.1"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "scripts": {
+    "release": "pnpm publish --no-git-checks"
+  }
 }