阅读 1000

Webpack 写一个 markdown loader

前段时间在公司内部写了个 UI 组件库,需要有组件说明文档。我们的组件文档一般都是用 md 文件书写,然后渲染成页面展示。我们首先基于 vue-cli 脚手架生成前端项目配置,然后我们通过 webpack 配置 loader 的方式加载我们的扩展。

基础准备

在 Webpack 中,每个文件都视作一个模块,不同模块通过配置不同的加载器(loader)进行解析。

首先我们先创建一个 md 文件,并写下这样一段代码:

    我是一段文字
复制代码

然后在页面中引入这个 md 文件,我们会发现有以下报错:

image.png 错误信息的是说在解析模块时遇到了非法字符,没有一个合适的 loader 去处理这种文件类型,我们需要额外的 loader 支持去解析这个文件。

我们知道,在 Webpack 内部是只支持 JS 模块解析的,对于其他类型的模块我们就需要引入模块处理器(loader),比如解析样式的 style-loader、css-loader,解析 Vue 单文件组件的 vue-loader,以及我们今天写的 md-loader。

开发流程

我们的需求是开发一个支持 Vue 组件渲染的 markdown 文档加载器,让我们能够直接读取 md 文件生成 Vue 组件进行预览,所以我们的开发流程如下:

支付md文件的使用

我们先在我们创建的项目下建立一个 md-loader 的文件夹,然后先写下如下代码:

var MarkdownIt = require('markdown-it');
const md = new MarkdownIt();

module.exports = function (source) {
  const content = md.render(source);
  const code = `module.exports = ${JSON.stringify(content)}`
  return code
}
复制代码

然后在 vue.config.js 中配置引入 md-loader:

// vue.config.js
const path = require("path");

function resolve(dir) {
  return path.join(__dirname, dir);
}

module.exports = {
  chainWebpack: config => {
    // 使用自定义 loader
    config.module
      .rule("md-loader")
      .test(/\.md$/)
      .use("md-loader")
      .loader(resolve("./md-loader/index.js"))
      .end();
  },
}
复制代码

支持 Vue 组件使用

在上面我们已经通过插件 markdown-it 解析并生成 html 返回,使我们能够支持 md 文件的渲染展示。那么我们现在也在支持在 md 文件中写 Vue 组件,我们该怎么做呢? 首先我们先调整下我们在 vue.config.js 中的配置:

// vue.config.js
const path = require("path");

function resolve(dir) {
  return path.join(__dirname, dir);
}

module.exports = {
  chainWebpack: config => {
    // 使用自定义 loader
    config.module
      .rule("md-loader")
      .test(/\.md$/)
      .use("vue-loader")
      .loader("vue-loader")
      .options({
        compilerOptions: {
          preserveWhitespace: false
        }
      })
      .end()
      .use("md-loader")
      .loader(resolve("./md-loader/index.js"))
      .end();
  },
}
复制代码

然后修改 md-loader 文件,我们将 md 文件看作是一个 Vue 的单文件组件,所以我们的导出格式调整如下:

// ./md-loader/index.js

var MarkdownIt = require('markdown-it');
const md = new MarkdownIt();

module.exports = function (source) {
  const content = md.render(source);
  const code = `
    <template>
      <section class="demo-container">
        ${content}
      </section>
    </template>
        <script>
            export default {}
        </script>
  `;
  return code;
}
复制代码
<template>
  <div id="app">
    <img alt="Vue logo" src="./assets/logo.png">
    <testMd />
  </div>
</template>

<script>
import testMd from "./test.md";

export default {
  name: 'App',
  components: {
    testMd
  }
}
</script>
复制代码

再次运行我们就能正常引入并渲染 md 文件了:

image.png

支持 Vue 内置模板声明

我们将 md 文件转化为 Vue 单文件使用,以上已经能支持 Vue 单文件的所有功能,默认支持 md 内声明全局组件的使用,那么如果我们想在 md 内部写局部组件呢? 我们调整下我们引入的 md 文件代码:

我是一段文字

:::demo

