nodejs打造cli工具

2023-11-17


前言

使用nodejs打造cli工具

  1. 本文意指通过实现一个简单的cli工具来了解nodejs可执行程序,而不是工程化具体的实现
  2. 本文适合node新人小白,以及学了nodejs却不知道该做点什么的同学

项目先体验

先看看我做了什么,再来学习怎么做,目前我已经将工具发布到npm,快人一步抢先体验
在任意路径中打开终端输入:

npx @singh-liu/zlib-file -h

在这里插入图片描述
可以看到终端提示了对应的命令,zlib-file 就是用来压缩和解压文件的工具。如果你执行了对应的命令,终端将与你进行问答式的交互命令,最终根据你输入的结果执行命令
在这里插入图片描述


可执行的node程序

不管你是在终端中运行node xxx.js或者是webpack, creat-react-app等。首先这是执行在shell脚本,如果我们很随意的输入不存在的命令,那么终端会提示你这不是内部或外部命令,也不是可运行的程序。

nodejs在安装的时候就为我们配置好了PATH 环境变量,这允许我们在任意位置执行node xxx,所以实现node程序的第一步是创建一个全局的命令并向shell脚本解释我们应用的程序是nodejs,具体实现写在实践中~

项目实践

项目初始化

首先我们来新建一个文件取名myzlib,然后在该目录内打开终端初始化npm
执行命名 npm init -y 得到package.json文件

执行命令npm link
npm link允许我们以软链接的方式创建本地包和全局包之间创建符号链接,执行完毕后你可以在系统目录中找到对应文件(window下如图)

在这里插入图片描述
虽然链接上来了,当此时myzlib仍然不是全局命令,也不是可执行的程序。
先说可执行程序

如果软件包是可执行文件,该怎么办?
在这种情况下,它会把可执行文件放到 node_modules/.bin/ 文件夹下。
验证这一点的简单示例是 cowsay。
当使用 npm install cowsay 安装软件包时,它会在 node_modules 文件夹中安装自身以及一些依赖包:
如何执行这些文件?
可以输入 ./node_modules/.bin/cowsay 来运行它
npx cowsay ‘holle’

packge.json文件允许我们配置指定的bin文件,作为可执行文件

// packge.js 添加如下代码
{
  "bin": {
   "myzlib": "./bin/cli.js"
 },
}

新建bin/cli.js

// bin/cli.js
#!/usr/bin/env node
console.log("Hello World !") 

你显式地告诉 shell 使用 node 运行你的脚本。 您也可以使用 “shebang” 行将此信息嵌入到 JavaScript 文件中。 “shebang” 是文件的第一行,它告诉操作系统使用哪个解释器来运行脚本。 以下是 JavaScript 的第一行
#!/usr/bin/node
以上,我们显式地给出了解释器的绝对路径。 并非所有操作系统的 bin 文件夹中都有 node,但都应该有 env。 您可以告诉操作系统使用 node 为参数运行
#!/usr/bin/env node

重新执行一遍 npm link
在任意位置打开cmd输入myzlib都能够运行文件输出"Hello World !"
这个时候我们再看系统路径
在这里插入图片描述
其中myzlib.cmd作为全局的命令脚本,其内容指向了可执行程序bin/cli.js
这些都是npm link帮我们生成的


总结

整个cli的运行链路由全局命令脚本指向可执行文件可执行文件再由“shebang”告诉操作系统使用nodejs来运行脚本

项目初始化讲完就没了?
是的时间关系不想讲了,如果你已经成功输出"Hello World !"那么只需要clone一下我的代码就能学会了
https://gitee.com/liu_xin-1995/zlibfile/tree/master

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

