第 3 章 npm 与工程骨架:让项目可以“被安装”
本章版本:v0.2 本章产出:
package.json、目录结构、依赖清单、.gitignore、.env.example本章目标:理解 npm 的作用,学会初始化项目、安装依赖、区分运行依赖和开发依赖、用脚本管理命令。
3.1 npm:站在两百万个包面前
第三周,第二节课。李老师开门见山:“上节课你们自己写函数。今天开始,学用别人写的函数——但要学得清醒。”
“npm 全称 Node Package Manager,Node.js 自带的包管理器。装 Node.js 时它就一起装好了,上节课验证过 npm -v。”
npm 干两件事:
- 管理依赖。 想用别人写好的代码,
npm install 包名,它自动下载到node_modules,并记录进package.json。 - 管理项目脚本。 在
package.json的scripts里定义命令,比如npm run dev启动开发服务器。
“全世界超过两百万个开源包,几乎你需要的功能都有人写好了。”李老师环视教室,“但我要泼一盆冷水:包多,不等于都要装。”
陈金宝举手:“老师,我昨晚搜‘node 待办框架’,出来一个 star 两万的,直接装上行不行?”
“装之前看三件事:最近一次更新时间、周下载量、有没有已知漏洞。”李老师在黑板上写下三个词,“一个两年没维护的包,可能在新版 Node.js 上直接跑不起来。你图省事装它,它将来让你加班。”
思政小课堂:开源是“人人为我”,但用开源也要“我为人人”——遵守 license、及时上报问题、不滥用。站在巨人的肩膀上,别在巨人背上刻字。
3.2 创建项目文件夹
“现在,每个组创建一个期末项目文件夹。名字用英文,不要有中文和空格。”
- 待办事项:
todo-app - 博客:
blog-api - 图书管理:
library-api
“老师,我文件夹叫‘我的伟大项目🚀’行不行?”陈金宝问。
“你的电脑行,”李老师说,“别人的工具链不一定行。”
为什么不能用中文和空格?不是 Node.js 不支持,而是很多工具链——尤其部署、Docker、CI——对中文路径和空格的处理并不一致。轻则脚本报错,重则依赖安装失败。养成英文短名、短横线分隔的习惯,能省掉很多莫名其妙的麻烦。
用 VS Code 打开这个文件夹。“以后每节课都在这里写项目代码。上节课的 node-first-class 是练习文件夹,不许混。”
3.3 初始化 package.json
在项目根目录的终端里:
npm init -y
-y 表示全部用默认值。文件夹里多了一个 package.json:
{
"name": "todo-app",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
}
字段逐个讲:
name:项目名。只能小写字母、数字、短横线、下划线,不能有中文和大写字母。发布到 npm 时它必须唯一。version:版本号,默认1.0.0,遵循语义化版本主版本.次版本.修订号。main:入口文件。别人require('你的包')时默认加载它。scripts:自定义命令,npm run 脚本名执行。dependencies/devDependencies:现在还没有,装包后自动出现。license:开源协议。教学项目用MIT即可。
“默认值只是骨架,”李老师说,“现在把它改成能用的样子:”
{
"name":
173



被折叠的 条评论
为什么被折叠?



