sfc composer

SFC-Composer

? ‍? Ajudantes pré-compiladores para componentes de arquivo único

Atualmente suporta: .vue, .svelte, .astro

? Sustta de playground

Uso

Pacote de instalação:

pnpm install sfc-composer

 import { MagicSFC as MagicVueSFC } from 'sfc-composer/vue'
import { MagicSFC as MagicSvelteSFC } from 'sfc-composer/svelte'
import { MagicSFC as MagicAstroSFC } from 'sfc-composer/astro' 

Internalas

Classe MAGICSFC

MagicSFC<T> é a interface raiz fornecida a ser estendida por classes infantis específicas da estrutura.

• scripts: MagicBlock<T>[]

  Referindo -se a <script> ou qualquer contexto JavaScript/TypeScript dos SFCs.

• templates: MagicBlock<T>[]

  Referindo -se a <template> partes dos SFCs.

• styles: MagicBlock<T>[]

  Referindo -se a <style> partes dos SFCs.

• customs: MagicBlock<T>[]

  Blocos personalizados das estruturas analisadores que suportam esse recurso.

• getSourcemap(options?: SourceMapOptions): SourceMap

  Gera um versão de SourceMap da versão 3 como MagicString .

• getTransformResult(): TransformResult

  Compatível com o resultado do gancho transform() .

• parse(): Promise<MagicSFC>

  Usa o analisador para atualizar os blocos MagicSFC .

Deve ser implementado por classes infantis.

Saiba mais sobre todos os usos olhando para os testes!

Como funciona o MAGICSFC

Ao usar a função parse , MagicSFC dividirá o componente fornecido usando a estrutura nativa da estrutura.

O resultado da análise será dividido em um formato padrão de reconhecimento templates , scripts e blocos styles .

Cada um desses MagicBlock preservará a forma original do analisador, mas também exporá todas as funções relevantes do MagicString.

Cada uma dessas funções, quando chamada, aplicará suas alterações no bloco local.

Você também obtém acesso a _loc e _source em todos os MagicBlock , que são cópias padrão do posicionamento e conteúdo do bloco.

Ao ligar para result , você obterá o code como uma string e um objeto SourceMap apropriado.

Veja a implementação.

Cria funções dofc

Frameworks Exporta uma função createSfc que facilita a geração de SFCs programaticamente.

Todos eles suportam os mesmos agntos de entrada:

 import { createSFC as createVueSFC } from 'sfc-composer/vue'
import { createSFC as createSvelteSFC } from 'sfc-composer/svelte'
import { createSFC as createAstroSFC } from 'sfc-composer/astro'

const writeableSFC = {
  templates : [
    {
      content : '<div>Hello World!</div>'
    }
  ] ,
  scripts : [
    {
      content : 'console.log(`Hello World!`)'
    }
  ] ,
  styles : [
    {
      content : 'div { color: red; }'
    }
  ]
}

// Will output a valid Svelte SFC
createSvelteSFC ( writeableSFC )

// Will output a valid Astro SFC
createAstroSFC ( writeableSFC )

// Will output a valid Vue SFC
createVueSFC ( {
  ... writeableSFC ,
  // Vue also natively supports `customs` block in its parser.
  customs : [
    {
      type : 'i18n' ,
      content : '{ "fr": "Bonjour!", "en": "Hello!" }' ,
    }
  ]
} ) 

MagicVuesfc

Código de exemplo

 import { MagicSFC as MagicVueSFC } from 'sfc-composer/vue'
import { parse } from 'vue/compiler-sfc'

async function transformVueSFC ( ) {
  const sfc = new MagicVueSFC (
    '<template><div>Hello World!</div></template>'
    + '<script setup>let test: string</script>'
    + '<style scoped>div { color: red; }</style>' ,
    {
      parser : parse
    }
  )

  // Process the SFC code through the parser
  await sfc . parse ( )

  // Append to the <script> tag
  sfc . scripts [ 0 ] . append ( ' = `Hello World`' )

  return sfc . result ( )

  // {
  //    code: '<template><div>Hello World!</div></template>nn<script setup>let test: string = `Hello World`</script>nn<style scoped>div { color: red; }</style>'
  //    map: SourceMap
  // }
}

Saiba mais olhando para os testes.

createvuesfc

Código de exemplo

 import { createSFC as createVueSFC } from 'sfc-composer/vue'

