SuperAPI AI 工具集

cspell

编程与开发

查看项目

更新于 10-16 08:40

技能介绍

用途:该技能面向 cspell 拼写检查器产生的未知单词警告,帮助在 IDE 诊断或 CI 输出中定位并修复拼写问题,也可用于为项目首次引入 cspell 配置。

主要能力:先检查仓库是否已有 cspell 配置,再按优先级选择修复策略。优先级依次为:调整文本(如安全地改为连字符或驼峰形式)、加入项目词典(适用于跨两个以上文件或项目内反复出现的词)、使用内联指令(适用于单文件单次出现的词)。支持引导式问答流程为无配置的项目初始化 cspell,并涉及 CI 集成与初始化后调整。

使用方式:从文件所在目录向上查找配置,包括 package.json 的 cspell 字段、.cspell.json、cspell.json、cspell.config.{json,mjs,js,cjs,yaml,yml,toml}、cspell.{yaml,yml} 及其 ./.config/ 前缀变体,以及 .vscode/cspell.json。若未找到配置,应通知用户而非自动修复,并可提供初始化选项。使用内联指令时参考 decision-tree.md 选择指令与放置位置。运行时通过 Context7(/streetsidesoftware/cspell)获取 cspell 语法与配置细节,不依赖硬编码语法。

适用场景:cspell 标记未知单词、用户要求修复警告或添加词典、用户想为项目设置 cspell、用户询问某词为何被标记、lint 流程或预提交钩子因未识别单词失败。

限制:不适用于非 cspell 的拼写检查器(如 typo、codespell、Vale、textlint),也不适用于其他 lint 工具(如 ESLint、markdownlint)。不要用语义不同的词替换原词,不要将一次性单词加入项目词典,不要用 cspell:disable 屏蔽大段内容,不要盲目接受所有建议,不要对运行时 API 标识符、包名或固定外部术语做连字符或结构改动。.vscode/settings.json 中的 cspell.* 设置属于 IDE 本地配置,不算项目配置。无写入权限时应提示用户手动编辑;输出过多时先限定源目录并配置 ignorePaths;Context7 不可用时回退到 cspell.org 或 cspell init --help。