熟悉又不熟悉的package.json

我们在项目中经常看见package.json，也都知道他是管理安装依赖包的文件。但是他具体的属性是如何配置，每一个属性又代表什么意义？

首先明确一点，它是个json文件，内容一定是json格式。

属性列表：（参考官网：http://nodejs.cn/learn/the-package-json-guide）

• name:设置软件包的名称，名称必须少于 214 个字符，且不能包含空格，只能包含小写字母、连字符（-）或下划线（_）

{
 "name":"so"
}

• author:作者名称，两种形式：

{
  "author":"小码农 <email@xmn.com> (http:xmn.com)"
}
{
   "author":{
        "name":"小码农",
        "email":"email@xmn.com",
        "url":"http:xmn.com"
    }
}

• contributors:出作者外的贡献者。是数组。两种形式同上。

• bugs：链接到软件包的问题跟踪器。类似GitHub的issues

{
   "bug":"https://github.com/xmn/issues"
}

• homepage:设置软件包的主页

{
  "homepage": "http://www.xmn.com"
}

• version：指定当前版本。（!!!不要忽略它，系统起不来可能就是版本问题）

    一般结构为x.x.x,第一位为主版本号，第二位为次版本号，第三位为补丁版本号。

• 主版本：具有重大更改的版本（进行不兼容的 API 更改）
• 次版本：引入向后兼容的更改的版本（以向后兼容的方式添加功能）
• 补丁版本：仅修复缺陷的版本（进行向后兼容的缺陷修复）

同时版本号还有些符号使用：

• ^: 只会执行不更改最左边非零数字的更新。 如果写入的是 ^0.13.0，则当运行 npm update 时，可以更新到 0.13.1、0.13.2 等，但不能更新到 0.14.0 或更高版本。 如果写入的是 ^1.13.0，则当运行 npm update 时，可以更新到 1.13.1、1.14.0 等，但不能更新到 2.0.0 或更高版本。

• ~: 如果写入的是 〜0.13.0，则当运行 npm update 时，会更新到补丁版本：即 0.13.1 可以，但 0.14.0 不可以。
• >: 接受高于指定版本的任何版本。
• >=: 接受等于或高于指定版本的任何版本。
• <=: 接受等于或低于指定版本的任何版本。
• <: 接受低于指定版本的任何版本。
• =: 接受确切的版本。
• -: 接受一定范围的版本。例如：2.1.0 - 2.6.2。
• ||: 组合集合。例如 < 2.1 || > 2.6。

 

• license：许可证，对你软件包的限制，别人应该如何使用它

SPDX协议链接：https://spdx.org/licenses/ 有兴趣的可以看看

//普通的SPDX通用许可证
{
  "license" : "BSD-3-Clause"
}
//多个SPDX通用许可证
{
  "license" : "(ISC OR GPL-3.0)"
}
//自定义许可，在软件包的顶层创建一个<filename>文件
{
  "license" : "SEE LICENSE IN <filename>"
}
//不希望以任何条款授予他人使用私有或未发布软件包的权利
{
  “ license” ：“ unlicensed” 
}

• keywords：关键字，方便别人在npm搜索到

"keywords": [
  "xmn"
]

• description:  软件包的描述，方便别人知道你这个软件是干嘛用的

{
  "description": "package.json搬砖教学"
}

• repository：指定了此程序包仓库所在的位置

注：monorepo：https://zhuanlan.zhihu.com/p/77577415

//如果git repo在GitHub上，则该npm docs 命令将能够找到您
{
  "repository": {
    "type": "git",
    "url": "https://github.com/npm/cli.git"
  }
}
//对于GitHub，GitHub gist，Bitbucket或GitLab存储库，可以使用与以下相同的快捷方式语法
{
  "repository": "npm/npm",
  "repository": "github:user/repo",
  "repository": "gist:11081aaa281",
  "repository": "bitbucket:user/repo",
  "repository": "gitlab:user/repo"
}
//如果package.json不在根目录中（例如，它是monorepo的一部分）,可以指定其所在的目录：
{
  "repository": {
    "type": "git",
    "url": "https://github.com/facebook/react.git",
    "directory": "packages/react-dom"
  }
}

