从创建到维护：掌握package.json的最佳实践（一）-阿里云开发者社区

I. 介绍

什么是package.json

package.json是一个JSON（JavaScript Object Notation）格式的文件，它是Node.js项目的配置文件之一，其中包含了项目的具体描述信息、依赖和开发脚本等内容。

在使用npm（Node.js的包管理器）来管理项目时，package.json文件扮演着重要的角色，它可以使我们更方便地管理和安装第三方依赖包，同时也可以在开发过程中提供帮助和便利，有效避免依赖混乱和项目配置出错等问题。

因此，了解和使用package.json对Node.js项目开发来说十分重要。

package.json的作用

package.json的作用主要有以下几个方面：

依赖管理：通过声明项目依赖和版本号等信息，可以在项目初始化和部署时自动安装所需的依赖。这样可以帮助开发者有效地管理和维护项目所需的依赖包，避免出现版本冲突或依赖混乱等问题。
项目配置：package.json不仅存储了项目依赖的相关信息，还可以存储项目的其他配置参数和脚本信息等。这样可以让项目配置文件更加统一和规范，便于团队协作和维护。
发布管理：在发布npm包时，发布者需要提供package.json文件中的相关信息，并使用命令行工具将npm包上传到npm服务器上。其他用户可以通过npm安装包时获取package.json中的依赖信息，使得第三方开发者更容易维护和使用开源工具或库。

简而言之，package.json可以使得项目依赖和配置信息更加规范化、统一化、自动化，同时也可以使得包的发布和使用更加简单和便捷。

npm与package.json的关系

npm（Node.js Package Manager）是Node.js官方提供的包管理工具，它可以帮助开发者在项目中管理依赖包、构建项目、发布自己的模块等。而package.json则是npm运行时需要用到的配置文件之一，它描述了项目的详细信息和依赖关系。

npm的一些子命令，如npm install、npm update等操作，都依赖于项目中存在package.json这个文件。在一些情况下，npm会通过读取package.json的内容来自动升级和安装依赖包以及执行开发脚本等。

通过package.json中的依赖和版本信息，npm可以快速识别项目所需的包并自动进行安装和升级，同时也为开发者提供了更便利且可靠的依赖管理服务。另外，npm还给予了Node.js社区一些额外的服务，例如npmjs.com网站，这个网站是npm的官方网站，提供了关于Node.js包的查找、发布、更新等服务。

综上所述，npm与package.json是密不可分的关系。通过npm与package.json的结合，Node.js项目的配置文件和依赖管理都变得更加简单、自动化和可靠。

II. 创建package.json

npm init

npm init是npm提供的一个命令行工具，用于生成一个初始化的package.json配置文件。在执行npm init命令时，npm会通过向用户提出一系列问题，来创建一个新的package.json文件。通过回答这些问题，用户可以快速而方便地填写项目的基本信息、依赖和开发脚本等。

在初始化项目时，npm init可通过以下方式进行操作：

执行npm init命令，会进入交互式初始化程序，用户在命令行中回答一系列问题，可快速生成一个符合规范的package.json文件；
执行npm init -y命令，可直接生成一个默认的package.json配置文件，适用于不需要手动输入项目的基本信息等情况。

总之，npm init可以让开发者很方便地创建符合规范的package.json文件，使得项目的依赖关系和配置文件更加清晰可读、易于维护和分享。在创建Node.js项目时，初始化确保package.json被按正确的方式生成并包含正确的元数据，这是一个高度推荐的最佳实践。

自动生成package.json

在使用npm init命令时，我们需要手动回答一些问题，以生成package.json文件。

但是有时候，我们可以通过一些工具或库来自动生成package.json，从而减少手动配置的工作量，提高开发效率。

以下是一些可以生成package.json文件的工具或库：

create-react-app：这是一个React.js的脚手架，提供了默认的package.json文件，可以通过运行命令"npx create-react-app my-app"快速创建一个基于React.js的项目。
Yeoman：Yeoman是一个以项目生成为核心的开发工具，可以生成新的项目结构、代码骨架、测试代码、构建脚本等。通过Yeoman，我们可以快速构建各种类型的前端和后端应用。
vue-cli：类似于create-react-app，vue-cli是一个为Vue.js开发构建的脚手架，也提供了默认的package.json文件，可以通过运行命令"npm install -g vue-cli"安装后快速创建一个基于Vue.js的项目。
init-package-json：这是一个npm模块，可以在命令行中执行"npx init-package-json"命令，生成一个默认或自定义的package.json文件。

总之，这些工具或库可以帮助我们快速生成符合规范的package.json文件，减少开发者手动配置的工作量，同时也可以提高项目的规范化和可维护性。

package.json各个字段的含义

package.json 是 Node.js 项目中必需的一个描述文件，它包含了项目的元数据，例如项目名称、版本、依赖、脚本等信息。下面是 package.json 文件中常用的字段及其含义：

