package.json 生成器
指导
package.json 生成器
创建一个有效的 package.json 从结构化表单而非死记硬背每个字段开始。设置包名、版本、许可证、模块系统(ESM 或 CommonJS)、Node 引擎、脚本和依赖项,工具将生成一个整洁、顺序正确的清单,可直接放入项目中。
与重排现有文件的格式化器不同,此生成器从头开始构建清单,并跳过空字段,因此您将获得一个最小化、可发布的文件,已遵循 npm 用于的约定。 npm init.
如何使用
- 输入包名、版本以及(可选)描述和作者。
- 选择许可证并选择 ES 模块 或 CommonJS 用于模块系统。
- 设置入口文件(例如
index.js)以及一个如>=18. - 的 engines.node 范围
dev,build,test,start填写您实际使用的脚本( - )——留空则省略。
name@range添加依赖项和 devDependencies 为 - ,每行或逗号分隔。
package.json.
特征
- 选择缩进(2 个空格、4 个空格或制表符)并复制或下载生成的 基于表单的
- ESM 或 CommonJS – 切换模块系统,工具会相应设置
"type": "module"和module入口。 - 智能脚本 – 空脚本字段被删除,而不是保留为
""占位符。 - 依赖项解析 – 粘贴一个
package@^1.2.3列表,它们将被整理为一个整洁的dependencies对象。 - 仓库助手 – 输入一个 GitHub URL,生成器会自动填充
repository,bugs,并且homepage。 - 私有标志 – 一键标记包为私有,以防止意外发布
npm publish. - 按缩进方式选择 – 输出为 2 个空格、4 个空格或制表符,以匹配您仓库的现有风格。
- 复制或下载 – 以文本形式获取结果或直接下载
package.json。
常问问题
-
依赖项和 devDependencies 之间的区别是什么?
dependencies是您的代码在运行时导入的包,消费者在使用您的包时也会安装。devDependencies是您仅在开发或构建项目时需要的工具——如打包器、测试运行器、类型检查器——这些包在他人添加您的包到其项目时不会被安装。 -
将 type 设置为 module 实际上做了什么?
环境
"type": "module"告诉 Node.js 将包中的文件视为 ES 模块,因此.js可以原生运行。如果没有它,Node 会将其视为 CommonJS,您必须使用import且export。ES 模块还支持顶层.js和更严格的文件解析。require/module.exports为什么 package.json 使用语义版本?await语义版本(MAJOR.MINOR.PATCH)为消费者提供了契约:PATCH 增量应为安全的修复,MINOR 增加了向后兼容的功能,MAJOR 表示破坏性变更。范围操作符如 -
依赖于此契约,因此 npm 可以在不破坏构建的情况下安装兼容的更新。
engines 字段有什么作用?
^且~字段声明您的包支持的 Node.js(或其他运行时)版本。npm 和许多工具在安装器版本不受支持时会发出警告,某些平台甚至完全拒绝安装。明确设置 -
范围可防止因新版本 Node 提供的 API 而引发的微妙错误。
这
enginesmy-packagenode包的简要说明