• main：commonJS规范的软件包的入口点。支持浏览器环境和Node环境

• browser：如果你的模块（仅）在浏览器环境使用，应该用browser字段替换main字段。

• module：ESM规范的软件包入口点。支持浏览器环境和Node环境

{
  "main": "src/main.js",  // main 
  "module": "src/main.mjs", // module

  // browser 可定义成和 main/module 字段一一对应的映射对象，也可以直接定义为字符串
  "browser": {
    "./src/main.js": "./src/main.browser.js", // browser+cjs
    "./src/main.mjs": "./src/main.browser.mjs"  // browser+mjs
  },
  "browser": "./lib/index.browser.js" // browser
}

我们看到了5中情况。main，moudle，browser+commonJs,browser+ESM,browser。那如果我们都定义了，在不同环境会怎么调用呢？

还有个优先级的点，优先级：mjs>js（mjs是ESM规范的js文件后缀）

剩下的具体自己分析实验。不做详细解释。

• private：如果设置为 true，则可以防止应用程序/软件包被意外发布到 npm 上。

{
  "private": true
}

• scripts：可以定义一组可以运行的 node 脚本。

• 具体各个生命周期的脚本命令：https://docs.npmjs.com/cli/v7/using-npm/scripts

可通过npm run xxx调用,如果安装了yarn，可以使用yarn xxx，例如npm run dev

{
    "scripts": {
      "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
      "start": "npm run dev",
      "unit": "jest --config test/unit/jest.conf.js --coverage",
      "test": "npm run unit",
      "lint": "eslint --ext .js,.vue src test/unit",
      "build": "node build/build.js"
    }
}

• dependencies:  设置作为依赖安装的 npm 软件包的列表。

        当使用 npm install  <packagename> 则安装到该属性下

• devDependencies：设置作为开发依赖安装的 npm 软件包的列表。

和dependencies的区别：作为开发依赖不会被部署到生产环境。 npm install --save-dev <packagename>

• engines:设置此软件包/应用程序要运行的 Node.js 或其他命令的版本。

"engines": {
  "node": ">= 6.0.0",
  "npm": ">= 3.0.0",
  "yarn": "^0.13.0"
}

• browserslist：用于告知要支持哪些浏览器（及其版本）。 Babel、Autoprefixer 和其他工具会用到它，以将所需的 polyfill 和 fallback 添加到目标浏览器。

"browserslist": [
  "> 1%",
  "last 2 versions",
  "not ie <= 8"
]

以上的属性并不全面，也是我参考nodeJs官网获悉http://nodejs.cn/learn/the-package-json-guide，记录下，增加下自身记忆。

还有一些nodeJs官网没有列出的属性，在npm官网也可以看到：https://docs.npmjs.com/cli/v7/configuring-npm/package-json

以下为nodeJS未列出的：

• funding：指定一个对象，包含一个URL，该URL提供了如何资助你的包开发的最新信息，或者一个URL字符串，或者一个数组

{
  "funding": {
    "type" : "individual",
    "url" : "http://example.com/donate"
  },
  "funding": {
    "type" : "patreon",
    "url" : "https://www.patreon.com/my-account"
  },
  "funding": "http://example.com/donate",
  "funding": [
    {
      "type" : "individual",
      "url" : "http://example.com/donate"
    },
    "http://example.com/donateAlso",
    {
      "type" : "patreon",
      "url" : "https://www.patreon.com/my-account"
    }
  ]
}

• config:  “config”对象可用于设置包scripts中使用的配置参数，这些配置参数跨升级持久存在。（待我学习后过来补充哈哈哈哈）

• 这里应该还涉及到config的具体配置，着急同学可以先看看官方的英文文档：https://docs.npmjs.com/cli/v7/using-npm/config

先发布一版吧。写了两天，估计还有一小半，还有好多没见过的，争取5.1前写完哈