nodejs打造cli工具 的相关文章

  • Node.js 中没有请求状态 Morgan Logging

    我正在 Azure VM 上运行 node js 应用程序 使用 PM2 处理负载平衡和重新启动 这是服务器设置和日志记录代码 var logger require morgan var app express app set views
  • 使用 NVM 安装多个版本的 node.js (Ubuntu)

    如何使用 Ubuntu 在 Ubuntu 中安装多个版本的 Node jsNVM https github com creationix nvm 先验知识 如何使用终端 例如 您可以使用gnome terminal 安装依赖项 sudo a
  • 将 sass 变量导入 gatsby 组件中引用的第二个 Sass 文件

    我正在使用 Gatsby 构建一个静态站点项目 我已经成功安装了 gatsby sass 插件并让 sass 正常工作 但是 我无法将自定义 sass 变量文件正确导入到其他组件 sass 文件中 下面是我的文件夹结构 src compon
  • 没有导出的成员/节点模块

    我刚刚开始使用 5 分钟快速入门找到的 Angular 2 Typescripthere https angular io docs ts latest quickstart html 我遇到了一个看起来很常见的问题 但可能有点不同 我遇到
  • http模块和express模块​​有什么区别?

    我正在学习 NodeJs http www tutorialspoint com nodejs http www tutorialspoint com nodejs 我无法理解使用 http 模块 get post 方法 与使用expres
  • Mongoose 重复且架构键唯一

    我想让关键项目在该集合中独一无二 但我无法正常工作 我在这里发现了类似的问题 task js function make Schema mongoose var Tasks new Schema project type String in
  • 获取telegram群组的所有用户

    我正在尝试获取电报组的所有用户 我看到方法 getChatAdministrators 但我认为 API 没有获取所有成员的方法 我正在使用nodejs的telegram bot api Telegram 机器人 API https cor
  • 有什么不同? .on“连接”与.on“连接”

    我很难理解以下之间的区别 io on connection function io on connect function 可能是一个相当原始的问题 但是我无法找到有关它的明确文档 很想了解其中的区别 这些是同一事物的不同名称 正如所写so
  • TypeError [ERR_INVALID_ARG_TYPE]:“listener”参数必须是 Function 类型

    我这里有一个小问题 events js 200抛出新错误 ERR INVALID ARG TYPE listener Function listener 类型错误 ERR INVALID ARG TYPE 侦听器 参数必须是类型 功能 收到
  • 通过 PHP 连接到 socket.io(nodejs)

    我需要通过 php 连接到 websocket 发送数据并立即断开连接 无需等待套接字的响应 我用了大象io http elephant io 但更新库后不起作用 请告诉我如何通过 PHP 连接到 websocket 我也遇到了这个问题 学
  • NodeJs读取JSON文件

    我正在使用 NodeJs 读取 json 文件 我的代码非常基本 var obj require sample json console log obj 0 Sample json 文件包含这样的字符串化 JSON sample good
  • IE8 和 9 上的 socket.io 问题

    Socket io 在除 IE8 和 9 之外的所有平台上都能完美运行 这是客户端要求 你们能帮忙解决这个问题吗 我一直在阅读所有类似的问题 但到目前为止我发现的大多数解决方案都无法解决 IE8 上的这个问题 这是结构 服务器端 var i
  • 错误:找不到模块“jasmine-core”

    我安装了以下内容进行测试 devDependencies jasmine core 2 4 1 karma 0 13 22 karma jasmine 0 3 7 karma phantomjs launcher 1 0 0 运行后karm
  • 全局未在 ../node_modules/socket.io-parser/is-buffer.js 中定义

    预先感谢您帮助我 我正在尝试在我的一个角度组件中连接套接字 但在浏览器的控制台中它会抛出一个错误 指出 Global 未在 Object node modules socket io parser is buffer js 中定义 这是我的
  • 无法使用 webpack 加载 Node 原生插件

    虽然我正在使用vue cli在生成 webpack 配置的示例代码中 没有任何特定于 vue 的内容 我像这样创建示例应用程序 vue init webpack webpack modules example 生成webpack base
  • 使用 Nodemailer 提交电子邮件时 NodeJs 错误

    我已按照以下步骤设置 Nodemailer 1 允许访问 Gmail 中安全性较低的应用程序 2 在app js中写入以下内容 app post reachus send function req res var transporter n
  • 使用 ObjectId 键和字符串数组定义映射作为 mongoose 模式中的值

    我在为数据库创建 Mongoose 架构时遇到问题 我想创建一个以 objectId 作为键 以字符串值数组作为值的映射 我能得到的最接近的是 var schema new Schema map myId type mongoose Sch
  • 计算两点之间的最短路线

    过去几周我一直在开发一款多人 HTML5 游戏 使用nodejs and websockets 我已经被这个问题困扰了一段时间 想象一下 我用数组实现了这个平铺地图 如下所示 1 or 棕色瓷砖 路上有障碍物 玩家无法通过 0 or 绿色瓷
  • 使用 Express.js 和 NodeJS,您可以通过响应正文中的重定向发送 JSON

    我正在尝试通过 302 重定向发送 JSON 在 ExpressJS 中这可能吗 API 声明可以添加主体res json 例如 res json 302 name larry 在接收端 重定向的目的地 主体是空的 这是一些示例代码 发送应
  • 在 React Web 应用程序中使用 createjs-soundjs

    我想用https www npmjs com package createjs soundjs https www npmjs com package createjs soundjs在 React Web 应用程序上播放声音 我正常安装了

