如何正确使用dependencies

开发项目时候，我们需要安装各种依赖项(dependencies)，这体现在package.json中就是：

{
  "name": "bubucuo",
  "dependencies": {
    "package-a": "^1.0.0"
  },
  "devDependencies": {
    "package-b": "^1.0.0"
  },
  "peerDependencies": {
    "package-c": "^1.0.0"
  },
  "optionalDependencies": {
    "package-d": "^1.0.0"
  }
}

问题来了，怎么这么多dependencies，该如何使用呢？接下来我们分别来区分一下：

dependencies

dependencies是常见的依赖选项，这里是指代码运行的时候需要的依赖，也是开发和生产环境都需要的依赖，比如React、Vue等就是这样的依赖。

当我们执行 npm install x 或者yarn add x或者pnpm install x的时候，安装的就是这个依赖~

后文安装依赖的命令使用pnpm来举例子~

devDependencies

devDependencies是指开发环境下需要的依赖，这样的依赖在代码运行的时候并不需要，比如babel等。

peerDependencies

peerDependencies是一种特别的依赖，这种依赖只有在发布包的时候才会用到。

换句话说，如果用户想要安装x，但是用户使用x的时候又必须使用y，那么x的package.json里的peerDependencies就要包括y。

比如用户使用react-dom的时候就依赖react，因此react-dom的源码包里的package.json里就长这样：

peerDependenciesMeta

辅助peerDependencies设置，比如下面的代码，就可以设置当soy-milk依赖为可选，即安装失败也不会提示warning。

{
  "name": "tea-latte",
  "version": "1.3.5",
  "peerDependencies": {
    "tea": "2.x",
    "soy-milk": "1.2"
  },
  "peerDependenciesMeta": {
    "soy-milk": {
      "optional": true
    }
  }
}

optionalDependencies

optionalDependencies是指可选的依赖。可选的依赖如果安装失败，并不会提示错误信息或者妨碍依赖安装进度。

举个实用场景的例子，有些依赖并不需要运行在每个机器上，并且这种依赖安装失败也有其它的兼容方案，那么这个时候就可以使用optionalDependencies。比如Watchman。

bundledDependencies or bundleDependencies

这两个写法均有效。

bundledDependencies可以定义一个元素是包名的数组，当发布包的时候，这些包会被打包到一起。

{ 
    "name": "awesome-web-framework",
    "version": "1.0.0", 
    "bundleDependencies": [ 
        "renderized", "super-streams" 
    ]
}

另外， bundleDependencies 也能被设置成布尔值，当设置为true的时候，所有依赖都会被打包到一起。反之为false的时候，则不会打包任何包。

参考：docs.npmjs.com/cli/v9/conf...