结尾

笔者之前的文章里介绍过一个代码在线编辑预览工具的实现(传送门:疾速搭建一个代码在线编辑预览工具),实现了csshtmljs的编辑,然而对于demo场景来说,vue单文件也是一个比拟好的代码组织形式,至多笔者就常常在写vue我的项目的同时顺便写写各种demo,然而分享不太不便,因为单文件不能间接运行看成果,基于此,笔者决定在之前的根底上再减少一个vue单文件的编辑及预览性能。

ps.如果没看过之前的文章也没关系,这里简略介绍一下该我的项目:code-run,根本框架应用的是vue3.x版本, 构建工具应用的是vite,代码编辑器应用的是monaco-editor,基本原理就是把cssjshtml拼接成残缺的html字符串扔到iframe里进行预览。

另外我的项目目前存在一些坑:

1.vite不反对应用commonjs模块(笔者尚未找到解决办法,晓得的敌人在评论区留个言?)。

2.三方模块目前都放在我的项目的public文件夹下,作为动态资源按需加载:

另外因为Monaco Editor自带的模块零碎和defined/require抵触,导致目前须要手动批改各个三方模块,让它只反对全局对象的形式来应用,比方:

基本思路

想要预览vue单文件,其实就是要想方法转成浏览器能意识的cssjshtml。首先想到的是应用vue-loader来转换,然而看了它的文档,发现还是必须要配合webpack能力应用,不过笔者发现了一个配套的模块vue-template-compiler,它提供了一些办法,其中有一个parseComponent办法能够用来解析vue单文件,输入各个局部的内容,输入构造如下:

所以思路就很清晰了:

1.html局部,构造固定为:

<div id="app"></div>

2.css局部,首先判断有没有应用css预处理器,有的话就先应用对应的解析器转换成css,而后再通过style标签插入到页面。

3.js局部,以vue2.x版本为例,咱们最终须要生成如下所示的构造:

