echofe
v1.0.0
Published
## 编写备忘录
Readme
echofe
编写备忘录
- CLI 项目的区别在于 package.json 的配置上有一个 bin 的配置
- 本地调试需要使用 npm link
- 调用时因为在系统层面调用需要在代码里标注执行环境,如 cli 的第一行 #!/usr/bin/env node
请遵守规则
CC 掌握 Node CLI 工具开发,为团队研发提效! 4.1、遵循 POSIX 参数 POSIX 语法已被广泛接受为命令行工具的标准,我们开发命令行工具时,应该遵守它。 常见规则举例如下:
可以指令帮助或示例中将选项参数或选项标记为方括号( [] )表示它们是可选的;或带有尖括号( <> )表示它们是必需的。
允许使用短格式的单个字母参数作为长格式参数的别名(请参阅 GNU 编码标准)
使用缩写形式单数指定的选项 - 可以包含一个字母数字字符。
指定多个没有值的选项可以进行分组,例如 myCli -abc 等效于 myCli -a -b -c
命令行高级用户希望您的命令行应用程序具有与其他 Unix 应用程序类似的约定 4.2、遵循 Semver 版本 版本格式 X.Y.Z-[state]
X 代表 主版本号:功能新增、移除,API不向下兼容 Y 代表 次版本号:功能新增,API向下兼容 Z 代表 修订版本号:问题修复,API向下兼容 [state] 状态解释如下
描述方式说明含义alphaalpha 版内测版本:bug 较多betabeta 版公测版本:存在bug,有缺陷gammaGamma 版相当成熟的测试版:与发行版相差无几(一般略过此版本)rcRelease Candidate发行倒计时版本:实现了全部功能,修复了大部分 bug,接近发布倒计时,有时会进一步细分为 rc.1、rc.2 4.3、提供丰富且友好的交互
提供丰富的交互,如 select 选择、filter 筛选、帮助提示等,让人操作更便捷
