npm 包 filelist-md-webpack-plugin 使用教程

阅读时长 3 分钟读完

前言

在日常的前端开发中,我们经常需要生成项目中所有文件的列表,这个时候,我们就可以使用 filelist-md-webpack-plugin 来生成一个 Markdown 格式的文件列表。

什么是 filelist-md-webpack-plugin?

filelist-md-webpack-plugin 是一个 webpack 插件,可以在 webpack 编译过程中,自动生成项目中所有文件的 Markdown 列表文档。

如何使用 filelist-md-webpack-plugin?

  1. 安装

在项目中使用 npm 安装 filelist-md-webpack-plugin:

  1. 配置

在 webpack.config.js 中添加如下代码:

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

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

其中,

  • filename:指定生成的文件名。
  • path:指定生成的文件路径。
  • exclude:指定需要排除的文件夹,可以是正则表达式。
  1. 运行

执行 webpack 编译命令时,会自动生成 Markdown 文件。打开生成的 Markdown 文件,可以看到项目中所有文件的列表。

示例代码

webpack.config.js:

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

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

总结

使用 filelist-md-webpack-plugin 可以方便地生成项目中所有文件的列表,方便我们进行文件管理和维护。同时,filelist-md-webpack-plugin 也是一个比较简单的 webpack 插件,可以很好地进行自定义开发。

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

纠错
反馈