name - 项目名称，必须是唯一的。命名时最好要符合规范，遵循这些规则：https://docs.npmjs.com/files/package.json#name
version - 项目版本，遵循语义化版本的规范，格式为 ..，例如 “1.0.0”。其中，major（主版本号）表示非向后兼容的 API 更改，minor（次版本号）表示向后兼容的功能新增，patch（修订号）表示向后兼容的问题修复。
description - 项目描述，用于描述项目的功能和特点。
keywords - 项目关键字，用于搜索和分类，可以把与项目相关的一些关键词添加在这个字段中，多个关键字之间用逗号分隔。
repository - 项目的代码仓库信息，包括 type（仓库类型，如 git）、 url（代码仓库 URL）、directory（相对仓库根目录的项目目录，可选）。
author - 项目作者，可以是一个字符串或者一个包含 name、email 和 url 三个字段的对象。
license - 项目许可证，遵循 SPDX License Expression 格式，例如 “MIT”, “ISC” 等。
dependencies - 项目的依赖，以一组键值对的形式记录，键为依赖项包名，值为依赖项版本号，例如：“dependencies”:{“lodash”:“^4.17.11”}。其中的版本号可以是精确版本号、范围版本号或者 URL/git 仓库地址。
devDependencies - 项目的开发依赖，即只在开发过程中需要用到的依赖项，在项目部署的时候并不需要。和 dependencies 字段用法相同，只是可以使用 npm install --only=dev 命令单独安装这些依赖项。
engines - 该项目的最低运行环境和版本，例如：“engines”:{“node”:“14.0.0”}，表示需要 Node.js 版本不低于 14.0.0。
scripts - 定义一组命令脚本，用于构建和运行该项目，例如：“scripts”: {“start”: “node index.js”, “test”: “mocha test.js”}。可以通过 npm run 来执行这些脚本。

这些字段是 package.json 中的常见字段，除此之外，还有很多其他的字段可以用于记录项目的其他信息，如果你想深入了解，可以参考 npm 的官方文档：https://docs.npmjs.com/files/package.json 。

III. dependencies和devDependencies

package.json是一个JSON格式的文件，用于描述Node.js项目的元数据信息、包依赖关系、开发脚本等。

下面是package.json中常用字段的含义：

name：包的名称，应该是唯一的，使用小写字母，不能包含空格和特殊字符。
version：包的版本号，遵循语义化版本规范。
description：包的简要描述。
keywords：关键字数组，用于分类和搜索npm包。
homepage：包的官方网站或者GitHub地址等。
bugs：包的错误跟踪地址。
author：包作者信息。
contributors：贡献者列表。
license：包的开源许可证。
dependencies：包依赖列表，指定项目所依赖的其他npm包和对应的版本号。
devDependencies：开发依赖列表，指定项目开发中需要使用的npm包和对应的版本号。
repository：包的代码仓库地址。
scripts：定义可以通过npm run脚本命令运行的任务。例如：start、test。
main：包的入口文件路径，用于被其他模块引入。

总之，package.json提供了一种标准化的方法，以便于开发者管理和维护依赖包、构建任务以及共享代码等。开发者可以通过在package.json中指定相关信息，与其他用户共享项目代码和项目元数据。

dependencies和devDependencies的区别

在package.json文件中，dependencies和devDependencies都是用来描述 Node.js 项目依赖的字段。

它们之间的区别主要如下：

dependencies 是用来指定当前工程在生产环境（构建后）中所依赖的第三方模块，也就是发布到 npm 上后其他人运行时需要的依赖包。这里的依赖关系会自动安装到项目当中，也可以通过npm install命令手动安装。
devDependencies 是用来指定开发环境中所依赖的第三方模块，例如testing libraries, build tools 等等，不会被打包到生产环境中，因为这些包在开发完成时和构建之后不再需要。这里的依赖关系同样可以通过 npm install 安装，但加上 -D 或 --save-dev 参数即可。

总之，dependencies主要是生产环境中的依赖项，devDependencies主要是开发环境中的依赖项，这两个字段的区别是依赖包是否需要打包到生产环境中。为了避免构建时出现错误或者性能问题，我们需要清理掉不必要的依赖包，而devDependencies则提供了一个独立的依赖关系列表，可以轻松地管理开发依赖。

安装依赖包

在 Node.js 项目中，我们可以通过 npm 命令来安装依赖包。

下面是 npm 安装依赖包的常用方法：

安装最新的稳定版本：npm install package-name
安装指定版本：npm install package-name@version
安装指定范围版本：npm install package-name@">=version1.0.0
安装最新的beta版本：npm install package-name@beta
安装最新的alpha版本：npm install package-name@alpha

上述命令执行时，npm会从npm官方服务器上下载包和其所有可以使用的依赖包，并将其安装在 node_modules 目录中。如果需要将依赖包保存到 package.json 文件的 dependencies 或者 devDependencies 字段中，则应在相应的命令之后加上 --save 或 --save-dev flag，例如：

