50行代码实现Webpack组件使用次数统计

更新时间：2021年03月07日 08:37:46 作者：又在吃鱼

这篇文章主要介绍了50行代码实现Webpack组件使用次数统计,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

背景

最近有个领导想让我们搭组件库，然后我就想知道目前项目中使用的三方组件库哪些组件使用频率最高。本来想去咨询小伙伴，但是小伙伴太忙了，只能自己弄了。我就想能不能通过 webpack 来实现我的想法

效果

我们是用的 @material-ui，下面是组件使用情况

实现

我们知道 loader 的 source是文件的静态字符串如下图

最快的方案通过字符串统计用正则的方式一把梭，但是这样会有问题就是如果注释部分有的话也会被统计进去就不准确，所以我们可以通过 AST 的方式来实现，关于 ast 的概念有很多大佬都讲过了我就不啰嗦了

分析 AST

我这边是通过 @babel/parser 来分析的，我们先看下面这段代码在网站上的构成

import { Box } from '@material-ui/core';
import Autocomplete from '@material-ui/lab/Autocomplete';

我们可以看出路径 program => body ，然后声明类型是 type: ImportDeclaration,继续看如下构成

"source": {
     "type": "StringLiteral",
     "value": "@material-ui/core"
 },
 // 第二段
 "source": {
      type": "StringLiteral",
     "value": "@material-ui/lab/Autocomplete"
 },

我们发下这个字段里面的 value 有我们想要的包名所以第一段代码就是

const ast = parser.parse(source, {
      sourceType: 'module',
      plugins: ['jsx'],
 });
const getImport = 'ImportDeclaration';
const getMaterialImport = packageName || '@material-ui';
const importAst = ast.program.body.filter(
  // type 节点类型，这里我们去过滤 import 声明类型 同时去过滤
  (i) => i.type === getImport && i.source.value.includes(getMaterialImport),
);

拿到相关的 ast 数组下一步就要去拿到组件名字了, 通过观察我们发现 specifiers 标识符这个字段里面有两个字段包含组件名：imported、local

imported 表示从导出模块导出的变量
local 表示导入后当前模块的变量

这里我取的 local，因为下面这种方式并不会出现 imported 这个字段

import Autocomplete from '@material-ui/lab/Autocomplete';

这个时候包的名字也拿到了后面就简单了直奔主题贴完整代码了

demo

const parser = require('@babel/parser');
const loaderUtils = require('loader-utils');
const total = {
  len: 0,
  components: {},
};
// 对象排序
const sortable = (obj) => Object.fromEntries(Object.entries(obj).sort(([, a], [, b]) => b - a));
module.exports = function(source) {
  console.log(source, '--');
  const options = loaderUtils.getOptions(this);
  const { packageName = '' } = options;
  const callback = this.async();
  if (!packageName) return callback(null, source);
  try {
    // 解析成 ast
    const ast = parser.parse(source, {
      sourceType: 'module',
      plugins: ['jsx'],
    });
    if (ast) {
      setTimeout(() => {
        const getImport = 'ImportDeclaration';
        const getMaterialImport = packageName;
        const importAst = ast.program.body.filter(
          // type 节点类型，这里我们去过滤 import 声明类型 同时去过滤
          (i) => i.type === getImport && i.source.value.includes(getMaterialImport),
        );
        total.len = total.len + importAst.length;
        for (let i of importAst) {
          const { specifiers = [] } = i;
          for (let s of specifiers) {
            if (s.local) {
              const { name } = s.local;
              total.components[name] = total.components[name] ? total.components[name] + 1 : 1;
            }
          }
        }
        total.components = sortable(total.components);
        console.log(total, 'total');
        callback(null, source);
      }, 0);
    } else callback(null, source);
  } catch (error) {
    callback(null, source);
  }
};

调用 loader

 {
  test: /\.(jsx|)$/,
  exclude: /node_modules/,
  include: [appConfig.eslintEntry],
  use: [
    {
      loader: path.resolve(__dirname, './loader/total.js'),
      options: {
        packageName: '@material-ui',
      },
    },
  ],
},

一个简单的统计功能就完成了，当然可能还有其他更好的方式我只是提供这个想法，欢迎大家讨论

最后

做这个的意义是什么呢，比如是我们自己的组件库上线以后可以统计组件引用次数，并且以某个时间为维度比如说周。通过数据来分析我们组件库下个版本的优化方向，而且也可以做 kpi 汇报手段毕竟有数据支撑

到此这篇关于50行代码实现Webpack组件使用次数统计的文章就介绍到这了,更多相关Webpack组件次数统计内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

JavaScript 核心参考教程 RegExp对象
JavaScript 核心参考教程RegExp对象,学习正则表达式的朋友可以参考下。
2009-10-10
JavaScript实现鼠标拖拽调整div大小
这篇文章主要为大家详细介绍了JavaScript实现鼠标拖拽调整div大小，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-03-03
JavaScript获取URL中参数querystring的方法详解
这篇文章先给大家介绍了JavaScript获取URL中参数querystring的方法，而后有详解介绍了Location对象的属性和，Location对象的方法，对大家的理解很有帮助，有需要的朋友们可以参考借鉴，下面来一起看看吧。
2016-10-10
js使用swiper实现层叠轮播效果实例代码
这篇文章主要给大家介绍了关于js使用swiper实现层叠轮播效果的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2018-12-12
JS控制静态页面之间传递参数获取参数并应用的简单实例
下面小编就为大家带来一篇JS控制静态页面之间传递参数获取参数并应用的简单实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-08-08
js 固定悬浮效果实现思路代码
悬浮效果想必大家都不陌生吧，本文为大家介绍下使用js固定悬浮的实现思路及代码，感兴趣的朋友可以参考下
2013-08-08
基于bootstrap实现广告轮播带图片和文字效果
这篇文章主要介绍了基于bootstrap实现广告轮播带图片和文字效果,效果非常棒，需要的朋友可以参考下
2016-07-07
js闭包实现按秒计数
闭包是一个拥有许多变量和绑定了这些变量的环境的表达式（通常是一个函数），因而这些变量也是该表达式的一部分。相信很少有人能直接看懂这句话，因为他描述的太学术。其实这句话通俗的来说就是：JavaScript中所有的function都是一个闭包。
2015-04-04
原生javascript实现解析XML文档与字符串
这篇文章主要介绍了javascript解析XML文档和XML字符串的方法和具体的代码解析，有需要的小伙伴可以参考下。
2016-03-03
使用户点击后退按钮使效三行代码
使用户点击后退按钮使效三行代码...
2007-07-07