0.0.0-beta.2 • Published 9 months ago
i18n-check-puppeteer v0.0.0-beta.2
i18n-check-puppeteer
介绍
项目国际化完成程度的校验批注工具，通过puppeteer打开本地项目的地址，动态扫描网页中的中文特殊字符进行匹配标注。
- 此脚本的默认校验规则依赖 自定义校验loader（配置方法见链接文档），请先在需校验的项目中安装配置此loader，再运行puppeteer脚本测试
安装依赖
npm i i18n-check-puppeteer -D启动脚本
i18n-check- 第一次启动会提示在命令行输入本地项目的启动命令（例如：npm run dev，yarn dev，npm start），输入自己项目的启动命令并等待项目启动完成。
- 当监听到项目本地编译完成并能正常启动时，会提示输入本地访问地址（例如：http://localhost:8080/），输入本地访问地址后等待puppeteer脚本启动Chromium浏览器
- 第一次输入的启动参数会记录在自动创建的配置文件中，下次启动脚本会自动运行配置文件中的启动参数
重置配置文件
i18n-check -reset重置配置参数后，还原成第一次启动时的提示输入
Chromium浏览器中的使用说明
当出现图中的场景说明打开测试浏览器成功
标红的区域为识别到的前端代码中手动添加的中文- 网页右下方的
一键截图点击后会自动把图片保存在当前项目目录下的screenshot文件夹中
校验规则
上面被标红的区域是通过预先设定的规则进行匹配找出，分不同使用场景：
1. 校验需国际化的文本(只包含前端范围) 结合自定义校验loader扫描到的则是在原始前端代码中手动插入的中文。如下图标注的文本，不含接口获取到的内容
- 直接校验所有文本 启动脚本输入
i18n-check -findAll通过传入-findAll选项，直接匹配并标注当前网页中出现的所有中文字符。（不依赖校验loader）
i18n-check -findAll
注意事项
- 执行
i18n-check需在本地项目的正确目录上执行，一般是在项目根目录，或指定资源目录(例如项目中同时包含PC、H5，需切换到指定目录下运行启动脚本) - 第一次安装依赖时间可能较长，需下载puppeteer对应的Chromium包
- 通过启动puppeteer打开的测试浏览器初次加载页面的时间可能较长，中途不要关闭浏览器窗口