嗖的一下就码出一个CLI

简介: 今天呢,准备推荐一个工具如果你现在没有开发命令行工具的打算那可以先收藏着以后,或许,应该会用到吧

0.jpeg

今天呢,准备推荐一个工具
如果你现在没有开发命令行工具的打算
那可以先收藏着
以后,或许,应该会用到吧


丹尼尔: 蛋兄,手头有个任务要开发一个命令行工具,有没快速搞起来的办法

蛋先生: 用 ncgen

丹尼尔: 额,这不是开发代码生成器的吗?我这不还没有命令行工具的项目模板嘛

蛋先生: 哦哦,也是,想错了。那看一下《烹饪一道美味的 CLI》 呗,已经把来龙去脉讲得很详细了

丹尼尔: 是很详细,但就是太过详细了,我想要嗖的一下就能搞定那种

蛋先生: 嗖的一下?容我想想,( ̄o ̄) . z Z

丹尼尔: 蛋兄,蛋兄 ...

蛋先生: 想起来了,《烹饪一道美味的 CLI》 有提到啊,就是 oclif


丹尼尔: 怎么用呢?假设我现在要开发一个百宝箱工具,就叫 dx-tools 吧

蛋先生: 没问题,首先肯定是要自动初始化工程项目的啦,最低要求了

1.gif

丹尼尔: 哎呦不错,开发的时候昨运行呢?

蛋先生: 简单~

2.gif

丹尼尔: 那现在来给百宝箱工具增加复制的功能吧,如 dx-tools cp

蛋先生: 安排。dx-tools cp 中的 cp 就是 dx-tools 的子命令 (oclif 称为 command),oclif 也为 command 提供了代码生成工具

3.gif

蛋先生: 运行后会生成 src/commands/cp.ts 代码文件。代码长啥样呢,我们等会再看。先运行下看看效果,可以看出已经有 cp 这个子命令了

4.gif

丹尼尔: Good!光有 cp 还不行,还得指定参数,像这样子 dx-tools cp source_file target_file

蛋先生: 好咧!dx-tools cp source_file target_file 中的 source_filetarget_file 是子命令 cp 的参数(oclif 称为 command arguments)。加参数前我们先看下 cp 默认生成的帮助信息,等会才好看出变化

5.gif

丹尼尔: 细心哦~

蛋先生: 前面提到生成的代码文件 src/commands/cp.ts,这会我们来看下代码。


import {Command, Flags} from'@oclif/core'exportdefaultclassCpextendsCommand {
staticdescription='describe the command here'staticexamples= [
'<%= config.bin %> <%= command.id %>',
  ]
staticflags= {
// flag with a value (-n, --name=VALUE)name: Flags.string({char: 'n', description: 'name to print'}),
// flag with no value (-f, --force)force: Flags.boolean({char: 'f'}),
  }
staticargs= [{name: 'file'}]
publicasyncrun(): Promise<void> {
const {args, flags} =awaitthis.parse(Cp)
constname=flags.name??'world'this.log(`hello ${name} from/Users/daniel/Projects/Test/dx-tools/src/commands/cp.ts`)if (args.file && flags.force) {this.log(`youinput--forceand--file: ${args.file}`)}}}


蛋先生: 我们现在需要增加两个参数,小修改下

6.gif

蛋先生: 执行看下帮助信息,看,出来了

7.gif

蛋先生: 再执行下,看看获取参数的效果

8.gif

丹尼尔: Nice!最后我想加个选项,来指定如果目标文件存在,是否进行覆盖。像这样子 dx-tools cp -n source_file target_file 就表示不覆盖

蛋先生: -n 就是可选项,一般在命令行中称为 option,但在 oclif 这里是叫作 flag。再小修改下代码

9.gif

蛋先生: 看下帮助信息,搞定

10.gif

丹尼尔: o(^@^)o 功能都差不多了,现在得完善帮助信息,来提高用户使用体验。

蛋先生: 嗖.嗖.嗖.

11.gif

蛋先生: Done!

12.gif

丹尼尔: 这下完美了

蛋先生: 不,还差那么一点点

丹尼尔: 啥?

蛋先生: 发布啊,你不发布,别人怎么用呢

13.gif

丹尼尔: Oh yeah!


蛋先生: 当然,oclif 的功能远不止这些,有兴趣可以自行去探索了,今天就到这了

丹尼尔: 恩恩,又到了说再见的时候了,88

蛋先生: 要不,点个赞鼓励一下再走 (^▽^ )

目录
相关文章
|
18天前
|
前端开发 JavaScript 开发者
NPM简介与使用指南:打造前端开发的利器
NPM简介与使用指南:打造前端开发的利器
7 0
|
2月前
|
NoSQL 关系型数据库 MySQL
开发者福音:用IDEA和Iedis2加速Redis开发与调试
开发者福音:用IDEA和Iedis2加速Redis开发与调试
59 0
开发者福音:用IDEA和Iedis2加速Redis开发与调试
|
2月前
|
缓存 JavaScript 前端开发
【热门话题】深入浅出:npm常用命令详解与实践
**npm命令详解:**了解基本概念和安装后,通过`npm init`生成`package.json`。安装包用`install [package]`,加`--save`或`--save-dev`管理依赖。移除包用`uninstall`,更新用`update`,全局安装加`-g`。搜索包用`search`,查看依赖用`list`,检查过时包用`outdated`,审计安全用`audit`。版本控制用`version`,发布包用`publish`。掌握这些命令能提升开发效率。探索更多npm特性,加强项目管理和协作。
44 6
|
监控 NoSQL 数据可视化
Redis 官方可视化工具,功能真心强大!高颜值
Redis 官方可视化工具,功能真心强大!高颜值
|
前端开发 Devops API
前端利器躬行记(8)——VSCode插件研发
前端利器躬行记(8)——VSCode插件研发
|
存储 缓存 Rust
《一种秒级安装 npm 的方式 - 零弌》演讲视频 + 文字版
《一种秒级安装 npm 的方式 - 零弌》演讲视频 + 文字版
169 0
|
JSON 前端开发 JavaScript
vee-cli脚手架实践(中)
vee-cli脚手架实践
47 0
|
设计模式 前端开发 JavaScript
vee-cli脚手架实践(下)
vee-cli脚手架实践
49 0
|
前端开发 JavaScript 搜索推荐
vee-cli脚手架实践(上)
vee-cli脚手架实践
61 0
|
Ubuntu JavaScript 小程序
10分钟快速构建一套自己的虚拟开发环境,Vagrant 堪称效率神器!
10分钟快速构建一套自己的虚拟开发环境,Vagrant 堪称效率神器!