位置: 编程技术 - 正文

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

  • 个体户要交什么税,怎样收
  • 公司注销后虚开还查吗
  • 企业向银行贷款属于融资吗
  • 小规模计提增值税
  • 增量留底退税好处
  • 印花税按照开票金额缴纳可以吗
  • 研发人员的社保也要进入研发费用吗
  • 冲红发票怎么填写信息
  • 软件著作权费用怎么入账
  • 买卖金融商品应交增值税计算
  • 跨月应该如何开具红字发票?
  • 融资租赁固定资产会计处理
  • 交通费补贴报销的会计分录怎么做?
  • 教育服务增值税纳税义务发生时间
  • 本月无凭证需要结转吗
  • 收回过去已确认的坏账
  • 劳务公司购买材料怎么做账
  • 个税返还奖励财务人员申报个税
  • 企业会议费发票可否抵扣?
  • 现金交易的发票可以认证
  • 纳税调整额怎么算出来的
  • etc在充值后未索取可以再次索取吗
  • 利润表所得税费用怎么填
  • 党员参加集体活动规定
  • 纳税人月销售额怎么算
  • 补缴社保差额有滞纳金吗
  • linux怎么使用命令
  • 退税收入计入营业外收入吗
  • mac系统怎么删除用户
  • 事业单位财政拨款是编制吗
  • 森林植被恢复费标准
  • 什么是应交税费科目
  • 企业所得税法规定,企业购置并实际使用
  • 出口企业增值税怎么算
  • php自定义函数的关键字是什么
  • 存货非正常损失进项税额转出
  • 什么是汇算清缴申报表
  • 销售货物免税
  • 生产型企业可以买进就卖出吗
  • mongodb 入门
  • 数据库 sql优化
  • 织梦模板首页logo修改
  • 基于法律行为的物权变动模式包括
  • 发票开预付卡充值可以计入费用吗
  • 多提的增值税该怎么做账
  • 预缴所得税年底处理账务吗
  • 印花税计入税金及附加科目吗
  • 劳务费发票可以抵扣吗?
  • 研发费用怎么入帐
  • 海关双抬头进口增值税发票如何抵扣
  • 全资子公司变成孙公司是利好吗?
  • 机票的退票费会退到哪里
  • 工程结算在资产中的作用
  • 对外销售产品会计分录
  • 企业印花税率
  • 提前还贷款要满十八岁吗
  • 注销股本对所有股票影响
  • 新公司建立 需要先做哪行
  • 暂估入账后续处理
  • ubuntu怎么装
  • win8语言栏不见了 怎么调出来
  • 卸载步骤
  • windows route metric
  • elf.exe是什么程序
  • xp系统java环境变量配置
  • win10系统预览版
  • Linux 后台执行程序如何操作?
  • bootstrap treeview 扩展addNode方法动态添加子节点的方法
  • 使用div+css进行网页布局的三种方式
  • js中...用法
  • 画廊作品
  • 如何检查自己是否抑郁
  • javascript入门教程
  • unity3d总结
  • ssh执行远程命令 参数
  • linux curl命令详解
  • 领导班子和领导干部的区别
  • 吉林省残疾人保障金减免政策
  • 土地增值税计税
  • 汽车买保险车船税是什么意思
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设