Node.js / 系统课时
初始化 npm 项目
初始化 npm 项目
初始化 npm 项目的目标,是在项目根目录建立一份可被 npm 和 Node.js 共同识别的 package.json,并把名称、入口文件、模块类型等关键约定写清楚。完成后,你应能用命令生成清单、修改字段,并判断 main、type、scripts 分别控制什么。
学习目标
- 使用
npm init -y创建package.json,并用npm pkg修改和读取字段。 - 理解
name、version、main、type、private与scripts的实际作用。 - 能在初始化后检查项目配置,避免把包入口和应用启动命令混为一谈。
建立最小项目
以下示例适用于 npm 10~12。npm init -y 会跳过交互式问答直接生成 package.json;不同 npm 版本和本机 init-* 配置可能让初始字段略有不同,因此示例随后显式写入本课需要的关键值。
mkdir npm-basics-demo
cd npm-basics-demo
npm init -y
npm pkg set name=npm-basics-demo main=src/index.js type=module
npm pkg set private=true --json
npm pkg get name main type private预期结果:最后一条命令应返回下面四个字段;npm init -y 自身打印的完整清单可能因 npm 版本或用户配置不同而略有差异。
{
"name": "npm-basics-demo",
"main": "src/index.js",
"type": "module",
"private": true
}如果准备发布到 npm registry,不要把 private 设为 true;如果只是课程练习、后端服务或公司内部应用,保留 private: true 能降低误发布风险。
看懂关键字段
package.json 必须是合法 JSON。下面是一份可直接保存的最小配置示例,其中 scripts.start 假设项目稍后会创建 src/index.js。
{
"name": "npm-basics-demo",
"version": "1.0.0",
"main": "src/index.js",
"type": "module",
"private": true,
"scripts": {
"start": "node src/index.js"
}
}配置生效行为可以按下表检查。name 和 version 在发布包时共同标识版本;不发布的应用也建议保留清晰名称,便于日志、工作区和依赖工具识别项目。
| 字段 | 示例值 | 实际作用 |
|---|---|---|
name |
npm-basics-demo |
项目或包名称;发布到 registry 时必须满足 npm 命名规则 |
version |
1.0.0 |
语义化版本号;发布包时与名称共同标识一个版本 |
main |
src/index.js |
包被其他代码加载时的传统主入口;缺省时 npm 文档约定为根目录 index.js |
type |
module |
告诉 Node.js 如何解释该包范围内的 .js 文件;module 使用 ESM,commonjs 使用 CommonJS |
private |
true |
阻止该项目被 npm 正常发布 |
scripts.start |
node src/index.js |
定义 npm start 要执行的命令 |
分清入口与模块类型
main 不是“Node 启动项目时自动执行的文件”。它主要描述这个包被其他代码当作包加载时的传统入口;应用真正执行什么,通常由 node <文件>、npm start 或其他 scripts 命令决定。把 main 改成某个文件,并不会让 npm start 自动跟着改变。
type 则直接影响 .js 的模块语义。设置为 module 后,可以在 .js 中使用 import、export;设置为 commonjs 时使用 require()、module.exports。新项目最好显式写出 type,不要依赖不同 Node.js 版本对模糊 .js 文件的推断行为。
初始化后立刻检查
初始化完成后,先确认项目根目录存在 package.json,再执行 npm pkg get name version main type private 检查关键字段。对于团队项目,还应把 package.json 纳入版本控制;后续安装依赖时生成的 package-lock.json 通常也应提交,而 node_modules 不需要提交。
如果 npm init 生成的名称不是你想要的,不必重新初始化,直接执行 npm pkg set name=新名称 即可。字段修改完成后再继续安装依赖,可以避免锁文件、脚本和工作区围绕错误名称继续扩散。