本快速參考備忘清單是您需要了解的關(guān)于 package.json 文件中所需內(nèi)容的全部?jī)?nèi)容。 它必須是實(shí)際的 JSON，而不僅僅是 JavaScript 對(duì)象字面量。

• npm 文檔 (npmjs.com)
• yarnpkg 文檔 (yarnpkg.com)
• packages 文檔 (nodejs.org)
• npm 備忘清單(速查表) (jaywcjlove.github.io)

{
  "version": "1.0.0"
}

包的當(dāng)前版本，嚴(yán)格遵循 Semantic Versioning 2.0.0 語(yǔ)義化版本規(guī)范。

• 不要使用和 Node.js 核心模塊相同的名字。
• 不要在名字里包含 js 或者 node 單詞。
• 短小精悍，讓人看到名字就大概了解包的功能，記住它也會(huì)被用在 require() 調(diào)用里。
• 保證名字在 npm registry 里是唯一的。
• name 和 version 字段一起用于創(chuàng)建唯一ID

如果沒(méi)有 name 和version 字段，您的包將無(wú)法安裝

{
  "description": "我的包的概要簡(jiǎn)短描述"
}

幫助使用者了解包的功能的字符串，包管理器也會(huì)把這個(gè)字符串作為搜索關(guān)鍵詞。

{
  "keywords": [
    "short", "relevant", "keywords"
  ]
}

一個(gè)字符串?dāng)?shù)組，當(dāng)在包管理器里搜索包時(shí)很有用。

{
  "homepage": "https://your-package.org"
}

是包的項(xiàng)目主頁(yè)或者文檔首頁(yè)。

{
  "bugs": "https://github.com/user/repo/issues"
}

問(wèn)題反饋系統(tǒng)的 URL，或者是 email 地址之類的鏈接。用戶通過(guò)該途徑向你反饋問(wèn)題。

項(xiàng)目的維護(hù)者。

{
  "author": {
    "name": "Your Name",
    "email": "you@xxx.com",
    "url": "http://your-x.com"
  },
  "author": "Your Name <you@xxx.com> (http://your-x.com)"
}

作者信息，一個(gè)人。

{
  "files": [
    "filename.js",
    "directory/",
    "glob/*.{js,json}"
  ]
}

項(xiàng)目包含的文件，可以是單獨(dú)的文件、整個(gè)文件夾，或者通配符匹配到的文件。

{
  "main": "filename.js"
}

項(xiàng)目的入口文件。

{
  "man": "./man/doc.1",
  "man": ["./man/doc.1", "./man/doc.2"]
}

項(xiàng)目的入口文件。

{
  "directories": {
    "lib": "path/to/lib/",
    "bin": "path/to/bin/",
    "man": "path/to/man/",
    "doc": "path/to/doc/",
    "example": "path/to/example/"
  }
}

當(dāng)你的包安裝時(shí)，你可以指定確切的位置來(lái)放二進(jìn)制文件、man pages、文檔、例子等。

{
  "bin": "bin.js",
  "bin": {
    "命令名稱": "bin/命令路徑/命令名稱.js",
    "other-command": "bin/other-command"
  }
}

隨著項(xiàng)目一起被安裝的可執(zhí)行文件。

這是一個(gè)只在 TypeScript 中生效的字段，如果您的包有一個(gè) main.js 文件，您還需要在 package.json 文件中指明主聲明文件。 將 types 屬性設(shè)置為指向 bundled 的聲明文件。 例如：

{
  "types": "./lib/main.d.ts",
}

如果您的主聲明文件名為 index.d.ts 并且位于包的根目錄（index.js旁邊），則不需要標(biāo)記 types 屬性，建議這樣做。

pkg.module 將指向具有 ES2015 模塊語(yǔ)法的模塊，但僅指向目標(biāo)環(huán)境支持的語(yǔ)法功能。 完整的描述在這里。

{
  "module": "dist/my-package.esm.js"
}

支持：rollup, webpack

"browser": {
    "module-a": "./shims/module-a.js",
    "./server/only.js": "./shims/client-only.js"
}

字段由模塊作者提供，作為 JavaScript 包或組件工具的提示，用于打包模塊以供客戶端使用。 提案就在這里。

