package.json 的核心是 name 和 version 字段,必须符合 npm 规范;scripts 定义命令,dependencies/devDependencies 区分运行与开发依赖;main/module/exports 控制模块入口,types 提供类型定义;private、engines、browserslist 等提升环境一致性。

直接在 package.json 里写配置,JavaScript 本身不“配置”它——但你可以用 JS 脚本动态生成、读取或修改它,常见于构建流程、CI/CD 或初始化工具中。真正起作用的是 package.json 文件本身的 JSON 结构,Node.js 和 npm/yarn/pnpm 都按规范解析它。
必填字段:name 和 version
这是发布到 npm 的硬性要求,哪怕本地开发也建议保留:
- name:包名,小写字母、短横线、下划线组成,不能含空格;若发布,需在 npm 上未被占用
-
version:遵循 SemVer 2.0(如
"1.2.3"),npm 安装、升级、依赖解析都依赖它
核心功能字段:scripts 和 dependencies
这两个字段决定项目怎么跑、依赖怎么装:
-
scripts:定义可执行命令,比如
"start": "node index.js",运行时用npm start;支持组合("build": "tsc && vite build")和钩子(prebuild/postbuild) -
dependencies:生产环境必须的包,安装时加
--save(npm v5+ 默认行为);上线时会被打包或 require,删掉会导致运行时报错 -
devDependencies:仅开发时需要,如
typescript、vite、eslint;上线一般不包含,减小部署体积
模块与入口字段:main、module、exports 和 types
影响其他项目如何引入你的代码:
立即学习“Java免费学习笔记(深入)”;
-
main:CommonJS 入口(如
"dist/index.js"),require 时默认加载这个 -
module:ESM 入口(如
"dist/index.mjs"),现代 bundler(Vite、Webpack)优先用它做 tree-shaking -
exports(推荐替代 main/module):更精细控制导出,支持条件导出(
"import"/"require"/"types"),例如:
{
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.js",
"types": "./dist/index.d.ts"
}
}
}
- types 或 typesVersions:TypeScript 类型定义文件路径,让 TS 编译器能自动找类型
其他实用字段:private、engines、browserslist
提升协作与环境一致性:
- private: true:防止误发到 npm(尤其内部项目),npm publish 会跳过它
-
engines:声明 Node.js 和 npm 版本要求,例如
"node": ">=18.0.0",安装时会警告不匹配环境 -
browserslist:前端项目常用,告诉 Babel、Autoprefixer 等工具目标浏览器范围(如
"> 1%, last 2 versions, not dead")
基本上就这些。不需要一次性填满所有字段,按需添加即可。关键不是字段多,而是 name/version 准确、scripts 可用、dependencies 清晰、exports/types 对齐实际产物结构。










