选择项目模板,填写包名、版本、描述、作者、许可证和仓库地址,自动生成 scripts、exports、types、bin、files、engines 等字段;同时校验包名和版本号是否符合 npm 的规则,并在下方解释每个字段的作用。适合新建项目和准备发布 npm 包时使用。
| 字段 | 作用 |
|---|---|
name | 包名,小写字母、数字、- . _,不超过 214 个字符;带组织前缀的写法为 @组织/包名,发布公开的作用域包要加 --access public |
version | 语义化版本:主版本号.次版本号.修订号,不兼容的改动升主版本,新增功能升次版本,修复问题升修订号 |
type | "module" 时 .js 文件按 ES 模块(import / export)处理,否则按 CommonJS(require)处理 |
exports | 包的入口,可以分别为 import 和 require 提供不同的文件,并限制外部只能引用列出的路径;优先级高于 main 和 module |
types | TypeScript 类型声明文件的位置;在 exports 中,types 条件要写在最前面 |
bin | 命令行工具的命令名和对应的脚本,全局安装或 npx 运行时可用,脚本第一行需要 #!/usr/bin/env node |
files | 发布时包含的文件,没有列出的不会上传;可以用 npm pack --dry-run 预览发布内容 |
sideEffects | false 表示包中的模块没有副作用,打包工具可以放心删掉未使用的代码 |
engines | 需要的 Node.js 版本,配合 engine-strict 可以阻止在旧版本上安装 |
packageManager | 项目使用的包管理器和版本,执行 corepack enable 后会自动使用这个版本 |
private | true 时 npm 会拒绝发布,用于应用项目和 Monorepo 的根目录 |
各包管理器的命令对照见 npm、pnpm、yarn、bun 命令对照表,项目说明文档可以用 README 生成器 生成,忽略文件可以用 .gitignore 生成器。
点选项目模板,填写包名、版本、描述、作者、许可证、仓库地址、关键词、Node 版本和包管理器,勾选是否为 ES 模块、私有项目和无副作用;右侧实时生成 package.json,下方提示包名和版本号的问题。
表示项目中的 .js 文件按 ES 模块处理,可以使用 import 和 export。
exports 可以分别为 import 和 require 指定入口并限制可引用的路径,优先级高于 main。
在 package.json 中设置 publishConfig.access 为 public,或者发布时加 --access public。
0.x 表示还在开发阶段,接口可能随时变化,^0.1.0 只会升级到 0.1.x。
生成的依赖版本是 2026 年 10 月的最新主版本,实际项目中请按需调整;scripts 中的构建命令以模板中列出的工具为准。
所有内容在浏览器本地生成,不会上传。
发布时报 403 或包名已存在,说明名称已被占用,可以换个名字或使用 @组织名/ 前缀。
CHANGELOG 生成器 · CSS Transform 变换生成器 · .gitignore 生成器 · .htaccess 生成器 · 全部开发工具