前言
在前端开发中，我们常常需要处理文本，而一个好的文本处理工具是非常有帮助的。cspell 是一个功能强大的文本拼写检查器，使用它可以提高代码的可读性和可维护性。如果你的项目中涉及到 java 技术相关的术语，那么可以使用 npm 包 cspell-dict-java 来帮助你进行校验。下面是一个详细的使用教程。
安装
使用 npm 安装 cspell 和 cspell-dict-java：
npm install cspell cspell-dict-java --save-dev
配置
在根目录下新建一个 spelling.json 文件，并加入以下配置：
-- -------------------- ---- -------
-
--------------- -
------
--
----------- ----------
------------------- --------
-------- ---
------------------- -
------------- -------------
--------
--
-------------- - --
---------- ----
-说明：
- "dictionaries": 使用的词库，这里只使用 java 词库。
- "language": 语言类型，en 表示英文，java 表示 java 术语。
- "spellingLogLevel": 日志级别，这里设置为 Error，表示只报告错误。
- "words": 常用单词，可以通过该配置来添加、删除常用单词。
- "ignoreRegExpList": 忽略的正则表达式列表，可以通过该配置来忽略一些不需要校验的文本。
- "ignoreWords": 忽略的单词列表，同样可以忽略一些不需要校验的单词。
- "enabled": 是否启用校验。
使用
在命令行中执行以下命令：
npx cspell **/*.{ts,js} --config ./spelling.json在项目目录中，执行上述命令可以对 .ts 和 .js 后缀的文件进行拼写校验。
示例
假设我们有两个文件 src/A.ts 和 src/B.ts，内容分别如下：
A.ts:
export class A {
public say() {
console.log('你好世界！');
}
}B.ts:
-- -------------------- ---- -------
------ - - - ---- ------
------ ----- - -
------ - - --- ----
------ ----- -
--------------------
-------------
-
-我们可以在根目录下新建一个 spelling.json 文件，并加入以下配置：
-- -------------------- ---- -------
-
--------------- -
------
--
----------- ----------
------------------- --------
-------- ---
------------------- -
------------- -------------
--------
--
-------------- - --
---------- ----
-在命令行中执行以下命令：
npx cspell src/**/*.{ts,js} --config ./spelling.json如果有拼写错误，cspell 会将其列出。
例如，我们故意将 A.ts 文件中的世界改为世俘，B.ts 文件中的 import 拼写错误，再次执行命令，会看到以下提示：
-- -------------------- ---- ------- ---------- ------ - -- - ------- ----- -------- - ----- -------- -- ------ ------ - ------- ----- ----
这样就可以方便地对我们的项目进行拼写校验了。
总结
使用 npm 包 cspell-dict-java 可以方便地对涉及到 java 技术相关的术语进行校验，进一步提高代码的可读性和可维护性。希望本文可以帮助到大家。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbf88b5cbfe1ea0611c1e