vue sfc parser

VUE SFC PARSER

VUE.JS ОДИН -ФАЙЛОНЕЧЕСКИЙ СПАНЦЕР для статического анализа.

Использование

Vue SFC Parser аналогичен parseComponent Vue-Template-компилятора, но имеет несколько полезных помощников для анализа кода.

 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

Это почти то же самое, что и parseComponent vue-template-compiler . 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 , который указывает позицию из начала блока шаблона, он вернет 38 , что является положением из начала файла.

createDiffWatcher(): SFCDiffWatcher

Создайте объект наблюдателя, который обнаружит различие каждого блока SFC. SFCDiffWatcher имеет следующие методы:

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

Вы можете добавить / удалить файл SFC в наблюдатель, используя методы add / remove . Затем вы получаете 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 )
        } )
      } )
  } ) 

Лицензия

Грань