介绍

用于项目中文件繁简体检查。

features

• 支持 vue，js，ts，css，stylus，pug 文件，适配 Vue 项目。
• 依托于 opencc 库，完美兼容多种繁简体检查。
• 支持配置项目中已有单个文字忽略。
• 支持文件级别的忽略检查。
• 支持嵌入 lint-staged 使用。

安装

# 全局安装
npm i opencclint -g

# 项目中安装
npm i opencclint -D

CLI 命令行使用

# 單文件檢查
npx opencclint ./test/test.js

# 多个文件检查
npx opencclint "./test/test.js" "./test/test.vue"

# 文件夾檢查
npx opancclint ./test

项目中使用

项目根目录配置 simplify.config.js 。

simplify.config.js 配置文件

• translation，配置简体转换台湾字体，可参考 opencc 文档。
• ignoreTexts，配置忽略的单个或多个文字。
• vue, 配置 vue 版本。

{
    vue: 3, // vue version
    translation: "simplifiedToTaiwan",// 配置简体转换台湾字体
    ignoreTexts: {
        台: "臺",
        裏: "裡",
        收佣: "收傭"
    }
}

结合 lint-staged 使用

下为实例，具体参看 husky 与 lint-staged 文档。（husky 与 lint-staged 版本会有不同使用方法。）

// husky ^3.1.0 && lint-staged ^8.1.0
"lint-staged": {
    "*.{ts,tsx,js,vue}": [
        "npm run lint",
        "opencclint",
        "git add"
    ],
    "*.{styl, css}": [
        "opencclint",
        "git add"
    ]
},

忽略文件

项目中以文件级别，忽略繁简体检查

js文件

/* simplify ignore */

vue文件

...
<script>
/* simplify ignore */
</script>
...

css stylus 文件

/* simplify ignore */

注意点

关于 pug 文件使用

pug文件使用了，pug-compiler，会忽略 //- 注释。// 注释默认不忽略。