位置: 编程技术 - 正文

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

  • 亏损企业需要计提递延所得税资产吗
  • 出口退免税管理工作规范2.0
  • 网络贷款需要交钱吗
  • 增值税小规模纳税人认定标准
  • 公司附加税怎么计算
  • 个人所得劳务报酬税率
  • 银行存单丢失怎么办理取款
  • 厂房设计费计入在建工程吗
  • 周转材料登三栏式明细账吗
  • 没有发票的福利有哪些
  • 快递公司增值税怎么算
  • 个体工商户核定应税所得率
  • 出租车公司给车都上什么保险
  • 房地产并购的税率是多少
  • 旅行社代订机票怎么做账
  • 递延所得税企业合并
  • 自查补缴税款严重吗
  • 对方已认证的发票在哪里
  • 成本无发票如何处理
  • 取得免税农产品进项税转出
  • 增值税附加税怎么计提
  • 公司注销清算债权委托另一股东处理
  • 远期汇票的付款期限可以表示为
  • 技术服务收入和产品服务收入举个例子
  • 无法卸载系统更新 backup
  • 国税增值税定额计算公式
  • 工程项目发包是什么意思
  • 原材料暂估入账产生的差异如何处理
  • 对公账户发放工资要固定几号打吗
  • 报废汽车残值收入的商品编码编码
  • 辅导期一般纳税人标准
  • javascript语言基础
  • 增值税缓交政策
  • php实现快速排序算法
  • ps快速选择工具抠图后怎么拉出来
  • 发票作废发票怎么处理
  • 购置固定资产支付的现金属于投资活动产生的现金流量吗
  • 制造费用转入什么
  • 怎么应对降税行业
  • mongodb4
  • 归属净利润和扣非净利润看哪一个
  • 缴存的提存金是什么
  • php出现错误代码怎么办
  • SQL查询中in和exists的区别分析
  • 研发辅助账汇总表
  • 场地无偿使用证明的作用是什么
  • 存货跌价准备如何影响利润
  • 委托加工以受托方核定的数量为计税依据
  • 代销手续费如何做分录
  • 员工上班的停车费谁出
  • 应收账款应付账款可以抵消吗
  • 营业外支出明细账应该采用的格式是
  • 防伪税控技术服务费减免的文件
  • 行政单位年结
  • 税金及附加有啥
  • 资本增值率计算公式是什么?
  • MySQL必知必会读后感
  • mysql如何修改默认值
  • win10两个网络怎么选择网络
  • linux的用户
  • 获取方法
  • win7系统怎么设置微信多开
  • nginx 虚拟ip
  • PasSrv.exe - PasSrv是什么进程 有什么用
  • linux消息队列阻塞
  • javascript definitive guide
  • node搭建博客
  • js 获取ua
  • android的handler
  • 怎样用div css制作网页
  • vue实现下载功能
  • android设置背景颜色代码
  • Android platform build guide for Exynos-4412(odroid -X/X2/U2/U3/Q2/Q)
  • unity3d初学者教程视频
  • 一个绿色的球英语怎么读
  • JavaScript Try...Catch 声明的 使用方法
  • 如何用python做图像处理
  • 何为价外费用
  • 一般纳税人资格查询
  • 货车违章查哪个部门
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设