位置: 编程技术 - 正文

详解用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开发实战详解)

  • 车辆购置税和车船税的区别在哪
  • 固定资产处置收入怎么报税
  • 法人和办税人
  • 收付实现制有应收应付吗
  • 折扣折让属于什么科目
  • 咨询公司要交税吗
  • 房地产企业购入用于建造商品房的土地使用权
  • 企业资产损失所得税税前扣除办法
  • 融资租赁租入固定资产折旧可以税前扣除吗
  • 房产预收款怎么记帐?
  • 公司注销时认缴不到位怎么办
  • 知识产权投资是什么意思
  • 顺流交易为什么不管是否出售
  • 支付宝企业账户客服电话
  • 出售无形资产属于让渡资产使用权吗
  • 劳务费做账要交个人所得税吗?
  • 投资收益是否缴纳印花税
  • 营改增后房地产公司税种及税率
  • 人均营收指标
  • 发票的校验码被公章覆盖了怎么办
  • 分包给总包开什么发票
  • 户外广告经营总额
  • 委托贷款利息收入怎么开发票
  • 电脑玩游戏卡怎么弄
  • 小规模纳税人减征额怎么计算
  • 企业签订的借款合同印花税
  • harmonyos2.0.0怎么用
  • PHP:oci_commit()的用法_Oracle函数
  • 报销金额和发票金额不一致怎么做账
  • 决算报表是财务报表吗
  • html页面中利用______标签可引入jquery库
  • 公司搞活动买的车能买吗
  • 收到银行本票的账务处理
  • 坏账损失和坏账准备
  • vite配置详解
  • 豁免债权如何做账
  • vue项目移动端怎么做适配
  • php用户登录界面代码
  • 物业管理公司经营范围有哪些内容
  • 工程项目过路费是指什么意思啊
  • 个人独资企业只有收入没有成本和费用
  • 房产公司业务招待费扣除政策
  • 固定资产一次性扣除政策
  • sqlserver2012开发版
  • 一般纳税人暂未开具发票
  • 小规模纳税人免税怎么做账
  • 缴增值税的账务处理
  • 联营单位投入的款项
  • 代开发票取得的收入如何入账?
  • 房租没有发票如何交税
  • 以物易物有什么好处
  • 可转债不卖会亏钱吗
  • 会计凭证装订的心得体会
  • 速动比率特别高的原因
  • 商品流通企业会计做账流程
  • MySQL利用视图查询员工进货数量要求输出姓名进货数量
  • sql中nullif
  • 表空间 数据库
  • centos7 syslog
  • win10预览版21277下载
  • mac安装路径选择
  • 外接法实物图
  • usb3.0接口可以插优盘吗
  • ubuntu20设置ip
  • win7的屏保设置在哪里
  • xp系统快捷启动按哪个
  • win7系统怎么看wi-fi密码
  • vim配置语法高亮
  • win8 自动登录
  • linux清除ssh登录记录
  • html5的全局属性
  • cocos2dx屏幕适配解决方案
  • java调用curl命令
  • 批处理应用实例
  • js中arguments
  • jquery form序列化
  • jquery定义方法
  • 湖南省国家税务总局官网登录入口
  • 怎么知道税控盘有没有注销
  • 三证合一怎么申报
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设