package.json的所有配置项及其用法 你都熟悉么

package.json的所有配置项及其用法

在JavaScript项目中，package.json是一个重要的配置文件。它除了记录项目的依赖、开发依赖之外，还有许多其他的配置项。下面我们将介绍package.json的所有配置项及其用法。

name

name表示项目的名称。它是一个必填项，而且必须是小写字母，可以包含连字符和下划线。

{
  "name": "my-project"
}

version

version表示项目的版本号。它也是一个必填项。它采用x.y.z的格式。

{
  "version": "1.0.0"
}

其中，x表示主版本号、y表示次版本号、z表示修订号。版本号的修改原则是：

• 主版本号修改：表示不兼容的API变化；
• 次版本号修改：表示向后兼容的功能性新增；
• 修订号修改：表示向后兼容的问题修正。

description

description表示项目的描述信息。

{
  "description": "my awesome project"
}

keywords

keywords表示项目的关键词，方便通过关键词搜索项目。

{
  "keywords": ["awesome", "project"]
}

homepage

homepage表示项目的主页链接。

{
  "homepage": "https://github.com/user/my-project"
}

bugs

bugs表示项目的bug跟踪系统。

{
  "bugs": {
    "url": "https://github.com/user/my-project/issues",
    "email": "[e-mail]"
  }
}

license

license表示项目的许可证。它是一个必填项。

{
  "license": "MIT"
}

常用的许可证有：

• MIT
• Apache-2.0
• GPL-3.0

author

author表示项目的作者信息。

{
  "author": {
    "name": "John Doe",
    "email": "[e-mail]",
    "url": "https://johndoe.com"
  }
}

contributors

contributors表示项目的贡献者。

{
  "contributors": [
    {
      "name": "John Doe",
      "email": "[e-mail]",
      "url": "https://johndoe.com"
    }
  ]
}

files

files表示项目源代码中需要发布到npm上的文件列表。

{
  "files": [
    "src/",
    "index.js",
    "README.md",
    "LICENSE"
  ]
}

main

main表示项目的入口文件，它必须是相对于项目根目录的路径。

{
  "main": "dist/index.js"
}

browser

browser表示在浏览器中使用时的入口文件。

{
  "browser": "dist/browser.js"
}

bin

bin表示项目的可执行文件。

{
  "bin": {
    "my-cli": "./bin/my-cli.js"
  }
}

man

man表示项目的文档页。

{
  "man": "./man/my-project.1"
}

directories

directories表示项目的目录结构。

{
  "directories": {
    "lib": "src/lib",
    "doc": "doc"
  }
}

scripts

scripts表示项目的脚本命令。

{
  "scripts": {
    "start": "node index.js",
    "test": "jest",
    "build": "webpack"
  }
}

repository

repository表示项目的代码仓库地址。

{
  "repository": {
    "type": "git",
    "url": "https://github.com/user/my-project.git"
  }
}

dependencies

dependencies表示项目的依赖项。

{
  "dependencies": {
    "react": "^17.0.0",
    "axios": "^0.21.1"
  }
}

其中，版本号的前缀含义为：

• ~表示最低版本更新，例如~0.17.0表示最低可以使用0.17.0版本，但其他版本也可以。
• ^表示向后兼容更新，例如^0.17.0表示可以使用0.17.0及以上版本，但不包括1.0.0及以上版本。
• >表示高于某个版本，例如>0.17.0表示可以使用0.17.0及以上版本。

devDependencies

devDependencies表示项目的开发依赖项。

{
  "devDependencies": {
    "jest": "^26.6.0",
    "webpack": "^5.29.0"
  }
}

peerDependencies

peerDependencies表示项目的对某个模块的依赖。

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

peerDependenciesMeta

peerDependenciesMeta表示项目与某个模块的依赖的特殊关系。

{
  "peerDependencies": {
    "react": "^16.0.0"
  },
  "peerDependenciesMeta": {
    "react": {
      "optional": true
    }
  }
}

engines

engines表示项目需要的环境。

{
  "engines": {
    "node": "^12.0.0",
    "npm": "^6.0.0"
  }
}

其中，node表示需要的Node.js版本，npm表示需要的npm版本。

os

os表示项目运行的操作系统。

{
  "os": ["darwin", "linux"]
}

cpu

cpu表示项目支持的CPU架构。

{
  "cpu": ["x64", "arm"]
}

private

private表示项目是否是私有的。如果设置为true，则不能被发布到npm上。

{
  "private": true
}

publishConfig

publishConfig表示项目发布到npm上的配置。

{
  "publishConfig": {
    "access": "public",
    "registry": "https://registry.npmjs.org/"
  }
}

其中，access表示发布包的访问级别，可以是public或restricted，registry表示npm仓库的地址。

以上就是package.json的所有配置项及其用法。掌握这些配置项可以让我们更加方便地开发和发布JavaScript项目。