JavaScript npm package.json bin 怎么配置

夏辰酱_9001

夏辰酱_9001

2026-11-21

119人浏览

原创

在 package.json 中配置 bin 字段,可以将脚本映射为全局可执行命令。只需将 bin 设为一个对象,键名即为你希望使用的命令行名称,值则是相对于包根目录的脚本路径。安装该包后,npm 会自动创建指向这些脚本的符号链接或包装脚本。

JavaScript npm package.json bin 怎么配置

如何定义单个命令并指定入口文件

要定义单个命令,需要在 package.json 中添加 bin 字段,其值为一个对象。对象的键是命令名,值是入口文件的相对路径。例如,若有一个名为 cli.js 的文件位于包根目录,且你想通过 my-tool 来调用它,配置如下:

JavaScript npm package.json bin 怎么配置

{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "description": "A simple CLI tool",
  "main": "index.js",
  "bin": {
    "my-tool": "./cli.js"
  },
  "files": [
    "cli.js"
  ],
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

确保 cli.js 文件具有可执行权限(在 Linux/macOS 上需运行 chmod +x cli.js),并且第一行包含 shebang(如 #!/usr/bin/env node)。这样,当用户运行 npm install -g . 时,系统就能识别 my-tool 命令。

如何配置多个命令共享同一个入口

如果希望多个命令别名指向同一个脚本,可以在 bin 对象中定义多个键,但它们的值都指向同一个文件。例如,同时支持 my-tool 和 mt 两个命令:

JavaScript npm package.json bin 怎么配置

从网页中提取schema.org、Open Graph和JSON-LD元数据以用于索引
从网页中提取schema.org、Open Graph和JSON-LD元数据以用于索引

使用 extruct 从原始 HTML 中提取机器可读的元数据,以便代理可以在不依赖脆弱的全页解析的情况下对页面进行分类、去重或丰富。它最适合元数据采集工作流,而不适用于爬取整个网站或渲染 JavaScript 密集型页面。

下载
{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "bin": {
    "my-tool": "./cli.js",
    "mt": "./cli.js"
  },
  "files": [
    "cli.js"
  ]
}

这种配置下,cli.js 需要能够区分被调用的命令名。通常可以通过检查 process.argv[1] 来获取实际执行的命令路径,从而决定行为。例如:

const fs = require('fs');
const path = require('path');

// 获取当前执行的脚本路径
const scriptPath = process.argv[1];
const scriptName = path.basename(scriptPath);

console.log(`Command executed: ${scriptName}`);

if (scriptName === 'my-tool') {
  console.log('Running my-tool specific logic');
} else if (scriptName === 'mt') {
  console.log('Running mt specific logic');
} else {
  console.log('Unknown command');
}

这样,无论用户输入 my-tool 还是 mt,都会执行同一段代码,但可以根据命令名做出不同响应。

当入口文件不存在时会发生什么

如果在 package.json 中指定的入口文件路径不存在,npm 在安装过程中会抛出错误,导致安装失败。例如,若 bin 配置为 {"my-tool": "./nonexistent.js"},而 nonexistent.js 文件并未创建,则运行 npm install -g . 时会看到类似以下的错误信息:

npm ERR! code ENOENT
npm ERR! syscall open
npm ERR! path /path/to/package/nonexistent.js
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, open '/path/to/package/nonexistent.js'
npm ERR! enoent This is related to npm not being able to find a file.

因此,务必确保 bin 字段中指定的所有文件都存在,并且路径正确。可以使用 files 字段明确列出需要发布的文件,以避免遗漏。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java js json npm

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

6146

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1469

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

6064

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1100

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2076

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

4145

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5493

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3640

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1168

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.9万人学习