位置: 编程技术 - 正文

详解用node编写自己的cli工具(node用什么写的)

编辑:rootadmin

推荐整理分享详解用node编写自己的cli工具(node用什么写的),希望有所帮助,仅作参考,欢迎阅读内容。

文章相关热门搜索词:如何使用node.js,node用什么写的,node编程,node怎么做,node编程,如何使用node.js,使用node,node怎么写,内容如对您有帮助,希望把文章链接给更多的朋友!

工作中接到新项目,开发前都需要先规划项目目录,然后一个个创建文件,搭建sass编译环境,下载jquery,Swiper等类库... 这些准备工作都要花上不少时间。每做一个项目,都会遇到同样的问题,再重复一遍吗?是时候做点改变了:编写自己的cli工具,一行命令,3秒钟进入coding状态!

本文以自己的my-cli为例,将开发到发布过程完整记录下来,看完本文,你将学会如何从零开发一个cli项目,如何上传到github库,以及如何使用npm发布自己的包。

准备

开发一个cli工具前首先要想好它能做什么。以我自己为例,我需要一个工具,让我能只输入一行命令就帮我快速搭建好项目结构,就像这样:

是不是很炫酷?放心,很简单。

开始

首先创建你的cli项目,并使用npm init创建一个package.json。

根据提示一步步创建好package.json。name属性就是你发布到npm上的名字,这个是不能与npm上现有项目重名的,一个小技巧是使用npm install下载你想要起的包名字,如果报错,那么你的包名是可用的。最后创建好的package.json文件像这样子:

编写可执行文件

package.json中有一个"bin"字段,配置后才可以在控制台使用你的命令。

我们配置了"my-cli"命令来执行index.js文件。用你喜欢的编辑器,在项目主目录下创建一个index.js文件。

注意第一行的"#! node"很重要,表示用node来执行这个文件。如果没有这句声明,就会在记事本中打开index.js文件。

全局安装你的包

使用 npm install -g 将你当前的项目安装到全局环境,现在你可以在命令行使用"my-cli"命令了。

用fs模块快速生成项目模板

我们自定义的指令可以执行了,接下来编写代码实现功能。my-cli的主要功能就是生成项目模板,一个思路是用一个templates文件夹保存项目模板,然后通过fs.mkdir()来创建项目目录,最后把文件从templates文件夹拷贝到项目中去。

详解用node编写自己的cli工具(node用什么写的)

核心代码就这么点,是不是非常简单?

整个项目文件结构差不多就这个样子,把你需要的文件放到templates文件夹,然后用copyTemplate方法将文件拷贝到项目目录下。

创建文件目录和拷贝文件的过程,代码看着比较丑陋

接收命令行参数

平常我们使用命令行工具时都会用到参数,如 webpack -p, express -e 等,现在我们来为自己的cli添加接收命令行参数的功能。为my-cli设计四个参数,用来向项目中添加类库。

使用commander包可以简化解析参数过程,但是本项目比较简单,我也不想额外引入其他的包了,处理一些简单的参数其实并不难。

node中我们可以使用process.argv来获取命令行参数,process.argv是一个参数数组,第一项为node.exe的绝对路径,第二项为执行该js的绝对路径,使用process.argv.slice(2)即可获取输入的参数数组。

通过遍历参数数组来检查命令中输入了哪些参数。如果输入了预设的参数,就为config对象添加对应的属性,在生成文件时根据onfig判断是否将模板文件拷贝到项目中。继续丑陋的代码:

本地运行

至此我们的项目已经基本完成了,使用 npm install -g 将项目安装到全局环境,然后新建一个项目文件夹,使用my-cli命令来生成项目模板。

发布到npm仓库

要想将自己的包发布到npm上,首先得有一个npm账号,创建账号非常简单,输入npm adduser,简单三步即可完成创建。

创建好user后,使用npm publish即可将当前项目发布到npm上了,以后就可以使用npm install -g my-cli 来安装你的cli工具。

结束语

相信大家看完本文后知道如何根据自己的需求制作cli工具了。本文中的my-cli比较简单,权当做抛砖引玉。如果想查看完整源码或者使用这个工具,可以戳这里:github地址。

标签: node用什么写的

本文链接地址:https://www.jiuchutong.com/biancheng/380801.html 转载请保留说明!

上一篇:Nodejs中Express 常用中间件 body-parser 实现解析(node.js express koa)

下一篇:Node.js 实现简单的接口服务器的实例代码(node.js开发实战详解)

  • 个人所得税计提分录怎么写
  • 2020年委托加工的税率是多少
  • 进项税额不允许抵扣怎么计算
  • 外贸企业账务处理及报税
  • 资产负债表库存为负数怎么调整
  • 活动经费属于什么费用
  • 押金收不回来没钱怎么办
  • 税控设备抵减增值税政策
  • 纳税总额和实际上缴税费总额
  • 维保税率和维修税率是多少
  • 增值税专用发票抵扣联
  • 举例说明税收支出的形式
  • 老板投资的钱怎么入账
  • 税务部门罚没收入200元
  • 供货方代垫运费计入原材料
  • 用友为啥会出现期初调整
  • 个人独资的企业性质是什么
  • 发票添加商品编码怎么填
  • 劳务费税率公式是什么
  • 环保税征收意义
  • 汽车加油专票可以抵扣税款吗
  • 多付工资计入哪个科目
  • 开专票需要哪些东西
  • 成本分析总结报告
  • 发票冲红可以冲红数量不变金额减少
  • 1697511215
  • 固态硬盘坏了的话是整个坏吗
  • 有什么好方法可以让小孩子少吃糖
  • u盘怎么安装软件
  • php中session的作用
  • 政府补助退回的账务处理
  • 增值税专用发票的税率是多少啊
  • 基础知识讲解
  • 变动成本法计算营业利润
  • 联表更新数据
  • 累计折旧在贷方还是借方
  • 固定资产转卖会亏本吗
  • cv计算机视觉定义
  • 微软和梅赛德斯奔驰宣布合作
  • php远程访问
  • df -th命令
  • 报销的时候发票金额大于实际报销的金额
  • linux脚本文件编写
  • phpcms专题页面模板
  • 暂估价与发票价的区别
  • 利润分配的5个基本原则
  • 企业所得税怎么算
  • sql语句重复
  • 在建工程转入
  • 住宿费发票可以报销吗
  • 个人如何缴纳公积金和社保费用
  • 购买农产品普通发票怎么做账
  • 车保险会计怎么做分录
  • 筹建期费用账务处理
  • 年底销项税额和进项税额要转出吗
  • 开办费入哪个会计科目
  • 企业增资的流程
  • sqlserver索引语句
  • 清空表内数据语句
  • win10应用商店应用少
  • win8系统运行在哪里
  • 加强 提升 优化
  • mac safari浏览器网页不能正常显示
  • 华硕和联想笔记本电脑哪个好点
  • linux中who命令
  • win7蓝屏怎么办
  • win8.1出现了一些问题
  • perl 批量注释
  • javascript例子
  • unity连接数据库能做什么
  • android studio乱码怎么解决
  • javascript的dom
  • 深入理解中国式现代化
  • 文件读写过程中,程序将直接与磁盘文件进行数据交换
  • jquery内容过滤选择器有哪些
  • 如何开发一个新的向量库
  • Python for Informatics 第11章之正则表达式(二)
  • Javascript this 关键字 详解
  • 个税已申报税额为0可以退税吗
  • 重庆税务登录
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

    网站地图: 企业信息 工商信息 财税知识 网络常识 编程技术

    友情链接: 武汉网站建设