如何正确使用dependencies

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

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。

json 复制代码
{
  "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可以定义一个元素是包名的数组,当发布包的时候,这些包会被打包到一起。

json 复制代码
{ 
    "name": "awesome-web-framework",
    "version": "1.0.0", 
    "bundleDependencies": [ 
        "renderized", "super-streams" 
    ]
}

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

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

相关推荐
人工智能训练师4 小时前
Ubuntu22.04如何安装新版本的Node.js和npm
linux·运维·前端·人工智能·ubuntu·npm·node.js
Seveny074 小时前
pnpm相对于npm,yarn的优势
前端·npm·node.js
yddddddy5 小时前
css的基本知识
前端·css
昔人'5 小时前
css `lh`单位
前端·css
Nan_Shu_6147 小时前
Web前端面试题(2)
前端
知识分享小能手7 小时前
React学习教程,从入门到精通,React 组件核心语法知识点详解(类组件体系)(19)
前端·javascript·vue.js·学习·react.js·react·anti-design-vue
蚂蚁RichLab前端团队8 小时前
🚀🚀🚀 RichLab - 花呗前端团队招贤纳士 - 【转岗/内推/社招】
前端·javascript·人工智能
孩子 你要相信光8 小时前
css之一个元素可以同时应用多个动画效果
前端·css
huangql5208 小时前
npm 发布流程——从创建组件到发布到 npm 仓库
前端·npm·node.js
Days20509 小时前
LeaferJS好用的 Canvas 引擎
前端·开源