位置: 编程技术 - 正文

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

  • 对公账户取现金怎么取
  • 汇算清缴哪些需要调增调减
  • 如何开银行卡账户
  • 母子公司的关联交易怎么看
  • 保理公司会计核算讲解
  • 贷款受托支付可以给股东吗
  • 价外费用的判断标准
  • 承包工程会计账务处理流程
  • 转让名额协议
  • 委托加工合同如何标注多个地址
  • 五险一金账务处理流程图
  • 什么费用需要进行摊销
  • 应付债券的利息调整怎么计算
  • 小规模纳税人纳税申报流程
  • 蔬菜销售收入免增值税吗
  • 预提 冲销
  • 经营范围外的业务可以开发票吗
  • 维修车间人员的工作总结
  • 合同资产对应的成本
  • 债券返售
  • 收到工伤保险怎么做分录
  • Win10时间显示到秒
  • 收到的销项负数要认证吗
  • 发票作废怎么申请退税
  • 怎么修改?
  • csrss是什么程序
  • 企业发生的利得和损失应计入所有者权益
  • 员工内部罚款有没有上限和下限
  • 资产减值损失的计算公式
  • threejs loader
  • 拉马克是哪国人
  • 不带息票据按面值入账
  • 税收变动作用
  • 未开票收入不申报处罚
  • vue引入文件路径@的意思
  • 政府代建项目税收政策
  • PHP mysqli_free_result()与mysqli_fetch_array()函数详解
  • php文件夹下所有文件下载
  • 命令行怎么管理员运行
  • 装修公司开的劳务发票
  • mysql命令的常用参数包括什么
  • Shading-JDBC、ShadingSphere、ShardingProxy 使用详解
  • 会计为什么不能有0
  • 处置废品收入税率
  • 买理财产品的风险
  • 公司从异地迁移到本地怎么向当地政府写申请
  • 分销佣金账务处理流程
  • 月末在产品生产成本会计分录
  • 出口样品未报关处罚
  • 汇率调节主要手段
  • 营业执照的注册号怎么查询
  • 销项税额和转出未交增值税余额怎么结转
  • 公司租的房子电费发票怎么开
  • 分公司是否需要独立核算
  • 通过T_sql语句向其中一次填入一条数据或一次填入多条数据的方式填充数据
  • 彻底删除win8应用商店
  • vista win
  • Mac怎么强制关闭窗口
  • win10升级win1
  • macu盘安装windows
  • Win7 64位系统声卡重装过程中出现失败的解决方法
  • linux操作系统安装包
  • win7宽带连接错误651怎么办
  • xp如何禁用445
  • linux如何装
  • 在对linux系统中dir
  • sparsomycin
  • node.js入门教程
  • JavaScript驾驭网页-DOM
  • dos中创建文件
  • python排列代码
  • python写出来的程序怎么用
  • js原型使用场景
  • 安卓 crash
  • 贵州省地方税务局历任纪检组长马平
  • 如何查询甘肃省清产核资系统扶贫项目资产金额
  • 汉口市中心
  • 水资源税征收标准2023
  • 从租计征房产税怎么申报
  • 个人的车租给公司保险可以入账吗
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设