位置: 编程技术 - 正文

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

  • 房产税计入哪个科目 新会计准则
  • 汇算清缴需补税
  • 预提费用的附件怎么做
  • 坏账准备计入营业外支出还是资产减值损失
  • 统一企业员工
  • 水费抵扣进项税税率是多少
  • 长期应付款是什么科目 借方
  • 货物抵扣货款分录
  • 快递售后是干嘛的
  • 一个企业只有收入没有支出合理吗
  • 上年度的印花税怎么计算
  • 进口后的技术服务费
  • 报刊杂志广告文案写作
  • 浅析税收滞纳金问题的政策法规
  • 误餐补助有限制性的规定吗
  • 税收征管法关于全款未收房的规定
  • 个人缴纳的公积金可以贷款吗
  • 会计做账中记账表怎么做
  • 租赁固定资产折旧计入
  • 采用支付手续费方式委托代销商品
  • 什么叫非成品油发票
  • 生育津贴还扣税吗
  • 被扣留的质保金怎么办
  • 库存商品转结
  • 项目工程会计账务处理
  • 在win7系统中如何让电脑恢复出厂设置方法
  • 高新企业研发费用占销售收入的比例
  • win10怎么调出命令行窗口
  • mac清理垃圾怎么清理
  • php企业管理系统
  • 商品购进核算
  • PHP:imagefontheight()的用法_GD库图像处理函数
  • php设置图片将图片居中
  • 投资性房地产如何计提折旧
  • 同一控制下企业合并发生的审计费用计入
  • 实收资本本年利润属于什么科目
  • yolov5m
  • 工会经费相关问题有哪些
  • apt-key is deprecated
  • GCC strict aliasing – 嫉妒就是承认自己不如别人
  • 数学建模python 怎么用
  • 新会计准则增加了哪些科目
  • 期初未分配利润在哪个表
  • 增值税税点怎么算3个点
  • protobuf 文档
  • python如何运用
  • 企业所得税汇算清缴表
  • MySQL数据库结构设计图
  • 简易征收应纳税额
  • 工会应付下级经费
  • 私人出租房子发圈文案
  • 固定资产账实不符违反的规定
  • 存货质押融资的公司有哪些
  • 投资利润率多少算合理
  • 进口关税如何记账
  • 建筑业异地预缴税款最新规定
  • 哪些可以做进项税
  • 取暖费用摊销吗
  • 营业外收入算未开票收入吗
  • 原始凭证填制的基本内容
  • win2003开启远程桌面
  • win7如何创建文件夹
  • ubuntu虚拟机与windows共享文件
  • windows 高分屏
  • CentOS中-bash: lsb_release: command not found错误的解决方法
  • 用linux配置ftp服务器的过程
  • nodejs模拟浏览器环境
  • 如何使用蓝牙耳机
  • js两个函数互相调用
  • vue组件的使用步骤
  • c#程序例子
  • html如何用css
  • bootstrap按钮图标
  • 陌陌2021年最近事件
  • 税务局24小时人工服务电话
  • 可以抵扣的消费税项目
  • 货车可申请停保吗
  • 地税局属于市直单位吗
  • 煤炭资源税税率选煤税率多少黑龙江
  • 武汉 工资 税
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设