package.json 备忘清单

如果你以前用过 Node.js，则可能会遇到 package.json 文件。它是一个 JSON 文件，位于项目的根目录中。你的 package.json 包含关于项目的重要信息。它包含关于项目的使人类可读元数据（如项目名称和说明）以及功能元数据（如程序包版本号和程序所需的依赖项列表）。

项目的 package.json 是配置和描述如何与程序交互和运行的中心。 npm CLI（和 yarn）用它来识别你的项目并了解如何处理项目的依赖关系。package.json 文件使 npm 可以启动你的项目、运行脚本、安装依赖项、发布到 NPM 注册表以及许多其他有用的任务。 npm CLI 也是管理 package.json 的最佳方法，因为它有助于在项目的整个生命周期内生成和更新 package.json 文件。
package.json 会在项目的生命周期中扮演多个角色，其中某些角色仅适用于发布到 NPM 的软件包。即使你没有把项目发布到 NPM 注册表中，或者没有将其公开发布给其他人，那么 package.json 对于开发流程仍然至关重要。
你的项目还必须包含 package.json，然后才能从 NPM 安装软件包。这可能是你在项目中需要它的主要原因之一。

package.json开发速查备忘清单 包含了关于 package.json 文件中所需内容的全部内容。重要字段，为开发人员分享快速参考备忘单。

开发速查表大纲

  • 重要字段

    • 介绍

    • name

    • version

    • Tips

    • 安装 name 包

  • 信息类字段

    • description

    • license

    • keywords

  • 链接类字段

    • homepage

    • repository

    • bugs

  • 项目维护类字段

    • author

    • contributors

  • 文件类信息

    • files

    • main

    • man

    • directories

    • bin

    • types

  • 打包包字段

    • esnext

    • module

    • browser

    • exports 导出

    • exports 导出子路径中的模块

    • exports 简写 (. 唯一的导出)

    • 条件导出(exports)

    • main Vs exports

  • 任务类字段

    • scripts

    • 特定的 scripts

    • config

  • 依赖描述类字段

    • dependencies

    • workspaces

    • devDependencies

    • overrides

    • peerDependencies

    • optionalDependencies

    • bundledDependencies

    • peerDependenciesMeta

  • 系统

    • engines

    • os

    • cpu

  • 发布

    • private

    • publishConfig

  • Yarn

    • flat

    • resolutions

  • 另见