vue sfc parser

Vue SFC Parser

Analyseur de composant de fichier Vue.js pour l'analyse statique.

Usage

Vue SFC Parser est similaire à parseComponent de Vue-Template-Compiler, mais a des aides utiles pour l'analyse du code.

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

Références

parseComponent(code: string): SFCDescriptor

Ceci est presque le même que parseComponent de vue-template-compiler . SFCDescriptor ressemble à la suite:

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

Le SFCBlock est similaire à vue-template-compiler celui, mais ayant des méthodes d'assistance supplémentaires.

Aiders supplémentaires de SFCBlock

• calcGlobalOffset(offset: number): number

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

  Ces méthodes sont destinées à la position globale calcurante à partir de la position du bloc. Par exemple:

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

  Sur le SFC ci-dessus, si vous fournissez 5 à template.calcGlobalOffset qui indique la position du bloc de modèle, il renverra 38 qui est la position de la mendicité du fichier.

createDiffWatcher(): SFCDiffWatcher

Créez un objet Watcher qui détectera le diff de chaque bloc SFC. SFCDiffWatcher a des méthodes suivantes:

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

Vous pouvez ajouter / supprimer le fichier SFC à l'observateur en utilisant des méthodes add / remove . Ensuite, vous obtenez le diff de chaque bloc SFC en utilisant la méthode diff . Il renvoie un objet ayant certaines méthodes que vous pouvez enregistrer des rappels qui seront appelés lorsque les blocs correspondants sont modifiés.

Exemple:

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

Licence

Mit