vue sfc parser

VUE SFC解析器

vue.js单文件组件解析器用于静态分析。

用法

VUE SFC解析器类似于Vue-Template-Compiler的parseComponent ，但有一些有用的助手用于代码分析。

 const { parseComponent } = require ( 'vue-sfc-parser' )

const code = `
<template>
  <p>Hi</p>
</template>

<script lang="ts">
export default {}
</script>
`

const res = parseComponent ( code )
console . log ( res . template . calcGlobalOffset ( 7 ) )
console . log ( res . script . calcGlobalOffset ( 5 ) ) 

参考

parseComponent(code: string): SFCDescriptor

这几乎与vue-template-compiler的parseComponent相同。 SFCDescriptor看起来如下：

 interface SFCDescriptor {
  template : SFCBlock | null
  script : SFCBlock | null
  styles : SFCBlock [ ]
  customBlocks : SFCBlock [ ]
}

SFCBlock也类似于vue-template-compiler One，但具有其他帮助方法。

sfcblock的其他帮助者

• calcGlobalOffset(offset: number): number

• calcGlobalRange(range: [number, number]): [number, number]

  这些方法用于从块位置计算全局位置。例如：

  < docs >Test Docs</ docs >
  < template >
    < p >Hi</ p >
  </ template >

  在上面的SFC上，如果您提供5 template.calcGlobalOffset ，该calcglobaloffset指示了模板块的启动位置，则它将返回38 ，这是文件开始的位置。

createDiffWatcher(): SFCDiffWatcher

创建一个观察器对象，该对象将检测每个SFC块的差异。 SFCDiffWatcher具有以下方法：

• add(filename: string, content: string): SFCDescriptor
• remove(filename: string): void
• diff(filename: string, content: string): SFCDiff

您可以使用add / remove方法将 /删除SFC文件添加到观察者。然后，您可以使用diff方法获得每个SFC块的差异。它返回具有一些方法的对象，您可以在更改相应的块时注册该方法，该对象可以注册回调。

例子：

 const { createDiffWatcher } = require ( 'vue-sfc-parser' )
const fs = require ( 'fs' )
const chokidar = require ( 'chokidar' )

const watcher = createDiffWatcher ( )

chokidar
  . watch ( '**/*.vue' )
  . on ( 'add' , filename => {
    watcher . add ( filename , fs . readFileSync ( filename , 'utf8' ) )
  } )
  . on ( 'unlink' , filename => {
    watcher . add ( filename )
  } )
  . on ( 'change' , filename => {
    watcher
      . diff ( filename , fs . readFileSync ( filename , 'utf8' ) )
      . template ( template => {
        console . log ( template . content )
      } )
      . script ( script => {
        console . log ( script . content )
      } )
      . styles ( styles => {
        styles . forEach ( s => {
          console . log ( s . content )
        } )
      } )
      . customBlocks ( 'block-name' , blocks => {
        blocks . forEach ( b => {
          console . log ( b . content )
        } )
      } )
  } ) 

执照

麻省理工学院