{
  "name": "mod",
  "exports":{
    ".": "./lib/index.js",
    "./lib/*": "./lib/*.js"
  }
}

使用最新的 exports 字段導(dǎo)出，可規(guī)避 main 字段局限性 具體參考

{
  "name": "mod",
  "exports": {
    ".": "./index.js",
    "./sub": "./src/sub.js"
  }
}

導(dǎo)入

import sub from "mod/sub"

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

簡(jiǎn)寫(xiě)

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

{
  "main": "./index.js",
  "exports": "./index.js"
} 

如果同時(shí)出現(xiàn) main 和 exports 字段，只會(huì)讀取 exports 字段

腳本是定義自動(dòng)化開(kāi)發(fā)相關(guān)任務(wù)的好方法，比如使用一些簡(jiǎn)單的構(gòu)建過(guò)程或開(kāi)發(fā)工具。 在 scripts 字段里定義的腳本，可以通過(guò) yarn run <script> 命令來(lái)執(zhí)行。 例如，下面 build-project 腳本可以通過(guò) yarn run build-project 調(diào)用，并執(zhí)行 node build-project.js。

{
  "scripts": {
    "build-project": "node build-project.js"
  }
}

有一些特殊的腳本名稱。 如果定義了 preinstall 腳本，它會(huì)在包安裝前被調(diào)用。 出于兼容性考慮，install、postinstall 和 prepublish 腳本會(huì)在包完成安裝后被調(diào)用。

start 腳本的默認(rèn)值為 node server.js。

參考文檔：npm docs

{
  "config": {
    "port": "8080"
  }
}

配置你的腳本的選項(xiàng)或參數(shù)。

{
  "scripts": {
    "run": "echo $npm_package_config_port"
  }
}

配置中的鍵作為環(huán)境變量公開(kāi)給腳本(scripts)。

{
  "devDependencies": {
    "package-2": "^0.4.2"
  }
}

這些是只在你的包開(kāi)發(fā)期間需要，但是生產(chǎn)環(huán)境不會(huì)被安裝的包。

{
  "overrides": {
    "foo": "1.0.0"
  }
}

對(duì)依賴項(xiàng)的依賴項(xiàng)進(jìn)行特定更改，例如用已知的安全問(wèn)題替換依賴項(xiàng)的版本

{
  "peerDependencies": {
    "package-3": "^2.7.18"
  }
}

平行依賴允許你說(shuō)明你的包和其他包版本的兼容性。添加可選設(shè)置以消除丟失的對(duì)等依賴性警告，#6671 。

{
  "optionalDependencies": {
    "package-5": "^1.6.1"
  }
}

可選依賴可以用于你的包，但不是必需的。如果可選包沒(méi)有找到，安裝還可以繼續(xù)。

{
  "bundledDependencies": [
    "package-4"
  ]
}

打包依賴是發(fā)布你的包時(shí)將會(huì)一起打包的一個(gè)包名數(shù)組。

{
  "peerDependenciesMeta": {
    "node-sass": {
      "optional": true
    },
    "sass": {
      "optional": true
    },
    "fibers": {
      "optional": true
    }
  }
}

它允許對(duì)等依賴項(xiàng)標(biāo)記為可選

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

此選項(xiàng)指定你的包的操作系統(tǒng)兼容性，它會(huì)檢查 process.platform。

{
  "cpu": ["x64", "ia32"],
  "cpu": ["!arm", "!mips"]
}

使用這個(gè)選項(xiàng)指定你的包將只能在某些 CPU 體系架構(gòu)上運(yùn)行，這會(huì)檢查 process.arch。

{
  "private": true
}

如果你不想你的包發(fā)布到包管理器(npm 或者 私有包管理)，設(shè)置為 true。

如果你的包只允許給定依賴的一個(gè)版本，你想強(qiáng)制和命令行上 yarn install --flat 相同的行為，把這個(gè)值設(shè)為 true。

{
  "flat": true
}

請(qǐng)注意，如果你的 package.json 包含 "flat": true 并且其它包依賴你的包 (比如你在構(gòu)建一個(gè)庫(kù)，而不是應(yīng)用)， 其它那些包也需要在它們的 package.json 加上 "flat": true，或者在命令行上用 yarn install --flat 安裝。