vue-template-compiler

vue-template-compiler

这个包是自动生成的,请参阅 https://github.com/vuejs/vue/blob/dev/src/platforms/web/entry-compiler.js
这个包可用于将Vue 2.0模板预编译为呈现函数,以避免运行时编译开销和CSP限制。在大多数情况下,应该将它与vue-loader一起使用,只有在编写具有非常特定需求的构建工具时才会单独使用它。
在 vue 工程中,安装依赖时,需要 vue 和 vue-template-compiler 版本必须保持一致

相关资料
npm: https://www.npmjs.com/package/vue-template-compiler
github:https://github.com/vuejs/vue/tree/v2.6.10/packages/vue-template-compiler
内容安全策略 (CSP):https://developer.mozilla.org/zh-CN/docs/Web/Security/CSP

安装

npm install vue-template-compiler

API (使用示例🌰)

https://github.com/vuejs/vue/tree/v2.6.10/packages/vue-template-compiler#api
compiler.compile(template, [options])

const compiler = require('vue-template-compiler')
const result = compiler.compile(`
  <div id="test">
    <p>测试内容</p>
    <p>{{test}}</p>
  </div>`
)
console.log(result)

编译模板字符串并返回编译后的JavaScript代码。返回的结果是一个对象的格式如下:

{
  ast: ASTElement, // 解析模板生成的AST
  render: string,    // 渲染函数
  staticRenderFns: Array<string>, // 静态子树
  errors: Array<string>, //模板语法错误,如果有的话
  tips: Array<string>
}

注意,返回的函数代码使用,因此不能在严格模式代码中使用。

compiler.compileToFunctions(template) 类似于compiler.compile,但是直接返回实例化的函数,即简化版的 compiler.compile() ,只返回

{
  render: Function,
  staticRenderFns: Array<Function>
}

注意:这只在预配置的构建运行时有用,所以它不接受任何编译时选项。此外,该方法使用new Function(),因此它不符合CSP。

compiler.ssrCompile(template, [options])
与compiler.compile相同,但通过将模板的部分优化为字符串连接来生成特定于SSR的呈现函数代码,以提高SSR性能。
这在vue-loader 版本12.0.0 以上中默认使用,可以使用optimizeSSR选项禁用。

compiler.ssrCompileToFunctions(template)
与compiler.compileToFunction相同,但通过将模板的部分优化为字符串连接来生成特定于SSR的呈现函数代码,以提高SSR性能。

compiler.parseComponent(file, [options])
将 SFC (单文件组件或* .vue文件)解析为描述符(在流声明中引用SFCDescriptor类型)「以下述提供SFC为例」通常用于 SFC 构建工具,如 vue-loader和vueify等

{
  template: {
    type: 'template',
    content: '\n<div class="example">{{ msg }}</div>\n',
    start: 10,
    attrs: {},
    end: 54
  },
  script: {
    type: 'script',
    content: '\n' +
      'export default {\n' +
      '  data () {\n' +
      '    return {\n' +
      "      msg: 'Hello world!'\n" +
      '    }\n' +
      '  }\n' +
      '}\n',
    start: 77,
    attrs: {},
    end: 174
  },
  styles: [
    {
      type: 'style',
      content: '\n.example {\n  color: red;\n}\n',
      start: 194,
      attrs: {},
      end: 236
    }
  ],
  customBlocks: [
    {
      type: 'custom1',
      content: '自定义块',
      start: 257,
      attrs: {},
       end: 261
    }
  ],
  errors: []
}

compiler.generateCodeFrame(template, start, end)
生成一个代码框架,突出显示由start和end定义的模板中的部分。对于高级工具中的错误报告非常有用。

compiler.generateCodeFrame(`上述代码`, 15, 20)
1  |  <template>
2  |      <div class="example">{{ msg }}</div>
   |      ^^^^^
3  |    </template>

解析过程

// 生成ast语法树
const ast = parse(template.trim(), options)
// 标记静态内容(以免diff的时候需要重复比较)
optimize(ast, options)
// 生成 render function code
const code = generate(ast, options)
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352