npm包自定义执行命令

在创建 npm 包时,你可以自定义一些执行命令让用户在安装包后能够直接调用。这些命令定义在包的 package.json 文件的 bin 字段中。自定义命令允许你为包提供一个或多个执行入口点,通常用于构建命令行工具。

这里是如何自定义执行命令的一个步骤:

  1. 创建可执行的文件 : 首先,你需要一个可执行的 JavaScript 文件。记得在文件的顶部添加 #!/usr/bin/env node 这行,它是一个 shebang(哈希磅),用来告诉操作系统使用 Node.js 执行环境来运行这个文件,否则他将尝试使用默认改的shell执行,而不是node.js,可能会导致语法错误。

    javascript 复制代码
    #!/usr/bin/env node
    // mycli.js
    console.log("Hello from my command-line tool!");
  2. package.json 中配置 bin 字段 : 在你的 package.json 中,添加一个 bin 字段来指定命令名称和对应的文件路径。

    json 复制代码
    {
      "name": "my-cli-tool",
      "version": "1.0.0",
      "bin": {
        "mycli": "./bin/mycli.js"
      },
      // 其他配置项...
    }

    在这个例子中,命令的名称是 mycli,当包被安装后,用户可以在命令行里直接运行 mycli 来执行 ./bin/mycli.js 文件。 当你在你的项目中安装这个包时,在node_modules/.bin目录下会查看到mycli。在项目根目录下执行命令可以查看项目下的所有可执行命令。

bash 复制代码
ls node_modules/.bin
  1. 设置文件权限: 确保可执行文件具有执行权限。你可以通过以下命令来设置这个权限:

    bash 复制代码
    chmod +x ./bin/mycli.js
  2. 安装并测试你的命令: 本地测试你的命令可以通过将包链接到全局路径来完成。在包的根目录下运行:

    bash 复制代码
    npm link

    这会创建一个全局的符号链接到你的包。之后,你就可以在命令行中输入 mycli 来运行你的命令了。如果命令执行成功,你会看到输出 "Hello from my command-line tool!"。

  3. 发布到 npm : 一切就绪之后,你可以使用 npm publish 命令来发布你的包到 npm。当其他用户通过 npm install -g my-cli-tool 全局安装你的包时,mycli 命令会通过创建软连接的方式自动添加到他们的 PATH 环境变量中,使得该命令在任何位置都可以被调用。本地项目安装npm install my-cli-tool,mycli命令会被添加到node_modules/.bin目录中。 npm package.json中的bin

通过这种方式,开发者可以方便地创建和分发命令行工具,为其他用户提供便利的命令行操作。

相关推荐
LisEcho19 小时前
yoyoj-rn — RN 的脚手架工具可以不是 @react-native-community/cli
前端·react native·npm
醉风塘19 小时前
NPM:从“模块之痛”到“生态之基”的演化史
前端·npm·node.js
水冗水孚19 小时前
通俗易懂地谈谈,前端工程化之自定义脚手架的理解,并附上一个实践案例发布到npm上
javascript·npm·node.js
蚂蚁不吃土&19 小时前
cmd powershell svm nodejs npm
前端·npm·node.js
Lucky_Turtle2 天前
【Node】npm install报错npm error Cannot read properties of null (reading ‘matches‘)
前端·npm·node.js
水冗水孚2 天前
20张图的保姆级教程,记录使用Verdaccio在Ubuntu服务器上搭建Npm私服
npm
Irene19913 天前
npm 完整生命周期脚本及特点
npm·生命周期
登山者4 天前
npm发布报错急救手册:快速解决2FA与令牌问题
前端·npm
Asurplus4 天前
【VUE】15、安装包管理工具yarn
前端·vue.js·npm·node.js·yarn
fpl11164 天前
npm :无法加载文件 D:\...\nodejs\npm.ps1,因为在此系统上禁止运行脚本
前端·vscode·npm·node.js·命令模式