npm install package-name --save
npm install package-name --save-dev

这些命令执行后，npm会自动更新我们的 package.json 文件，保存安装的包的信息。

总之，使用 npm 安装依赖包是 Node.js 开发中的重要部分，为我们的项目提供了易于使用、被集成和共享的依赖关系，可以极大提高开发效率和可维护性。

`安装依赖包的版本`

在 Node.js 项目中，我们可以通过 npm 安装指定版本的依赖包。

下面是 npm 安装依赖包版本的常用方法：

安装最新的主版本：npm install package-name@major
安装最新的次要版本：npm install package-name@minor
安装最新的补丁版本：npm install package-name@patch
安装指定版本号的依赖包：npm install package-name@1.2.3
安装指定版本号之前的最新版本：npm install package-name@<1.2.3
安装指定版本号之后的最新版本：npm install package-name@>1.2.3

在 package.json 文件中，我们也可以指定所需要安装的包的版本号。例如：

"dependencies": {
    "package-name": "1.2.3"
  }

如果不指定版本号，则默认安装最新版本的包。

总之，安装指定版本的依赖包可以使我们的项目更加稳定、易于管理和维护。同时，我们也可以根据需要在 package.json 文件中指定所需要安装的包的版本号。

`更新依赖包`

在 Node.js 项目中，我们可以使用 npm 更新已安装的依赖包到最新版本。

更新依赖包的命令如下：

npm update package-name

这条命令会将 package-name 更新至最新版本。如果我们想要更新所有依赖包至最新版本，则可以运行如下命令：

npm update

注意，npm update 只会更新 package.json 文件中指定的依赖包，其他依赖包将保持原状。如果我们想要更新全部依赖包，可以使用如下命令：

npm update --save

上述命令将会把 package.json 文件中所有依赖包的版本号更新至最新版本，并更新 package.json 文件。

另外，我们也可以手动修改 package.json 文件中依赖包的版本号，然后再运行 npm install 命令重新安装依赖包。

总之，更新依赖包可以使我们使用的依赖包始终保持在最新、稳定的状态，以确保应用程序的安全和绩效。然而，请注意使用更新命令时版本号的规范，以避免不必要的错误。

`IV. scripts`

`scripts的作用和用途`

在 Node.js 项目中，scripts 是 package.json 文件中的一项字段，用于定义在命令行中运行的脚本命令。scripts 字段可以包含一组自定义脚本命令，这些命令可以通过 npm run 命令在命令行中执行。

例如，我们可以在 package.json 文件中添加如下代码：

"scripts": {
  "start": "node main.js",
  "test": "mocha test/*"
},

这里，我们定义了两个脚本命令：start 和 test。当我们在命令行中运行 npm run start 时，它将执行 node main.js；当我们运行 npm run test 时，它将执行 mocha test/*。

通过使用 scripts 字段，我们可以自动化很多项目中的任务。例如，我们可以执行自动化测试、自动压缩代码、自动化构建等任务。除此之外，scripts 字段还可以定义 pre 和 post 命令，这些命令会在主命令之前或之后自动执行，例如：

"scripts": {
  "prepublish": "npm test",
  "test": "mocha"
},

这里，prepublish 命令将在发布前自动执行 npm test 命令。test 命令将在测试期间运行 mocha 命令。

总之，scripts 字段可以为我们的项目提供很多自动化功能，节省了我们手动运行命令的时间，提高了项目的效率和可维护性。

`scripts的语法`

在 Node.js 的 package.json 文件中，scripts 字段的语法如下：

"scripts": {
  "command-name": "command-to-execute"
}

其中，command-name 是自定义的脚本命令名称，command-to-execute 是要在命令行中执行的命令字符串。命令字符串可以是任何合法的 shell 命令。有一些特殊的命令可以通过 $npm_ 前缀调用 npm 内置的脚本，例如 $npm_package_version 可以访问 package.json 文件中的版本号。

为了方便，我们也可以在命令字符串中使用 npm 提供的缩写，如下表所示：

缩写	命令
npm	别名为 `npm run-script`
echo	输出字符串或变量到控制台
node	启动一个 Node.js 实例
rm	删除文件或目录
cp	复制文件或目录
mkdir	创建目录

例如，以下是一个简单的 scripts 示例，其中定义了 start 和 test 两个脚本命令：

"scripts": {
  "start": "node app.js",
  "test": "mocha tests/*.test.js"
}

其中，start 命令将启动应用程序，而 test 命令将使用 Mocha 执行测试代码。在命令行中，我们可以使用 npm run start 或 npm run test 命令执行相应的命令。

总之，scripts 字段的语法非常灵活，在开发过程中可以根据需要自定义相应的脚本命令，提高生产力和开发效率。

从创建到维护：掌握package.json的最佳实践（二）https://developer.aliyun.com/article/1426293

从创建到维护：掌握package.json的最佳实践（一）