随机推荐

  • QWidgetAction实现鼠标滑过菜单项图标高亮显示

    需求是鼠标滑过菜单项时 菜单项的文字 icon以及子菜单的小箭头都要高亮显示 qss中只能设置item背景色 文字颜色以及子菜单小箭头的样式 icon的图片不能切换 另外曾经想过用indicator 对action setCheckable
  • Ubuntu18.04安装QT5

    提示 文章写完后 目录可以自动生成 如何生成可参考右边的帮助文档 文章目录 前言 一 QT5是什么 二 安装包安装 1 下载安装包 2 安装QT5 3 运行 4 其他方式 总结 前言 最近在学习QT5 在Windows上的安装自然不必多说
  • 爬虫 — 反爬

    目录 一 UA 反爬 二 Cookie 验证与反爬 1 Cookie 简介 2 使用 Cookie 原因 3 Cookie 作用 3 1 模拟登录 3 2 反反爬 三 Referer 反爬 一 UA 反爬 UA User Agent 用户代
  • [机械]“重工业面临两大危机”——向文波(三一重工股份有限公司执行总裁)

    向文波 三一重工股份有限公司执行总裁 向文波是三一重工的掌门人 但深受徐工事件影响 他以业内的视角 适时地向中国重工业的改革发出一个警示信号 提出一个超越 抓大放小 国进民退 等传统国企改革的新命题 产业安全 引起了舆论与政府的重视 中国重
  • 2021.11.13-15总结

    将C语言文件相关的内容学完了 了解了文件相关的函数
  • linux网络管理

    一 网络接口 1 在Linux系统中 主机的网络接口卡通常称为网络接口 使用ifconfig命令来查看网络 2 eth0 是Linux系统中第一块以太网卡的名称 3 lo 是Linux系统中的 环回 网络接口 lo 并不代表真正的网络接口
  • 用户访问session分析-按session粒度进行数据聚合

    思路 之前模拟创建了两张表 user visit action 和 user info 对于user visit action表 1 通过用户传过来的指定日期范围内 从user visit action中查询出指定的用户访问数据 变成 ac
  • nginx根据url参数动态代理

    nginx根据url参数动态代理 请求url格式 其中参数proxy后面的url就是需要访问的真实地址 http localhost 9388 proxy http localhost 8038 Content layui font ico
  • 腾讯滑块识别-通用滑块识别

    遇到滑块问题 在写爬虫的时候 经常会遇到滑块问题 很多次都想过尝试如何攻破滑块 但是每次都没成功 除了最开始的极验滑块 当时通过原图和滑块图的对比 能够得出缺口坐标 但是随着极验 网易 腾讯滑块的更新 已经不能够找到原图了 下面给出滑块通杀
  • python的gui神器——gooey

    python的gui神器 gooey python自带的gui库 tkinter库 最近研究的gui库 gooey tkinter教程 tkinter GUI编程 gooey地址和教程 gooey 入门教程 python使用tkinter库
  • Android基础知识 - 内置SQLite数据库

    文章目录 SQLite数据库简单介绍 创建数据库 SQLiteOpenHelper类 简单概述 DatabaseTest项目 升级数据库 对表中的数据进行操作 添加数据 更新数据 删除数据 查询数据 使用SQL操作数据库 SQLite数据库
  • 03 xxl-job任务执行流程

    作业类型 xxl job支持七种作业类型 Bean GLUE Java GLUE Shell GLUE Python GLUE PHP GLUE Nodejs GLUE PowerShell 其中 GLUE类型作业都是在admin管理端编辑
  • Unity3d Survival Shooter Tutorial 学习笔记(八)---游戏结束

    1 在HUDCanvas下新建Image ScreenFader 设置为全屏显示 且颜色设置为浅蓝 2 添加GameOverText 并设置Text参数 3 调整HUDCanvas顺序 与就是渲染顺序 4 初始化时 把GameOverTex
  • 用Eigen库练习代数运算方式以便后续对刚体旋转和移动做基础

    include
  • qt背景渐变色的效果

    background color qlineargradient spread pad x1 0 y1 0 x2 0 y2 1 stop 0 87CEFA stop 1 292F38 背景颜色 画线部分可以达到渐变的效果图
  • CentOS 下安装 Docker

    要求 要安装 Docker 我们需要 CentOS 7 及以上的发行版本 建议使用overlay2存储驱动程序 卸载已有 Docker 如果你已经安装过旧版的 Docker 可以先执行以下命令卸载旧版 Docker sudo yum rem
  • sqli-labs解题大法29 ~40

    Less 29 堆叠查询 在一条语句之后加上分号 然后接下一条语句 可以一次执行多条语句 order by 排序 可以 联合查询 可以 参考Less 1 Background 6 服务器 两层 架构 http www cnblogs com
  • Linux笔记

    Linux 基础笔记 Linux文件目录 目录 描述 Linux系统根目录 bin usr bin 可执行二进制文件的目录 如常用的命令ls tar mv cat等 boot 存放Linux系统启动时用到的一些文件 如Linux内核文件 b
  • OR EXISTS语句的优化方法

    OR EXISTS语句的优化方法 这库一直很空闲 但无意中看了一下 发现其中很多语句都很有问题 都是典型的OR问题语句 如果并发量大的话 CPU一下子就飙高了 OR语句一直是性能杀手 当存在一两个的时候一般可以用union和union al
  • nodejs打造cli工具

    nodejs打造cli工具 前言 项目先体验 可执行的node程序 项目实践 项目初始化 总结 前言 使用nodejs打造cli工具 本文意指通过实现一个简单的cli工具来了解nodejs可执行程序 而不是工程化具体的实现 本文适合node