这是一个模块工具包, 主要用于开发模块时提供的一些快捷操作

安装

npm install @fe2345/module-tool

使用

const {cmd} = require('@fe2345/module-tool');

API

带颜色的控制台

const {log} = require('@fe2345/module-tool');
log.info('内容'); // 输出常规日志, 颜色为灰色
log.warn('内容'); // 输出告警日志, 颜色为橙色
log.error('内容'); // 输出错误日志, 颜色为红色
log.success('内容'); // 输出成功日志, 颜色为绿色
log.blankLine(); // 输出空白行

exit 函数

退出当前进程, 等同于 process.exit(1);

const {exit} = require('@fe2345/module-tool');

exit();

packageName 属性

“当前项目” package.json 中的 name 属性

注: 如何理解当前项目 package.json 的文件位置, 由一个示例来说明:

// a 模块引用 @fe2345/module-tool
// b 模块引用 a 模块
// c 项目引用 b 模块
// package.json 所在位置应为 c 项目根目录

packageData 属性

“当前项目” package.json 数据

rootPath 属性

“当前项目” 根目录, 是引用当前模块的项目所在的根目录

addJsonFile 函数

“当前项目” , 添加Json文件

参数:

• data 对象, 添加JSON文件的数据
• filePath 路径, 添加JSON文件路径, 推荐使用相对路径, 相对于 “当前项目” 根目录;
• cover 是否覆盖, 默认为false, 如果覆盖则文件存在也会执行替换

返回值: 返回添加后的JSON文件数据

const {addJsonFile} = require('@fe2345/module-tool');

addJsonFile(data, path, cover);

packagePropAdd 函数

“当前项目” package.json 中添加属性

参数:

• name 属性名, 属性名可以是链式, 例如: "scripts.build"
• value 属性值
• cover 是否覆盖

const {packagePropAdd} = require('@fe2345/module-tool');

packagePropAdd(name, value, cover);

packagePropDel 函数

“当前项目” package.json 中删除属性

参数:

• name 属性名, 属性名可以是链式, 例如: "scripts.build"

const {packagePropDel} = require('@fe2345/module-tool');

packagePropDel(name);

cmd 函数

执行命令行

参数:

• command 命令行语句

返回值:

• 对象:
  • stderrBuffer
  • stdoutBuffer
  • stdout
  • stderr
  • error