IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> JavaScript知识库 -> 原来 peerDependencies 是这么个东东 -> 正文阅读

[JavaScript知识库]原来 peerDependencies 是这么个东东

原来 peerDependencies 是这么个东东

相信前端同学对 package.json 中的 dependenciesdevDependencies 都有一定的认知,通俗的理解如下:

  • dependencies:会被构建打包到最终的产物中
  • devDependencies:仅开发环境会使用到,不会被打包到最终的产物中

但是,对 peerDependencies 可能就有些陌生了,但它也相当重要,特别是期望开发插件的同学。本文就来讲讲 。

是个啥?

用两个例子来说明:

  1. antd

    仔细查看 antd 的 package.json 中的 dependencies,发现并未安装 reactreact-dom,但是随意打开一个组件你就会发现,它依赖 reactreact-dom,如下:

    // site/theme/template/Layout/index.jsx
    import * as React from 'react';
    import * as ReactDOM from 'react-dom';
    

    antd 是怎么运行起来的呢?

    这就要归功于 peerDependencies

    这里的归功并不带任何感情色彩

    antd 的 package.json 中 peerDependencies,如下

    "peerDependencies": {
      "react": ">=16.9.0",
      "react-dom": ">=16.9.0"
    },
    

    意思是:antd 不能独立的运行,需要使用它的项目中安装了 reactreact-dom 才可以运行。

    所以,要想在你的项目中使用 antd,就必须得安装 reactreact-dom

  2. webpack-dev-server

    webpack-dev-server 的 package.json 中 peerDependencies,如下

    "peerDependencies": {
      "webpack": "^4.37.0 || ^5.0.0"
    },
    

    意思是:webpack-dev-server 不能独立的运行,需要使用它的项目中安装了 webpack

总结:peer 这个词翻译过来就是"同龄, 同辈" 的意思,非常符合这里的用法。

因此我有个非常通俗的理解:你要想雇用我呀,那你就得把我的兄弟姐妹们也雇上,不然我干不了。

在项目中就是:如果你期望在项目中使用这个依赖,那就得把这个依赖的相关依赖都叫上,不然无法运行。即 peerDependencies 指定了宿主环境所需要安装的额外依赖。

唉,我知道,你可能会想说,那为啥不直接放到 dependencies,放到 dependencies 不就直接安装了吗?还搞这个干嘛?肯定有用涩,来,往下看。

有啥用?

下面我们就来看看这个东东为啥会出现哈?

  1. 如果没有 —— 导致的问题

    还是以 antd 为例,假设没有 peerDependencies,为了保证 antd 能够顺利的在宿主环境中运行起来,它不得不在 dependencies 中添加 reactreact-dom

    "dependencies": {
      "react": ">=16.9.0",
      "react-dom": ">=16.9.0"
    },
    

    那么这样做会有什么问题呢?

    重复安装 —— npm 3 以前

    在 npm3 以前,也就是 node_modules 是嵌套而非平铺的年代。 如果开发者使用 antd 并且没有 peerDependencies 的话,就需要安装两次 reactreact-dom

    感兴趣的可以去看看 npm 2 时代,那时候的嵌套

  2. 现在有了 —— 能带来的好处

    • npm 3 以前避免重复安装(间接)

      npm 3 及之后 npm 采用了平铺的方式,直接解决了重复安装问题

    • 提示宿主环境

      • 当 npm 版本为 1、2 和 7 时,如果宿主环境没有安装 peerDependencies 中指定版本或更高版本的依赖,将自动安装,

        但自动安装将造成另外的问题,即可能宿主会在”不自主安装“的情形直接使用这些自动安装的依赖

      • 当 npm 版本 3 到 6 时,并不会自动安装,但是将收到未安装 peerDependency 的警告。如下:

        npm WARN antd@4.19.3 requires a peer of react@>=16.9.0 but none is installed. You must install peer dependencies yourself.
        

好吧!

peerDependencies 的目的是提示宿主环境去安装满足 peerDependencies 所指定依赖的包。

到今天来看,peerDependencies 更多的是在公共库或者三方插件中使用,平时的开发中几乎不会使用。

参考:

  JavaScript知识库 最新文章
ES6的相关知识点
react 函数式组件 & react其他一些总结
Vue基础超详细
前端JS也可以连点成线(Vue中运用 AntVG6)
Vue事件处理的基本使用
Vue后台项目的记录 (一)
前后端分离vue跨域,devServer配置proxy代理
TypeScript
初识vuex
vue项目安装包指令收集
上一篇文章      下一篇文章      查看所有文章
加:2022-04-01 23:16:14  更:2022-04-01 23:20:10 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/24 4:49:23-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码