配置 package.json

4 分钟

欢迎使用 npm 和包管理访问 Node.js 项目管理的世界。让我们深入了解打包的基本要素，以及如何增强开发过程。

打包和包管理

NPM 是 Node.js 的默认包管理器，是将外部代码合并到项目中的机密武器。它就像拥有一位个人助手，可帮助更快、更高效地生成应用程序。

打包就像对代码进行礼品包装以便分发。它将代码及其依赖项整齐地捆绑到其他人员可以轻松安装和使用的包中。包管理是处理这些包的艺术，涉及：

package.json文件，即项目蓝图。它包含有关项目的元数据，并负责管理依赖项和包文件。
npm CLI 工具，可从 npm 注册表安装和管理包的个人杂工。
npm 注册表，可供项目中使用的公共包的宝藏。

创建 package.json

创建package.json与运行npm init命令一样简单。可通过两种主要方式来执行此操作：

npm init:此命令类似于友好指南，引导你完成分步过程，询问项目的详细信息，例如项目的名称、版本和说明。
npm init -y:此命令是 npm init 的快速训练版本。它会快速跳过问题，并填充默认值。

下面是你将生成的package.json文件的预览。

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

了解 package.json 文件区域

将package.json文件视为宝箱，里面装满了珍贵的宝石，让项目闪闪发光。这些 gem 是package.json文件中的属性，它们分为三个主要类别：

元信息：这些属性类似于皇家珠宝，定义有关项目的元信息。它们包括项目名称、说明、作者、关键字等。
依赖项：这些是金币和银币，代表项目使用的包。 dependencies和devDependencies属性保存这些宝物。随着我们进一步的探索，你将了解如何使用这些属性安装、更新和管理依赖项。
脚本：这些是使项目任务完成的终端命令。可以列出启动、生成、测试和 lint 等任务的脚本。

使用脚本加速任务

在package.json文件中，应至少包含四个常见脚本：

start:此脚本使项目生动。例如，它可能使用命令node ./src/index.js。
build:此脚本为项目首次亮相做准备。例如，它可以将 TypeScript 转换为 JavaScript。
test:此脚本检查项目的运行状况，通常使用测试包。
lint:此脚本使用 ESLint 等工具检查样式和格式设置问题。

这些脚本名称类似于魔法词语，在开发人员社区中得到普遍认可，对于保持项目井井有条至关重要。

使脚本名称标准化

在 package.json 文件中，使用操作和命令定义脚本：

"scripts" : {
  "<action>" : "<command>"
}

下面是一个示例：

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

运行脚本

要在终端中运行脚本，请输入命令npm run <action>。例如 npm run lint。

start 和 test 操作特殊在于你可以在命令中省略单词 run。你可以输入 npm start，而不是输入命令 npm run start。

使用预定义的开发环境

此训练模块在浏览器或本地计算机中提供开发容器。此容器提供所有需要的环境，因此无需安装 IDE 或 Node.js 即可使用此训练模块。无需知道有关容器的任何内容即可完成此训练模块。