vue sfc parser

Vue SFCパーサー

Vue.js静的分析のための単一ファイルコンポーネントパーサー。

使用法

Vue SFCパーサーは、Vue-Template-CompilerのparseComponentに似ていますが、コード分析に役立つヘルパーがあります。

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

参照

parseComponent(code: string): SFCDescriptor

これはvue-template-compilerのparseComponentとほぼ同じです。 SFCDescriptorは次のように見えます：

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

SFCBlock vue-template-compilerのものにも似ていますが、追加のヘルパーメソッドがあります。

SFCBlockの追加ヘルパー

• calcGlobalOffset(offset: number): number

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

  これらの方法は、ブロック位置からグローバルポジションを計算するためのものです。例えば：

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

  上記のSFCでは、テンプレートブロックの開始からの位置を示す5からtemplate.calcGlobalOffsetへの5を提供する場合、ファイルのベージングからの位置である38返します。

createDiffWatcher(): SFCDiffWatcher

各SFCブロックのdiffを検出するウォッチャーオブジェクトを作成します。 SFCDiffWatcherは次の方法があります。

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

add / removeメソッドを使用して、SFCファイルをWatcherに追加 /削除できます。次に、 diffメソッドを使用して各SFCブロックのdiffを取得します。対応するブロックが変更されたときに呼び出されるコールバックを登録できるいくつかのメソッドを持つオブジェクトを返します。

例：

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

ライセンス

mit