使用 cspell 检查英文文案

背景

在多语言中，我们需要英文文案。英文不是母语，容易出错。将错误的英文展示在客户面前，这是低级的错误。下面总结一些如何尽量避免英文文案错误的经验。

1.文案的准备，包括文案稿的校验过程

产品经理准备中文文案，必须提供给专门翻译的负责人。翻译并校验完毕后才可提供给开发。
产品经理也可能英文不够专业，不可自行翻译自行提供给开发，而不知会他人。

2. 文案的使用

1、开发同学IDE安装单词拼写检查插件，有问题的可以马上修正
下面介绍一款vscode的英文检查插件：code spell checker

image.png

安装这个插件后，不合法的英文将会显示蓝色波浪线：

image.png

为了更好的配置检查，可在根目录下提供配置文件：cpell.json，以下是其详细配置：

image.png

2、使用node英文检查组件，集成到gitlab CI中，对项目做强制约束
vscode插件对错误英文进行了提示，但是没有强制解决，开发难免会有疏漏。下面使用配套的npm插件：cspell集成到gitlab CI中。

我们在.gitlab-ci.yml中添加一个stage为check。

image.png
stage是串行的。如果check没有通过，则整个流程也会失败：
image.png
看cspell的文档，其配置文件的规范与vscode插件code spell checker完全相同，应该是同一作者。这样就只维护一个cspell.json即可。

3、另外也可以使用git钩子在提交时检查
pre-commit

安装后pre-commit后， 在package.json配置一下：

  "scripts": {
    "check:spell": "cspell {client, server}/**/*.json",
  },
  "pre-commit": [
    "check:spell"
  ],

使用钩子有个好处，就是在commit时可以添加-n参数选择跳过检查：

git commit -n -m "xxx"

对于一些无法识别的人名拼音、名称缩写可以确认无误后跳过。

3. 产品的线上检验

对于新上线的文案，产品应该再及时查看，确认无误。