vue sfc parser

Vue SFC Parser

Analisador de componente de arquivo único vue.js para análise estática.

Uso

O analisador Vue SFC é semelhante ao parseComponent do Vue-Template-Compiler, mas possui alguns ajudantes úteis para análise 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 ) ) 

Referências

parseComponent(code: string): SFCDescriptor

Isso é quase o mesmo que parseComponent do vue-template-compiler . SFCDescriptor parece seguir seguidores:

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

O SFCBlock também é semelhante ao vue-template-compiler um, mas com métodos de auxiliar adicionais.

Auxiliares adicionais do SFCBlock

• calcGlobalOffset(offset: number): number

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

  Esses métodos são para calcular a posição global a partir da posição do bloco. Por exemplo:

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

  No SFC acima, se você fornecer 5 ao template.calcGlobalOffset , que indica a posição do mendigo do bloco de modelos, ele retornará 38 , que é a posição do mendicativo do arquivo.

createDiffWatcher(): SFCDiffWatcher

Crie um objeto Watcher que detectará o Diff de cada bloco SFC. SFCDiffWatcher possui os seguintes métodos:

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

Você pode adicionar / remover o arquivo SFC ao vigia usando métodos add / remove . Em seguida, você obtém o diff de cada bloco SFC usando o método diff . Ele retorna um objeto com alguns métodos que você pode registrar retornos de chamada que serão chamados quando os blocos correspondentes forem alterados.

Exemplo:

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

Licença

Mit