```vue
<template>
  <div>
    测试 md 内置组件 -- <span class="text">{{ msg }}</span>
  </div>
</template>

<script>
export default {
  data() {
    return {
      msg: "Hello World !!!",
    };
  },
};
</script>
<style scoped>
.text {
  color: #f00;
}
</style>
复制代码

我们先分析下如何实现,原理很简单。就是找到对应的 Vue 模板模块,然后打上标记并提取成局部组件进行挂载。

image.png

解析并标记 Vue 模板位置

这里我们引入插件 markdown-it-chain 和 markdown-it-container,另外,对于 markdown-it 解析的 tokens 可以查看在线示例,以下是具体代码:

// ./md-loader/config.js

// 支持链式使用
const Config = require("markdown-it-chain");
// 匹配内容块,解析以 ::: 包裹的内容
const mdContainer = require("markdown-it-container");

const config = new Config();
function containers(md) {
  md.use(mdContainer, "demo", {
    validate(params) {
      return params.trim().match(/^demo\s*(.*)$/);
    },
    render(tokens, idx) {
      // 判断代码块开启标签 nesting === 1
      if (tokens[idx].nesting === 1) {
        // 判断是否包裹在代码块(fence)中
        const content = tokens[idx + 1].type === "fence" ? tokens[idx + 1].content : "";
        // 返回以代码块包裹,并添加标记
        return `<demo-block>
        <!--demo-begin: ${content}:demo-end-->
        `;
      }
      return "</demo-block>";
    },
  });
  md.use(mdContainer, "tip")
}

config.options
  .html(true)
  .end()

  .plugin("containers")
  .use(containers)
  .end();

const md = config.toMd();

module.exports = md;
复制代码

匹配代码块内容,并添加到组件中

我们将 md 解析后提取内置组件保存成 Vue 的单文件组件,然后将转化后的文件交给下一个 loader(vue-loader)进行解析。

const fs = require("fs");
const path = require("path");
const md = require("./config");
const cacheDir = "../node_modules/.cacheDir";

function resolve(dir) {
  return path.join(__dirname, dir);
}

if (!fs.existsSync(resolve(cacheDir))) {
  fs.mkdirSync(resolve(cacheDir))
}

module.exports = function(source) {
  // 获取 md 文件转化后的内容
  const content = md.render(source);

  const startTag = "<!--demo-begin:"; // 匹配开启标签
  const startTagLen = startTag.length; 
  const endTag = ":demo-end-->"; // 匹配关闭标签
  const endTagLen = endTag.length;

  let components = ""; // 存储组件示例
  let importVueString = ""; // 存储引入组件声明
  let uid = 0; // demo 的 uid
  const outputSource = []; // 输出的内容
  let start = 0; // 字符串开始位置

  let commentStart = content.indexOf(startTag);
  let commentEnd = content.indexOf(endTag, commentStart + startTagLen);

  while (commentStart !== -1 && commentEnd !== -1) {
    outputSource.push(content.slice(start, commentStart));
    // 获取代码块内容
    const commentContent = content.slice(
      commentStart + startTagLen,
      commentEnd
    );

    const componentNameId = `demoContainer${uid}`;
    // 将文件写入本地
    fs.writeFileSync(resolve(`${cacheDir}/${componentNameId}.vue`), commentContent, "utf-8");
    // 声明内容插槽传入
    outputSource.push(`<template slot="source"><${componentNameId} /></template>`);
    // 添加引入声明
    importVueString += `\nimport ${componentNameId} from '${cacheDir}/${componentNameId}';`;
    // 添加组件声明
    components += `${componentNameId},`;

    // 重新计算下一次的位置
    uid++;
    start = commentEnd + endTagLen;
    commentStart = content.indexOf(startTag, start);
    commentEnd = content.indexOf(endTag, commentStart + startTagLen);
  }

  // 后续内容添加
  outputSource.push(content.slice(start));
  return `
    <template>
      <section class="demo-container">
        ${outputSource.join("")}
      </section>
    </template>
    <script>
      ${importVueString}
      export default {
        name: 'demo-container',
        components: {
          ${components}
        },
      }
    </script>
  `;
};
复制代码

最终效果

由于我们生成的代码块会挂载在全局组件 下,所以我们需要创建一个全局组件并引入,代码也很简单:

<template>
  <div class="demo-block">
    <slot name="source"></slot>
  </div>
</template>

<script>

export default {
  name: "DemoBlock",
};
</script>
复制代码

我们再次执行,最终实现的渲染效果如下:

image.png 实现思路其实很简单,网上也有很多类似的插件支持,实际上我们还是想自己实现一遍 Webpack Loader。

以上我们已经实现了 markdown 文件支持 Vue 组件渲染了,我们还可以添加更多扩展支持 markdown 文件的展示,这里就不多做讲解了。 最后也建议大家可以看下 Webpack 文档《Writing a Loader》章节,学习开发简单 loader。

文章分类
前端
文章标签