跳到主要内容

check

校验 package.json 里的appGroupName字段是否和 src/configs/subApp.ts(js)里的LIB_NAMEAPP_NAME_NAME是否一致,该接口通常在srcipts/check.js里被命令npm run check触发调用

基础用法

指定路径做检查

指定项目里包含有应用组名的文件路径做检查,fileFullPath可加后缀.js.ts,也可以不添加,接口内部会去自动推测

const path = require('path');
const helDevUtils = require('hel-dev-utils');
const pkg = require('../package.json');

const fileFullPath = path.join(__dirname, '../src/configs/subApp');
helDevUtils.check(pkg, { fileFullPath, checkEnv: false });

检查环境变量里的组名

设定checkEnv为 true 表示检查process.env.HEL_APP_GROUP_NAME 是否和 package.json 里的appGroupName字段是否一致,通常用于流水线上需要透传process.env.HEL_APP_GROUP_NAME变量控制构建产物的组名时,设定此参数做检查

helDevUtils.check(pkg, { fileFullPath, checkEnv: true });
checkEnv 默认为 true

checkEnv 默认为 true,如用户是采取本地通过hel-dev-utils来构建hel-meta.json元数据时,可显式的设置为 false,避免 check 执行报错

文档正在拼命建设中,有疑问可联系 fantasticsoul,关注我的掘金主页了解更多 ....