位置: 编程技术 - 正文

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

  • 其他负债是流动负债还是非流动负债
  • 按月支付劳务费开发票
  • 土地价款抵扣增值税怎么做账
  • 背书行为有效的是指什么
  • 发票第二年是否可以作废
  • 递延所得税转回的会计分录
  • 建筑企业外地预缴
  • 单式记账法可以进行试算平衡吗
  • 房地产企业广告费扣除基数
  • 科技人员股权奖励
  • 股权投资基金账户有监管吗
  • 劳务收入个税的计算方法
  • 事业单位大型修缮会计分录
  • 项目部租房办公应计入什么费用
  • 汽车行业保险丝
  • 生产中的原料回收如何做会计帐务处理?
  • 园林绿化税收减免政策
  • 小规模纳税人购进商品的会计分录
  • 2017企业所得税小微企业优惠政策
  • 简述增值税纳税义务发生时间
  • 零申报还需要交税吗
  • 用于采购的借款账户
  • 单位内部控制
  • 普通支票如何转账
  • 不动产增值税计算公式
  • 其他业务收入怎么申报增值税
  • 利息支出属于生产成本吗
  • 房产证办理流程图
  • 补缴以前年度公积金误入当年费怎么办
  • 赔付支出有哪些
  • 预付办公用品费用,未收到发票
  • php实现的浏览器有哪些
  • php获取给定日期函数
  • html制作网页教程
  • win10系统安装配置
  • thinkphp5框架介绍
  • 有什么办法解决前进中的问题
  • html列表去掉点
  • phpcms怎么修改模板风格
  • 房地产企业的开发成本和开发费用有什么区
  • 持续经营利润是什么意思
  • 报销加油费怎么做账
  • 网红产品的推广文案
  • 六税两费减半征收政策
  • 成本核算需要哪些单据
  • 以前年度亏损要调整吗
  • 一般纳税人购销合同印花税减免政策
  • 个税手续费返还要交企业所得税吗
  • 接受银行承兑汇票的流程
  • sqlserver设置简单模式
  • 数据库用户名称
  • 农产品委托代销增值税怎么算
  • 小数点引起小数大小变化
  • 土地增值税预缴计算方法70号公告
  • 社保退休金计算方法
  • 基本建设费用的组成
  • 银行代扣水费分录
  • 服务行业进项税额加计扣除
  • 公司购买汽车的购置税可以抵税吗
  • 继续教育专项扣除标准是多少
  • sqlserver数据库脚本
  • Fedora 21顶栏日期显示不全的解决方法
  • windows2000修改ip
  • cmos密码是什么
  • bios设置USB启动英文
  • win10默认edge浏览器
  • winxp怎么自动开机
  • 找回失窃的书本任务
  • win7系统删除文件夹怎么恢复
  • win7更新补丁80072efe
  • win8.1应用商店无法连接网络
  • 元素显示模式
  • unity摄像机在哪里
  • jquery技巧
  • javascript运用
  • JavaScript基础教程
  • android有哪几个特点
  • 破产重整期间的税收
  • 下载广东省电子税务局appp
  • 玉石手镯零售环保要求
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设