vue sfc parser

Vue SFC Parser

Vue.js Parser komponen file tunggal untuk analisis statis.

Penggunaan

Vue SFC Parser mirip dengan parseComponent Vue-Template-Compiler tetapi memiliki beberapa pembantu yang berguna untuk analisis kode.

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

Referensi

parseComponent(code: string): SFCDescriptor

Ini hampir sama dengan parseComponent vue-template-compiler . SFCDescriptor sepertinya mengikuti:

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

SFCBlock juga mirip dengan vue-template-compiler , tetapi memiliki metode pembantu tambahan.

Pembantu tambahan SFCBlock

• calcGlobalOffset(offset: number): number

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

  Metode ini adalah untuk menghitung posisi global dari posisi blok. Misalnya:

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

  Pada SFC di atas 38 jika Anda menyediakan 5 untuk template.calcGlobalOffset

createDiffWatcher(): SFCDiffWatcher

Buat objek Watcher yang akan mendeteksi setiap diff blok SFC. SFCDiffWatcher memiliki metode berikut:

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

Anda dapat menambahkan / menghapus file SFC ke Watcher dengan menggunakan Metode add / remove . Kemudian Anda memperoleh setiap diff blok SFC dengan menggunakan metode diff . Ini mengembalikan objek yang memiliki beberapa metode yang dapat Anda mendaftarkan panggilan balik yang akan dipanggil ketika blok yang sesuai diubah.

Contoh:

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

Lisensi

Mit