深入了解package.json文件

在前端项目开发中，我们经常会遇到package.json文件。这个文件不仅是一个简单的配置文件，它还承担了项目管理的重任。下面，我们将深入探讨package.json文件的各个字段和作用，并通过实例来帮助你更好地理解和使用它。

`package.json`的作用

package.json文件是一个用于描述和管理项目的配置文件。它包含了项目的元数据，例如项目名称、版本号、作者、许可证等。同时，它还包括了项目的依赖项信息，例如项目所依赖的第三方库、框架以及工具等。通过package.json文件，我们可以方便地管理项目的依赖关系，使得项目的构建、发布和维护更加简单和可靠。

以下是element-plus包的package.json文件的示例：

json 复制代码

{
  "name": "element-plus",
  "version": "2.3.12",
  "description": "A Component Library for Vue 3",
  "keywords": [
    "element-plus",
    "element",
    "component library",
    "ui framework",
    "ui",
    "vue"
  ],
  "homepage": "https://element-plus.org/",
  "bugs": {
    "url": "https://github.com/element-plus/element-plus/issues"
  },
  "license": "MIT",
  "main": "lib/index.js",
  "module": "es/index.mjs",
  "types": "es/index.d.ts",
  "exports": {
    ".": {
      "types": "./es/index.d.ts",
      "import": "./es/index.mjs",
      "require": "./lib/index.js"
    },
    "./es": {
      "types": "./es/index.d.ts",
      "import": "./es/index.mjs"
    },
    "./lib": {
      "types": "./lib/index.d.ts",
      "require": "./lib/index.js"
    }
  },
  "unpkg": "dist/index.full.js",
  "jsdelivr": "dist/index.full.js",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/element-plus/element-plus.git"
  },
  "publishConfig": {
    "access": "public"
  },
  "style": "dist/index.css",
  "sideEffects": [
    "dist/*",
    "theme-chalk/**/*.css",
    "theme-chalk/src/**/*.scss",
    "es/components/*/style/*",
    "lib/components/*/style/*"
  ],
  "peerDependencies": {
    "vue": "^3.2.0"
  },
  "dependencies": {
    "@ctrl/tinycolor": "^3.4.1",
    "@element-plus/icons-vue": "^2.0.6",
    "@floating-ui/dom": "^1.0.1",
    "@popperjs/core": "npm:@sxzz/popperjs-es@^2.11.7",
    "@types/lodash": "^4.14.182",
    "@types/lodash-es": "^4.17.6",
    "@vueuse/core": "^9.1.0",
    "async-validator": "^4.2.5",
    "dayjs": "^1.11.3",
    "escape-html": "^1.0.3",
    "lodash": "^4.17.21",
    "lodash-es": "^4.17.21",
    "lodash-unified": "^1.0.2",
    "memoize-one": "^6.0.0",
    "normalize-wheel-es": "^1.2.0"
  },
  "devDependencies": {
    "@types/node": "*",
    "csstype": "^2.6.20",
    "vue": "^3.2.37",
    "vue-router": "^4.0.16"
  },
  "vetur": {
    "tags": "tags.json",
    "attributes": "attributes.json"
  },
  "web-types": "web-types.json",
  "browserslist": ["> 1%", "not ie 11", "not op_mini all"],
  "gitHead": "89d4ec863ce55fc3de2f0513631e76f695f8e791"
}

基本字段解析

name

项目名称。该字段不能设置为空，它和版本号组成唯一的标识来代表整个项目。名称中不能包含大写字母，可以使用连字符（-）或下划线（_）。如果需要在npm平台发布，需要确保你的名称在平台上是唯一的。

version

项目的版本号。需要发布到npm平台时，该字段是必填项。

description

项目描述。该字段在npm平台搜索该包时起作用。

keywords

关键词。用于在npm平台搜索的关键词，该字段为数组，可设置多个关键词。

homepage

项目的主页URL。

bugs

项目提交问题的地址。

license

项目的许可证（软件的开源协议）。

main

npm包的CommonJS入口文件。如果不设置，则默认查找包根目录下的index.js文件。当使用require引入包时，会查找main对应路径的文件进行引入。该文件应遵循CommonJS模块规范，并基于ES5规范编写。

module

npm包的ESM规范入口文件。这样的文件可以使用ES6的import/export语法，并支持Tree Shaking等特性。main和module字段在package.json中共同存在时，分别用于指定不同模块规范下的入口文件，以满足不同环境和工具的需求。

types

TypeScript类型定义文件的路径。

exports

定义包的子路径导出映射。例如：

json 复制代码

"exports": {
  ".": {
    "import": "./index.esm.js",
    "require": "./index.cjs"
  },
  "./feature": {
    "import": "./feature/esm/index.js",
    "require": "./feature/cjs/index.js"
  }
}

unpkg

CDN服务地址。

json 复制代码

"unpkg": "dist/index.full.js"

