Home

Welcome to the r-check wiki!

r-check 安装

npm install -g r-check

r-check 基本使用

使用r-check -v 查看版本号(当前版本@1.2.5)(规则与下文列出的规则已经有所不同)
使用r-check -h 可以查看帮助信息
运行r-check 检查目录下编码规范及翻译检查。 帮助信息显示如下

检查参数是为了让使用者进行快速的配置，而不用一步步选择。
参数用法r-check run -<参数>
帮助信息显示如下

Hello r-check
Current Vertion:2.0.0


Usage: run [options]

check your folder with different options.

Options:  

-P, --path [configfile path]  The path of your config file which should follow with the -P or --path option.
-S, --close-check             Close source code check.
-C, --close-css               Close css check.
-H, --close-html              Close html check.
-J, --close-js                Close js check.
-E, --close-encode            Close encode check.
-T, --check-translate         Open translate check.
-D, --debug,                  Run in debug mode.
-M, --multifile               Output the results as a single log for each file checked
-Q, --question                Run immidiately without config any options
-h, --help                    output usage information

当使用r-check run -Q时，CLI中就不会出现询问配置的显示。而是根据-Q后的参数直接运行

e.g:  
r-check run -QSJ //这样配置的话呢，就会关闭代码规范检查，开启翻译检查。
r-check run -QHCE //这样配置的话，就会关闭html检查css检查编码检查，从而只检查js

配置文件生成

配置文件共三个：

• r.config.js
• .eslintrc.js
• .eslintignore

这三个文件的作用

• r.config.js:用于配置翻译检查的参数以及html、css语法规范的检查配置。
• .eslintrc.js:用于配置ESLint插件的语法规范检查规则(组内统一)。此规则同时也将应用于你的IDE（如果你装了ESLint插件的话）
• .eslintignore:用于配置ESLint应该忽略的文件(比如node_modules)

输入r-check init按步骤选择即可

1. 第一步会提示生成的配置文件类型，有三种：生成所有配置文件 && 仅生成ESLint相关配置文件 && 仅生成r.config.js
2. 第二步需要使用者选择是否为老代码，因为很多老代码不是SPA，没有经过打包，会有许多错误。如果不是老代码直接回车，默认为否。
3. 如果配置文件已经存在于当前目录中，则会询问是否覆盖配置文件。选择是，则会覆盖所有配置文件。选择否，则不会覆盖配置文件，但没有的配置文件仍会生成。

r-check 命令选项

使用r-check -v 查看版本号(当前版本@1.2.5)
使用r-check -h 可以查看帮助信息
运行r-check run检查目录下编码规范及翻译检查。 运行r-check init生成配置文件

###检查参数 检查参数是为了让使用者进行快速的配置，而不用一步步选择。
参数用法r-check run -<参数>
帮助信息显示如下

Hello r-check
Current Vertion:2.0.0


Usage: run [options]

check your folder with different options.

Options:  

	-S, --close-check             Close source code check.
	-C, --close-css               Close css check.
	-H, --close-html              Close html check.
	-J, --close-js                Close js check.
	-E, --close-encode            Close encode check.
	-T, --check-translate         Open translate check.
	-D, --debug,                  Run in debug mode.
	-M, --multifile               Output the results as a single log for each file checked
	-Q, --question                Run immidiately without config any options
	-h, --help                    output usage information

当使用r-check run -Q时，CLI中就不会出现询问配置的显示。而是根据-Q后的参数直接运行

e.g:  
r-check run -QSJ //这样配置的话呢，就会关闭代码规范检查，开启翻译检查。
r-check run -QHCE //这样配置的话，就会关闭html检查css检查编码检查，从而只检查js

下面有更加详细的介绍

r-check run <options>

r-check指令后可以跟上一些选项来选择关闭某些检查

-M or --multifile 配置输出日志的格式

输出的错误日志默认是单个文件的形式，保存在各自的文件夹下。 如果你偏好每个错误日志对应其错误的文件，请使用-M参数

e.g:

r-check run -QM

-S or --close-check 关闭代码规范检查

输入此指令后将不会检查代码规范
包括html,css,js代码规范

e.g:

r-check run -QS

或者

r-check run --close-check

-C or--close-css关闭css检查

-H or --close-html关闭html检查

-J or --close-js关闭js检查

**注意：**所有的短指令是可以组合起来的
但是长指令不可以
e.g:

例如 r-check run -QCHJ

等价于

r-check run -Q -C -H -J

等价于

r-check run -Q --close-css --close-html --close-js

-E or --close-encode 关闭编码检查

编码检查会检查你的文件是否为UTF-8格式(有无BOM均可，但必须是UTF8)。
以避免在前后台在编码格式上出现错误，以及在IE8下的显示问题。
编码检查虽然是必须的，但是编码检查会进行大量的IO操作，建议检查一次确认没有问题之后手动关闭。
e.g:

r-check run -E

-T or --check-translate 开启翻译检查

因为不一定所有的产品需要翻译检查。
当开启翻译检查却没有检查到语言包或者翻译检查的相关配置项时会报错。
翻译检查的配置在r.config.js中配置。
具体配置项如下:

//配置项中有重复的项是为了配置方便，避免出现混淆。请在每个检查下都配置一遍  
module.exports = {
  "jsonAndCode": { //检查源码中每条翻译是否在json中都由对应的词条
     "jsonPath": "./app/common/lang"     //***必填   json文件的上级目录的上级目录   因为可能有多国语言的情况
   },
  "jsonAndExcel": { //检查json文件和excel文件的词条是否一一对应
     "jsonPath": "./app/common/lang", //***必填   json文件的上级目录的上级目录   因为可能有多国语言的情况
     "excelPath": "./docs/O3.xlsx",   //***必填   语言包的路径
     "defaultLang": "en"            //***必填   默认的语言，excel文件中以这种语言为基准
   },
  "checkDuplicate": { //检查excel中是否有重复的词条。重复词条会导致翻译的一对多问题
     "excelPath": "./test/O3.xlsx", //***必填   语言包的路径、
     "defaultLang": "en"           //***必填   默认的语言，excel文件中以这种语言为基准
   }
};