位置: 编程技术 - 正文

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

  • 2021成品油增值税计算
  • 银行结息计入什么费用
  • 代开增值税票普票专票税点一样吗
  • 企业如何列支个人收入
  • 如何在电子税务局开发票
  • 房屋租赁合同印花税谁交
  • 发行债券的会计要素
  • 记载资金的账簿要交印花税吗
  • 固定资产明细账怎么填
  • 冲销成本结转需要什么凭证
  • 劳务发票未收到做账
  • 三级科目称为子目吗
  • 总账中余额为负怎么写
  • 土地罚款可以计入成本吗?
  • 公司股权转移怎么办理
  • 广告费用的增值税税率
  • 给货代付海运费手续费怎么算
  • 意外险部分费用怎么算
  • 财产保险费发票税率
  • 个人开劳务发票几个点
  • 保理利息开具增值税专用发票
  • 一般纳税人财务报表申报流程
  • 非房地产企业转让旧房土地增值税
  • 物流公司的保险服务属于什么费用
  • 收到政府征地补偿款
  • 进项税额多出来怎么处理
  • 企业所得税法如何确认应税收入
  • 应付职工薪酬年底怎么结转
  • 腾讯电脑管家流量监控不显示
  • 电脑怎么更新系统日期
  • 医疗保险中的大病保险怎么报销
  • 收到借出款利息会计分录
  • 评估报告怎么算合法
  • 抵押房屋可以出卖吗
  • 印花税的征收范围
  • 国家减免税款怎么申请
  • php实现用户登录
  • 员工旅游的费用可以税前扣除吗
  • php发送邮箱
  • php链表的应用场景
  • torch测定
  • js遇到的问题
  • 专项应付款二级明细科目有哪些
  • 床垫可以开专票抵扣吗
  • openglskia是什么意思
  • 售价金额核算法的优点有
  • php用户评论
  • 过路费一定是要公司的车辆吗
  • 发票上一定要盖章吗
  • 使用SQL server创建数据库和表
  • 小规模年度企业所得税纳税申报表
  • 短期负债率和流动负债率
  • 计提坏账准备金是什么意思
  • 收到国库退款
  • 支付行业培训流程
  • 银行业现金流量表
  • 什么是折旧费
  • 记账簿的目的在于为企业
  • 当恢复系数e=1时碰撞属于什么碰撞
  • solaris newfs
  • bios是什么怎么设置
  • srvc32.exe - srvc32是什么进程
  • gws.exe是啥
  • win7系统无线网络
  • win7打开软件总提示错误怎么解决
  • javascript数组的应用
  • jquery怎么写
  • Android游戏开发pdf
  • css的transition和animation
  • cocos2d教程
  • 什么是馥芮白
  • jquery图片轮播无缝连接
  • js中的隐式类型转换
  • Centos6.8下Node.js安装教程
  • jquery 异步提交表单
  • 安卓监听文件读写
  • js怎么定义类
  • 税务评定等级a是缴纳多少
  • 单位个人所得税网上申报流程
  • 专用发票收款人可以盖私章吗
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设