const MagicVueSFC = createVueSFC ( {
  templates : [
    {
      content : '<div>{{ msg }}</div>' ,
    }
  ] ,
  script : [
    {
      content : 'export default { data() { return { msg: "Hello, world!" } } }'
    } ,
    {
      content : 'const setupMsg = "Hello from setup!"' ,
    }
  ] ,
  styles : [
    {
      lang : 'scss' ,
      scoped : true ,
      content : '.text { color: red; }' ,
    } ,
  ] ,
} ) 

? Iquudirá a saída

 <script>
export default { data() { return { msg: "Hello, world!" } }
</script>

<script setup>
const setupMsg = "Hello from setup!"
</script>

<template>
<div>{{ msg }}</div>
</template>

<style scoped lang="scss">
.text { color: red; }
</style>

Saiba mais olhando para os testes!

MAGICSVELTESFC

Código de exemplo

 import { MagicSFC as MagicSvelteSFC } from 'sfc-composer/svelte'
import { preprocess } from 'svelte/compiler'

async function transformSvelteSFC ( ) {
  const sfc = new MagicSvelteSFC (
    '<script>let test: string</script>nn'
    + '<div>Hello World!</div>nn'
    + '<style>div { color: red; }</style>' ,
    {
      parser : preprocess
    }
  )

  // Process the SFC code through the parser
  await sfc . parse ( )

  // Append to the <script> tag
  sfc . scripts [ 0 ] . append ( ' = `Hello World`' )

  return sfc . result ( )

  // {
  //    code: '<script>let test: string = `Hello World`</script>nn<div>Hello World!</div>nn<style>div { color: red; }</style>'
  //    map: SourceMap
  // }
}

Saiba mais olhando para os testes!

CreateSveltesfc

Código de exemplo

 import { createSFC as createSvelteSFC } from 'sfc-composer/svelte'

const MagicVueSFC = createSvelteSFC ( {
  templates : [
    {
      content : '<div>{msg}</div>' ,
    }
  ] ,
  script : [
    {
      content : 'let test = `Hello World!`;'
    }
  ] ,
  styles : [
    {
      content : '.text { color: red; }' ,
    } ,
  ] ,
} ) 

? Iquudirá a saída

 <script>
let test = `Hello World!`;
</script>

<script setup>
const setupMsg = "Hello from setup!"
</script>

<div>{msg}</div>

<style>
.text { color: red; }
</style>

Saiba mais olhando para os testes!

MagicaStosfc

Código de exemplo

 import { MagicSFC as MagicAstroSFC } from 'sfc-composer/astro'
import { preprocess } from '@astrojs/compiler'

async function transformAstroSFC ( ) {
  const sfc = new MagicAstroSFC (
    '---nlet test: stringn---nn'
    + '<div>Hello World!</div>nn'
    + '<style>div { color: red; }</style>' ,
    {
      parser : preprocess
    }
  )

  // Process the SFC code through the parser
  await sfc . parse ( )

  // Append to the <script> tag
  sfc . scripts [ 0 ] . append ( 'test = `Hello World`' )

  return sfc . result ( )

  // {
  //    code: '---nlet test: stringntest = `Hello World`n---nn<div>Hello World!</div>nn<style>div { color: red; }</style>'
  //    map: SourceMap
  // }
}

Saiba mais olhando para os testes!

createastrosfc

Código de exemplo

 import { createSFC as createAstroSFC } from 'sfc-composer/astro'

const MagicVueSFC = createAstroSFC ( {
  templates : [
    {
      content : '<div>{msg}</div>' ,
    }
  ] ,
  script : [
    {
      content : 'let test = `Hello World!`;' ,
      attrs : {
        frontmatter : true
      }
    } ,
    {
      content : 'let secondTest = `Hello World`;'
    }
  ] ,
  styles : [
    {
      content : '.text { color: red; }' ,
    } ,
  ] ,
} ) 

? Iquudirá a saída

 ---
let test = `Hello World!`;
---

<script>
let secondTest = `Hello World`;
</script>

<div>{msg}</div>

<style>
.text { color: red; }
</style>

Saiba mais olhando para os testes!

Desenvolvimento

• Clone este repositório
• Instale a versão LTS mais recente do Node.js
• Ativar Corepack usando corepack enable
• Instale dependências usando pnpm install
• Execute testes interativos usando pnpm dev

Licença

Feito com

Publicado sob licença do MIT.