npm 包 yarnhook 使用教程

阅读时长 3 分钟读完

介绍

yarnhook 是一个可在 Yarn 安装依赖包时,对某些依赖进行特殊处理的工具。通过 yarnhook,我们可以在安装依赖时自动执行一些脚本,例如修改依赖包内部的文件、替换依赖包中某些文件等操作。

安装

使用 npm 进行全局安装:

使用方法

创建配置文件

在项目根目录下,创建 .yarnhookrc.json 文件,并按照如下格式配置需要进行特殊处理的依赖包:

-- -------------------- ---- -------
-
  -------- -
    -
      ------- ---------
      ---------- -----------
      ---------- -
        ----- ------------------------
      -
    -
  -
-

其中,name 表示依赖包名称,pattern 表示匹配规则(支持通配符),scripts 表示需要执行的脚本。

执行命令

在使用 yarn 安装依赖时,加上 --use-yarnhook 参数即可启用 yarnhook,例如:

示例代码

以下是一个简单的示例,当安装 my-lib 开头的依赖时,将其内部的 index.js 文件替换为 modified-index.js

-- -------------------- ---- -------
-- -----------------------

----- -- - --------------

-------- ---------------- -------- -
  ---------------------- ---------
-

-------- ---------------------- -
  ----- ------------ - ----------------------------------- ---------
  ----- --------------- - ---------------------------- ---------- ------------------- ----------------- ----------
  ------------------------------ -----------------
-

-------------- - -------- ---------- ------------ -
  -- --------- --- ------------- -- ------------------------------- -
    ------------------------------
  -
--

注意事项

  • .yarnhookrc.json 配置文件中的规则是按照给定的顺序进行匹配的,因此需要特别注意配置的顺序。
  • yarnhook 只支持在安装依赖时执行脚本,无法在卸载依赖时进行特殊处理。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/43873

纠错
反馈