vue sfc parser

VUE SFC Parser

Vue.js Einzeldateikomponenten Parser für die statische Analyse.

Verwendung

VUE SFC Parser ähnelt dem parseComponent von Vue-Template-Compiler, verfügt jedoch über einige nützliche Helfer für die Codeanalyse.

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

Referenzen

parseComponent(code: string): SFCDescriptor

Dies entspricht fast der parseComponent von vue-template-compiler . SFCDescriptor sieht aus wie folgt:

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

Der SFCBlock ähnelt auch dem vue-template-compiler , hat jedoch zusätzliche Helfermethoden.

Zusätzliche Helfer von SFCBlock

• calcGlobalOffset(offset: number): number

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

  Diese Methoden dienen zur Berechnung der globalen Position aus der Blockposition. Zum Beispiel:

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

  38 Sie auf der obigen SFC 5 für template.calcGlobalOffset angeben.

createDiffWatcher(): SFCDiffWatcher

Erstellen Sie ein Beobachterobjekt, das den Diff von jedem SFC -Block erfasst. SFCDiffWatcher verfügt über folgende Methoden:

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

add von Methoden können Sie SFC -Datei zum Beobachter hinzufügen / remove . Anschließend erhalten Sie den Diff von jedem SFC -Block mithilfe diff -Methode. Es gibt ein Objekt mit einigen Methoden zurück, die Sie zurückrufen können, die aufgerufen werden, wenn die entsprechenden Blöcke geändert werden.

Beispiel:

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

Lizenz

MIT