• Stars
    star
    151
  • Rank 246,057 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🔎 a tiny tool to show the relation of webpack internal plugins & hooks

webpack-internal-plugin-relation

目前支持 webpack v4+

介绍

一个用来展示webpack内置插件调用关系(钩子)的小工具。

https://alienzhou.github.io/webpack-internal-plugin-relation

也许可以用来帮助理清webpack内部插件之间的关系,促进webpack源码结构的理解与阅读。

起因

  • webpack使用tapable的钩子虽然能有效解耦,但是类似事件监听这种模式,其注册与调用几乎完全无关,很难将一个钩子的创建 - 注册 - 调用有效联系起来。对此,往往只能使用关键词搜索。

  • webpack内部的钩子非常多,数量达到了180+。除了官网列出的compilercompilation中那些常用的钩子,还存在着众多其他可以使用的钩子。有些挺有用的钩子你可能都无从知晓。

  • webpack v4+ 本身内置了许多插件,即使非插件,webpack的模块也经常使用tapable钩子来交互。甚至你可以认为,webpack项目中的各个模块都是“插件化”的。这也使得模块间的调用与方法的触发关系更加不明确了。

这些主要导致了,想要全局细致了解webpack中模块(插件)、钩子之间的关系具有一定的困难。为了帮助理解与阅读webpack源码,我制作了一个工具应用,来进行可视化展示,并支持一些交互操作。

演示

关系展示:

点击交互,展示模块信息,跳转到相应源码位置:

筛选关系类型进行展示:

功能

  • 收集webpack内部插件中钩子的创建、注册、调用关系,并生成原始数据
  • 力导向图可视化展示插件、钩子间关系
  • 支持力导向图节点的选择
  • 单击javascript module类节点,可在左下角展示详细信息
  • 双击javascript module类节点,可直接打开webpack对应源码查看
  • 双击节点间关系,可直接打开并定位源码具体行数,进行查看
  • ……

使用

你可以直接启动查看应用效果,或者只是生成所需的关系数据,或者构建应用并托管在自己的网站……

启动服务预览

# 拷贝代码库
git clone [email protected]:alienzhou/webpack-internal-plugin-relation.git
cd webpack-internal-plugin-relation

# 安装依赖
npm i

# 启动服务
npm start

启动完成后可以在 127.0.0.1:8085 上看到服务

生成plugin与hook相关数据

如果不想使用力导向图功能,只是需要plugin、hook之间的关系数据,可以

npm run data

生成的数据在 config/ 目录下:

  • hook.json: plugin与hook收集的原始数据
  • forceData.json: 整理合并的力导向图数据

hook.json数据格式如下:

"lib/MultiCompiler.js": {
  "hooks": [
    {
      "name": "done",
      "line": 17
    },
    {
      "name": "invalid",
      "line": 18
    },
    {
      "name": "run",
      "line": 19
    },
    {
      "name": "watchClose",
      "line": 20
    },
    {
      "name": "watchRun",
      "line": 21
    }
  ],
  "taps": [
    {
      "hook": "done",
      "type": "tap",
      "plugin": "MultiCompiler",
      "line": 37
    },
    {
      "hook": "invalid",
      "type": "tap",
      "plugin": "MultiCompiler",
      "line": 48
    }
  ],
  "calls": [
    {
      "hook": "done",
      "type": "call",
      "line": 44
    }
  ]
}

应用构建

npm run build

生成的静态文件位于 dist/ 目录下,可将站点应用托管至任何静态文件服务器。

More Repositories

1

frontend-tech-list

📝 Frontend Tech List for Developers 💡
HTML
3,536
star
2

web-highlighter

✨ A no-runtime dependency lib for text highlighting & persistence on any website ✨🖍️
TypeScript
711
star
3

blog

📖 个人博客,分享一些前端工作学习中的收获,欢迎 ✨,博客地址>>
JavaScript
411
star
4

fe-performance-journey

🚵 a Journey of Performance Optimizing in Frontend 🚀
JavaScript
323
star
5

learning-pwa

📱some samples and blogs about how to start with your first PWA
JavaScript
208
star
6

learning-pwa-ebook

an eBook for learning PWA
35
star
7

css-only-chat-node

A truly monstrous async web chat using no JS whatsoever on the frontend -- NodeJS version
JavaScript
34
star
8

react-redux-demo

a SPA demo base on react / redux / react-router
JavaScript
29
star
9

yoo-hoo

ASCII Art for printing a noticeable banner of words for your project. 🖨️
TypeScript
19
star
10

generator-webpack-kickoff

a yeoman generator to start a webpack project quickly
JavaScript
16
star
11

giframe

extract the first frame in GIF without reading whole bytes, support both browser and nodejs 📸
TypeScript
11
star
12

alienzhou.github.io

blog&sample app
HTML
7
star
13

server_push_demo

some demo about the common techs for server push, e.g. Polling, COMET, SSE, WebSocket
JavaScript
6
star
14

babel-plugin-import-customized-require

a babel plugin for ignoring some import syntax, and transforming it to customized require syntax
JavaScript
6
star
15

cross-domain-demo

JavaScript
4
star
16

react-learning

learn react internals
JavaScript
2
star
17

nodejs-module-loader-examples

some basic examples for module loaders supported in nodejs 17
JavaScript
1
star
18

alienzhou

1
star
19

deDRY

Umm…… repeat it for understanding it
JavaScript
1
star
20

webpack-kickoff-template

kickoff a empty webpack demo quickly 🚀
JavaScript
1
star