repository

包代码存放仓库地址。可以是字符串（仓库地址），也可以是对象。

publishConfig

npm包的发布配置。此配置将覆盖全局或用户级别的npm配置。特别适用于需要将包发布到私有npm仓库或具有特殊发布需求的场景。

publishConfig是一个对象，包含以下属性：

registry：指定npm包的发布仓库地址。
access：包的访问级别（public 公开，restricted 私有）。
tag：为发布的npm包指定一个标签。默认情况下，npm包会使用latest标签发布，你可以手动指定为beta。

style

该字段不是标准的npm字段，代表包中的样式文件路径。当style字段被设置时，某些工具（如Webpack的某些loader或构建脚本）可能会自动处理或包含这个样式文件。通常用于希望将样式文件直接包含在其包中的前端库或组件。

sideEffects

用于告知打包工具（如Webpack）哪些文件或模块在引入时具有副作用，从而影响Tree Shaking的行为。

在package.json中，sideEffects字段是Webpack v4及更高版本引入的一个特性，用于标记项目中的某些文件或模块是否包含副作用。通过正确配置sideEffects，打包工具可以更有效地移除未使用的代码，减小最终打包文件的大小。

peerDependencies

对等依赖。peerDependencies字段用于声明一个package与依赖它的宿主应用程序所使用的其他package之间的兼容性限制。例如，上面的element-plus中的peerDependencies是依赖vue@3.2.0的版本，也就是说，你当前项目的Vue版本不能低于vue@3.2.0，否则会出现兼容性报错。

dependencies

项目的生产环境中所必须的依赖包。

devDependencies

开发阶段需要的依赖包。比如less、scss、eslint等。

npm安装包时常见的基本参数以及作用

无参数（npm install <包名>）：默认会添加到package.json文件中的dependencies中。
--save 或者 -S：同上。
--save-dev 或者 -D：添加到package.json文件中的devDependencies中，通常用于开发环境依赖的包。
--global 或 -g：将包安装到全局环境，而不是当前项目的本地环境，这可以让这个包在任何项目中使用，一般用于工具包。
--production：仅安装到生产环境。
--no-save：安装的包但不会添加到package.json中的依赖项中。
--no-package-lock：安装包时不生成package-lock.json文件。

browserslist

"> 1%"：表示支持全球使用率超过1%的浏览器。
"not ie 11"：不支持IE 11。
"not op_mini all"：不支持所有版本的Opera Mini浏览器。

重要字段补充

scripts

项目的脚本命令，这些命令可以通过npm run <script-name>来执行。例如：

json 复制代码

"scripts": {
  "start": "node index.js",
  "build": "webpack --config webpack.config.js"
}

bin

指定命令以及对应执行文件路径。这些文件通常会有可执行权限，并且包含一些可以在命令行中运行的代码。例如：

json 复制代码

{
  "name": "my-tool",
  "version": "1.0.1",
  "bin": {
    "my-tool": "./bin/index.js"
  },
  "scripts": {
    "start": "node index.js"
  }
}

files

发布npm时指定需要上传的文件或者目录。如果有少数不上传的文件，可以创建一个.npmignore文件（类似于.gitignore，但该文件不会上传到npm），去掉不需要上传的文件，其余都上传。例如：

plaintext 复制代码

node_modules
packages

engines

当前包或者项目依赖的环境。有些项目所依赖的包对npm的版本或者Node.js版本有要求，不符合版本时项目可能无法启动。该字段仅用于说明项目所需的Node.js版本，并非起到限制作用。例如：

json 复制代码

"engines": {
  "node": ">=14.0.0",
  "npm": ">=6.0.0"
}

package-lock.json（npm）、pnpm-lock.yaml（pnpm）

这些文件会在首次使用npm或pnpm安装依赖时生成，用于锁定项目依赖的确切版本，包含主模块和所有依赖的子模块。主要用于避免由于依赖版本更新导致的不一致问题，保证相同的依赖树。当更新某个包的版本时，也会修改package-lock.json。依赖项的存储方式有所不同，pnpm使用"硬链接"来存储依赖项，而npm和yarn则复制依赖项到每个项目的node_modules目录中。

结语

通过对package.json文件的详细解析，可以看到它在项目管理中发挥着重要的作用。正确配置和使用package.json文件，可以大大提高项目的构建、发布和维护的效率。希望这篇文章能帮助我们更好地理解和使用package.json文件，使项目开发更加顺利。

深入了解package.json文件

package.json的作用

基本字段解析

name

version

description

keywords

homepage

bugs

license

main

module

types

exports

unpkg

repository

publishConfig

style

sideEffects

peerDependencies

dependencies

devDependencies

npm安装包时常见的基本参数以及作用

browserslist

重要字段补充

scripts

bin

files

engines

package-lock.json（npm）、pnpm-lock.yaml（pnpm）

结语

`package.json`的作用