sfc composer

SFCコンポーザー

？‍？シングルファイルコンポーネント用のプレコンパイラヘルパー

現在：.vue、.svelte、.astro

？§遊び場

使用法

パッケージをインストールする：

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' 

内部

MAGICSFCクラス

MagicSFC<T>は、フレームワーク固有の子クラスによって拡張されるように提供されるルートインターフェイスです。

• scripts: MagicBlock<T>[]

  <script>またはSFCSのJavaScript/TypeScriptコンテキストを参照します。

• templates: MagicBlock<T>[]

  SFCSの<template>部分を参照してください。

• styles: MagicBlock<T>[]

  SFCSの<style>部分を参照してください。

• customs: MagicBlock<T>[]

  その機能をサポートするフレームワークからのカスタムブロック。

• getSourcemap(options?: SourceMapOptions): SourceMap

  MagicStringのようなバージョン3 SourceMapを生成します。

• getTransformResult(): TransformResult

  Vite transform() Hookの結果と互換性があります。

• parse(): Promise<MagicSFC>

  パーサーを使用して、 MagicSFCブロックを更新します。

子供のクラスで実装する必要があります。

テストを見て、すべての使用法の詳細をご覧ください！

MagicsFCの仕組み

parse関数を使用する場合、 MagicSFCフレームワークネイティブツールを使用して提供されたコンポーネントを分割します。

解析結果は、 templates 、 scripts 、 stylesブロックを認識する標準形式に分割されます。

これらのMagicBlockそれぞれ、パーサーから元の形状を保存しますが、関連するすべての魔法のストリング機能も公開します。

これらの各関数は、呼び出された場合、両方ともローカルブロックに変更を適用します。

また、ブロックの位置付けとコンテンツの標準コピーであるすべてのMagicBlockで_locと_sourceにアクセスできます。

resultを呼び出すと、 code文字列と適切なSourceMapオブジェクトとして取得します。

実装を見てください。

CreatESFC関数

Frameworksは、SFCSの生成をプログラム的に簡単にするcreateSfc関数をエクスポートします。

それらはすべて同じ入力agumentsをサポートしています：

 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

例コード

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

テストをご覧ください。

Createvuesfc

例コード

 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; }' ,
    } ,
  ] ,
} ) 

？§は出力されます

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

テストを見て詳細をご覧ください！

Magicsveltesfc

例コード

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

テストを見て詳細をご覧ください！

CreateSveltesfc

例コード

 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; }' ,
    } ,
  ] ,
} ) 

？§は出力されます

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

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

<div>{msg}</div>

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

テストを見て詳細をご覧ください！

MagicaStrosfc

例コード

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

テストを見て詳細をご覧ください！

createastrosfc

例コード

 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; }' ,
    } ,
  ] ,
} ) 

？§は出力されます

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

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

<div>{msg}</div>

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

テストを見て詳細をご覧ください！

発達

• このリポジトリをクローンします
• node.jsの最新のLTSバージョンをインストールします
• corepack enableを使用してcorepackを有効にします
• pnpm installを使用して依存関係をインストールします
• pnpm devを使用してインタラクティブテストを実行します

ライセンス

で作られています

MITライセンスに基づいて公開されています。