package.json 参数意义

前端

2024-01-01 14:11:08

掌握 package.json：Node.js 应用程序的元数据和配置

何为 package.json？

package.json 是 Node.js 应用程序或软件包的灵魂，一个承载着其元数据和配置的 JSON 文件。它就像一个应用程序的身份证，记录着它的名称、版本、依赖关系和更多信息。

package.json 的关键参数

package.json 的核心参数包括：

name： 应用程序的唯一标识符，在 npm 注册中心中使用。
version： 应用程序的语义版本号，如 major.minor.patch。
description： 应用程序的简要说明，用于搜索和安装。
author： 应用程序作者的姓名或联系方式。
license： 应用程序的分发和使用条件。
keywords： 用于搜索应用程序的关键词列表。
main： 应用程序的主入口点，即运行应用程序时加载的文件。
dependencies： 运行应用程序所需的依赖项。
devDependencies： 仅在开发环境中使用的依赖项，如测试或构建工具。
scripts： 可从命令行运行的自定义脚本。

自定义配置

除了这些核心参数，package.json 还允许自定义配置，例如：

homepage： 应用程序主网站的 URL。
repository： 应用程序代码存储库的 URL。
contributors： 参与应用程序开发的人员列表。

示例代码：

{
  "name": "my-app",
  "version": "1.0.0",
  "description": "A simple Node.js application",
  "author": "John Doe",
  "license": "MIT",
  "keywords": ["node", "javascript", "express"],
  "main": "index.js",
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "eslint": "^8.2.0",
    "mocha": "^10.2.1"
  },
  "scripts": {
    "start": "node index.js",
    "test": "mocha"
  }
}