掌握package.json：全面指南🚀

了解package.json文件对于Node.js应用程序至关重要。

它是每个项目的核心，保存关于应用程序的元数据。管理项目依赖关系，并配置构建工具。

在本指南中，我们将深入了解package.json的结构、关键字段和高级用法。

📌什么是package.json？

package.json是一个JSON文件，包含有关Node.js的元数据。

它充当项目的蓝图，保存包依赖关系、脚本、版本信息以及诸如linter等工具的配置信息。

要创建package.json文件，可以在项目目录中运行以下命令：

js 复制代码

npm init

此命令将指导您设置基本的package.json文件。

📌package.json的关键部分

让我们探索package.json中主要的部分以及如何有效地使用它们。

📍元数据字段

package.json中的元数据提供了有关项目的基本信息，这对开源包特别有用。

name ：包的名称。如果在npm上发布，它必须是唯一的。
version ：包的版本。遵循语义版本控制（例如，1.0.0）。
description：软件包的简短描述。
keywords：npm搜索优化的关键字数组。
author：作者的姓名和联系方式。
license ：定义分发软件包所依据的许可证（例如，MIT，ISC）。
repository：源代码存储库的URL。

json 复制代码

{
  "name": "my-awesome-project",
  "version": "1.0.0",
  "description": "A project to showcase package.json features",
  "keywords": ["example", "package.json", "guide"],
  "author": "Jane Doe",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/janedoe/my-awesome-project.git"
  }
}

📍Scripts

scripts部分允许您可以通过npm run运行的命令。

这些通常用于构建、测试、linting等。

json 复制代码

"scripts": {
  "start": "node index.js",
  "build": "webpack --config webpack.config.js",
  "test": "jest",
  "lint": "eslint ."
}

📍 Dependencies

资源库是项目运行所需的外部库。它们分为两大类：

dependencies：应用程序在生产环境所需的包。
devDependencies：仅在开发过程中需要的包，如测试或构建工具。

json 复制代码

"dependencies": {
  "express": "^4.17.1",
  "mongoose": "^5.12.3"
},
"devDependencies": {
  "jest": "^26.6.3",
  "eslint": "^7.22.0"
}

📍版本管理

在package.json中，依赖版本通常使用语义版本控制：

^：允许进行次要补丁更新。例如，^1.0.0将接受<2.0.0之前的版本。
~：仅允许补丁更新。例如，~1.0.0将接受<1.1.0之前的版本。
固定版本：如果您不需要任何更新，请使用精确版本。例如：1.0.0

📍同级依赖

指定与您使用的包相兼容的依赖，但不会自动安装。

json 复制代码

"peerDependencies": {
  "react": "^16.0.0"
}

📌高级配置

📍 Engines

engines字段指定了项目兼容的Node.js或npm版本。

json 复制代码

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

📍配置项

有些工具允许您直接在package.json中定义其配置。举例来说：

eslintConfig：ESLint的配置。
jest：Jest的配置。

json 复制代码

"eslintConfig": {
  "extends": "eslint:recommended",
  "rules": {
    "no-console": "warn"
  }
},
"jest": {
  "testEnvironment": "node"
}

📍可选选项

optionalconfigurations列出了您的项目可以在没有它的情况下运行的包。如果安装失败，npm会继续运行，不会出错。

json 复制代码

"optionalDependencies": {
  "fsevents": "^2.0.0"
}

📍解析（Yarn 专用）

对于使用Yarn的项目，resolutions允许您覆盖特定的包，以解决依赖冲突。

json 复制代码

"resolutions": {
  "lodash": "4.17.21"
}

📍工作区（Monorepo支持）

工作空间用于管理monorepos，允许您管理单个存储库中的多个包。

它们对于具有共享依赖项的项目特别有用。

json 复制代码

"workspaces": [
  "packages/*"
]

📍私人领域

在package.json中设置"private"：true防止你的包被意外发布到npm注册表，这对私有项目很有帮助。

📌package.json的最佳实践

版本控制 ：在version和依赖项中遵循语义版本控制，以安全地管理更新。
使用描述性脚本 ：编写清晰、简洁的脚本名称。例如：使用npm run build:client代替npm run build-client，提高了可读性。
文档：为新团队成员添加一个README来记录关键脚本和命令。
避免使用版本通配符 ：在依赖项中避免使用"*"或">="; 它们可能会出现问题。
组织依赖性 ：将基本依赖性（dependencies）与开发依赖（devendencies）分开。

原文：dev.to/alisamir/ma...