vue sfc parser

VUE SFC PARSER

Vue.js Parser de componente de un solo archivo para análisis estático.

Uso

Vue SFC Parser es similar al parseComponent de Vue-Template-Compiler, pero tiene algunos ayudantes útiles para el análisis de código.

 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 ) ) 

Referencias

parseComponent(code: string): SFCDescriptor

Esto es casi lo mismo que parseComponent de vue-template-compiler . SFCDescriptor parece seguir:

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

El SFCBlock es similar al vue-template-compiler también, pero tiene métodos de ayuda adicionales.

Ayudantes adicionales de SFCBlock

• calcGlobalOffset(offset: number): number

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

  Estos métodos son para calcurar la posición global desde la posición del bloque. Por ejemplo:

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

  En 38 SFC anterior, si proporciona 5 a template.calcGlobalOffset .

createDiffWatcher(): SFCDiffWatcher

Cree un objeto Watcher que detecte la diferencia de cada bloque SFC. SFCDiffWatcher tiene los siguientes métodos:

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

Puede agregar / eliminar el archivo SFC al observador utilizando métodos add / remove . Luego obtiene la diferencia de cada bloque SFC utilizando el método diff . Devuelve un objeto que tiene algunos métodos que puede registrar devoluciones de llamada que se llamarán cuando se cambien los bloques correspondientes.

Ejemplo:

 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 )
        } )
      } )
  } ) 

Licencia

MIT