new Vue({    el: '#app',    template: '',// 模板局部内容    // ...其余选项})

其余选项就是vue-template-compiler解析出的script.content内容,然而单文件里根本都是export default {}模式的;template选项很简略,就是template.content的内容。

这里的解决思路是通过babel来将export default {}的模式转换成new Vue的模式,而后再增加上eltemplate两个属性即可,这会通过写一个babel插件来实现。

装置及应用vue-template-compiler

首先vue-template-compiler模块咱们也会把它放到public文件夹下,那么它的浏览器应用版本在哪呢?咱们能够先装置它:npm i vue-template-compiler,而后在node_modules里找到它,会发现其中有一个文件:

这个就是咱们要的,间接把它复制到public文件夹下(当然也要正文掉它的模块导出),而后再把该模块删除即可,之后咱们便能够通过全局对象应用它:

// code就是vue单文件内容字符串let componentData = window.VueTemplateCompiler.parseComponent(code)// 解决style、script、template三局部的内容,最初生成css字符串、js字符串、html字符串parseVueComponentData(componentData)

生成html字符串

html局部咱们要做的就是写死一个div,用它来挂载vue实例即可:

const parseVueComponentData = async (data) => {    // html就间接渲染一个挂载vue实例的节点    let htmlStr = `<div id="app"></div>`        return {        html: htmlStr    }}

生成css字符串

style局部如果没有应用css预处理器的话那么也很简略,间接返回款式内容即可,否则须要先应用对应的预处理器把它转换成css

const parseVueComponentData = async (data) => {    // 编译css    let cssStr = []    // vue单文件的style块能够存在多个,所以解析出的styles是个数组    for(let i = 0; i < data.styles.length; i++) {        let style = data.styles[i]        // 如果应用了css预处理器,lang字段不为空        let preprocessor = style.lang || 'css'        if (preprocessor !== 'css') {            // load办法会去加载对应的三方解析模块,详情请浏览上一篇文章            await load([preprocessor])        }        // css办法会应用对应的解析器来解析,可参考之前的文章        let cssData = await css(preprocessor, style.content)        // 把解析后的css字符串增加到后果数组里        cssStr.push(cssData)    }    return {        // 最初把多个style块的css拼接成一个        css: cssStr.join('\r\n')    }}

下面的css会调用对应的css预处理器的解析模块来编译,比方less的解决如下:

const css = (preprocessor, code) => {    return new Promise((resolve, reject) => {        switch (preprocessor) {            case 'css':                resolve(code)                break;            case 'less':                window.less.render(code)                    .then((output) => {                        resolve(output.css)                    },                    (error) => {                        reject(error)                    });                break;        }    })}

生成js字符串

script局部的内容咱们会应用babel来编译:

const parseVueComponentData = async (data, parseVueScriptPlugin) => {    // babel编译,通过编写插件来实现对ast的批改    let jsStr = data.script ? window.Babel.transform(data.script.content, {        presets: [            'es2015',            'es2016',            'es2017',        ],        plugins: [            // 插件            parseVue2ScriptPlugin(data)        ]    }).code : ''    return {        js: jsStr    }}

babel插件其实就是一个函数,接管一个babel对象作为参数,而后须要返回一个对象,咱们能够在该对象的visitor属性里拜访到AST节点,并进行一些批改,visitor中的每个函数都接管2个参数:pathstatepath示意两个节点之间连贯的对象,蕴含节点信息及一些操作方法,插件开发的具体文档请参考:plugin-handbook。

根本构造如下:

const parseVue2ScriptPlugin = (data) => {    return function (babel) {        let t = babel.types        return {            visitor: {                            }        }    }}

转换export default语法

接下来再次明确咱们的需要,咱们要把export default {} 的模式转换成new Vue的模式,具体怎么做呢,咱们能够应用astexplorer这个工具先看看这两种构造的AST的差异是什么:

能够发现黄色局部都是一样的,只是外层的节点不一样,所以咱们能够拜访ExportDefaultDeclaration节点,而后把它替换成ExpressionStatement就行了,创立新节点也很简略,参考AST及babel-types文档即可。

const parseVue2ScriptPlugin = (data) => {    return function (babel) {        let t = babel.types        return {            visitor: {                // 拜访export default节点,把export default转换成new Vue                ExportDefaultDeclaration(path) {                    // 替换本身                    path.replaceWith(                        // 创立一个表达式语句                        t.expressionStatement(                            // 创立一个new表达式                            t.newExpression(                                // 创立名称为Vue的标识符,即函数名                                t.identifier('Vue'),                                // 函数参数                                [                                    // 参数就是ExportDefaultDeclaration节点的declaration属性对应的节点                                    path.get('declaration').node                                ]                            )                        )                    );                }            }        }    }}

成果如下:

到这里还没完结,eltemplate属性咱们还没有给它加上,同样能够先在AST工具外面尝试一下:

很显著咱们须要拜访ObjectExpression节点,而后给它的properties属性增加两个节点,首先想到的做法是这样的:

const parseVue2ScriptPlugin = (data) => {    return function (babel) {        let t = babel.types        return {            visitor: {                ExportDefaultDeclaration(path) {                    // ...                },                ObjectExpression(path) {                    // 如果父节点是new语句,那么就增加该节点的properties                    if (path.parent && path.parent.type === 'NewExpression' ) {                        path.node.properties.push(                            // el                            t.objectProperty(                                t.identifier('el'),                                t.stringLiteral('#app')                            ),                            // template                            t.objectProperty(                                t.identifier('template'),                                t.stringLiteral(data.template.content)                            )                        )                    }                }            }        }    }}

这样做的问题是什么呢,假如咱们要转换的代码是这样的:

new Vue({});export default {    created() {        new Vue({});    },    data() {        return {            msg: "Hello world!",        };    },    mounted() {        new Vue({});    },};

咱们想要的应该只是给export default这个对象增加这两个属性,然而实际效果如下:

能够看到所有的new语句的对象都被批改了,这显然不是咱们想要的,那么正确的办法是什么呢,咱们应该在替换完ExportDefaultDeclaration节点后立马递归遍历该节点,并且增加完这两个属性后立刻进行遍历:

const parseVue2ScriptPlugin = (data) => {    return function (babel) {        let t = babel.types        return {            visitor: {                ExportDefaultDeclaration(path) {                    // export default -> new Vue                    // ...                    // 增加el和template属性                    path.traverse({                        ObjectExpression(path2) {                            if (path2.parent && path2.parent.type === 'NewExpression' ) {                                path2.node.properties.push(                                    // el                                    t.objectProperty(                                        t.identifier('el'),                                        t.stringLiteral('#app')                                    ),                                    // template                                    t.objectProperty(                                        t.identifier('template'),                                        t.stringLiteral(data.template.content)                                    ),                                )                                path2.stop()                            }                        }                    });                }            }        }    }}

成果如下:

到这里,htmljscss三局部的内容都解决完了,咱们把它们拼成残缺的html字符串,而后扔到iframe里即可预览,成果如下:

转换module.exports语法

除了应用export default语法导出,也是可用应用module.exports = {}的,所以咱们也须要适配一下这种状况,根本套路都一样,先剖析AST节点树的差别,而后替换节点:

module.exports自身就是一个ExpressionStatement,所以咱们只须要拜访AssignmentExpression节点,并替换成new VuenewExpression节点即可:

const parseVue2ScriptPlugin = (data) => {    return function (babel) {        let t = babel.types        return {            visitor: {                // 解析export default模块语法                ExportDefaultDeclaration(path) {                    // ...                },                // 解析module.exports模块语法                AssignmentExpression(path) {                    try {                        let objectNode = path.get('left.object.name')                        let propertyNode = path.get('left.property.name')                        if (                            objectNode                             && objectNode.node === 'module'                             && propertyNode                             && propertyNode.node === 'exports'                        ) {                            path.replaceWith(                                t.newExpression(                                    t.identifier('Vue'),                                    [                                        path.get('right').node                                    ]                                )                            )                            // 增加el和template属性                            // 逻辑同上                        }                    } catch (error) {                        console.log(error)                    }                }            }        }    }}

当然,这样写如果存在多个module.exports = {}语句是会出错的,不过这种场景应该不常见,咱们就不论了。

其余工具的做法

社区上有一些工具能够用来在浏览器端反对.vue文件的加载及应用,比方http-vue-loader,应用形式如下:

<!doctype html><html lang="en">  <head>    <script src="https://unpkg.com/vue"></script>    <script src="https://unpkg.com/http-vue-loader"></script>  </head>  <body>    <div id="my-app">      <my-component></my-component>    </div>    <script type="text/javascript">      new Vue({        el: '#my-app',        components: {          'my-component': httpVueLoader('my-component.vue')        }      });    </script>  </body></html>

接下来按它的原理咱们再来实现一遍。

咱们先不论款式,看一下根本的htmljs局部:

const parseVueComponentData2 = (data) => {    let htmlStr = `        <div id="app">            <vue-component></vue-component>        </div>    `    // 把vue单文件字符串里的/转成\/是因为如果不转,那么浏览器会错把模板里的标签当成页面的理论标签,会造成页面解析谬误    let jsStr = `        new Vue({            el: '#app',            components: {                'vue-component': VueLoader(\`${data.replaceAll('/', '\\/')}\`)            }        });    `    return {        html: htmlStr,        js: jsStr,        css: ''    }}

能够看到咱们这次把vue单文件当成一个组件来应用,而后咱们要实现一个全局办法VueLoader,接管单文件的内容,返回一个组件选项对象。

接下来咱们不应用vue-template-compiler,而是本人来解析,原理是创立一个新的HTML文档,而后把vue单文件的内容扔到该文档的body节点,而后再遍历body节点的子节点,依据标签名来判断各个局部:

// 全局办法window.VueLoader = (str) => {    let {        templateEl,        scriptEl,        styleEls    } = parseBlock(str)}// 解析出vue单文件的各个局部,返回对应的节点 const parseBlock = (str) => {    // 创立一个新的HTML文档    let doc = document.implementation.createHTMLDocument('');    // vue单文件的内容增加到body节点下    doc.body.innerHTML = str    let templateEl = null    let scriptEl = null    let styleEls = []    // 遍历body节点的子节点    for (let node = doc.body.firstChild; node; node = node.nextSibling) {        switch (node.nodeName) {            case 'TEMPLATE':                templateEl = node                break;            case 'SCRIPT':                scriptEl = node                break;            case 'STYLE':                styleEls.push(node)                break;        }    }    return {        templateEl,        scriptEl,        styleEls    }}

接下来解析script块的内容,咱们最终是要返回一个选项对象,也就是这样的:

{    name: 'vue-component',    data () {        return {            msg: 'Hello world!'        }    },    template: ''}

而后再看看下面的截图,你应该有想法了,咱们能够手动创立一个module.exports对象,而后让script的代码运行时能拜访到该对象,那么不就相当于把这个选项对象赋值到咱们定义的module.exports对象上了吗。

window.VueLoader = (str) => {    // ...    let options = parseScript(scriptEl)}// 解析scriptconst parseScript = (el) => {    let str = el.textContent    let module = {        exports: {}    }    let fn = new Function('exports', 'module', str)    fn(module.exports, module)    return module.exports}

接下来再把模板选项和组件名称增加到该对象上,最初返回该对象即可:

window.VueLoader = (str) => {    // ...    options.template = parseTemplate(templateEl)    options.name = 'vue-component'    return options}// 返回模板内容字符串const parseTemplate = (el) => {    return el.innerHTML}

css局部的解析和之前咱们的做法是一样的,这里不再赘述,然而http-vue-loader还实现了款式的scoped解决。

这个工具的一个毛病是不反对export default模块语法。

参考链接

最终成果预览:https://wanglin2.github.io/code-run-online/。

残缺代码请移步我的项目仓库:https://github.com/wanglin2/code-run。

疾速搭建一个代码在线编辑预览工具

astexplorer

http-vue-loader

Babel plugin-handbook

vue-template-compiler

babel-types