package.json中bin的用法

本文介绍了package.json中bin属性的用途,它用于定义命令行工具的可执行文件。通过设置bin字段,可以将命令映射到本地文件,例如将'demo.js'映射为'demo'命令。当使用npm或yarn安装包时,bin字段指定的文件会被链接到相应路径,使得可以直接通过命令执行。要使命令全局可用,可以使用npm install -g或npm link。示例中展示了如何创建并使用自定义命令。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

最近在写一些自动化脚本,研究了一下package.json中bin的用法
之前了解到的npm link,是给bin属性赋值cli.js,然后将用文件夹名称当作命令就可以执行cli.js,但如果想用其他的命令而非当前文件夹名称就需要对bin属性重新配置。
在项目根目录下新建demo.js

#!/usr/bin/env node
function run () {
   console.log('cli demo');
}
run();

#!/usr/bin/env node 这段话的意思是让使用 node 进行脚本的解释程序。
package.json

 "bin": {
    "demo": "demo.js"
  },

这样我们只要运行npm link就可以使用demo这个命令了。

bin 字段是命令名到本地文件名的映射。在安装时,npm 会将文件符号链接到 prefix/bin 以进行全局安装或./node_modules/.bin/本地安装。
当我们使用 npm 或者 yarn 命令安装包时,如果该包的 package.json 文件有 bin 字段,就会在 node_modules 文件夹下面的 .bin 目录中复制了 bin 字段链接的执行文件。我们在调用执行文件时,可以不带路径,直接使用命令名来执行相对应的执行文件。
如果想要打成全局包才可以使用该命令,打成全局包的命令

npm install . -g

或者

npm link
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值