components helper

️ Perpustakaan ini tidak lagi dipertahankan.

Dengan dukungan volar badai web, Anda mungkin tidak lagi membutuhkan perpustakaan ini.

Lebih disarankan agar Anda menggunakan prompt kode Volar dengan meningkatkan jenis deklarasi.

Jika Anda masih membutuhkan perpustakaan ini, Anda dapat terus menggunakannya, tetapi perpustakaan ini tidak akan lagi memiliki pembaruan fitur baru.

---

komponen-helper

Berdasarkan dokumen untuk menyediakan file prompt kode untuk perpustakaan komponen vue

Dokumen referensi memformat file uji referensi

Changelog

Instalasi

yarn add components-helper -D
# or
npm i components-helper --save-dev

Penggunaan

 const { main } = require ( 'components-helper' )

main ( {
  // Options
} )

contoh

Kemudian di package.json

{
  "scripts": {
+    "build:helper": "node helper/file.js"
  },
+  "vetur": {
+    "tags": "config outDir/tags.json",
+    "attributes": "config outDir/attributes.json"
+  },
+  "web-types": "config outDir/web-types.json"
}

Opsi

Toc

• entri (diperlukan)
• fastglobconfig
• Outdir (wajib)
• nama (wajib)
• Versi (diperlukan)
• ruang angkasa
• pemisah
• RecomponentName
• redocurl
• Putar ulang
• Reveturdescription
• REWEBTYPESSOURCE
• REWEBTYPESTYPE
• tag
• atribut
• Webtypes
• alat peraga
• Propsname
• Propsdescription
• Propstype
• Topsopsi
• PropsDefault
• Acara
• eventsname
• eventsdescription
• slot
• Slotsname
• Slotsdescription
• Slotstype
• Slotssubtags
• arahan
• arahanName
• DirectiveDescription
• Directivestype
• titleregexp
• tableregexp
• filenameregexp

pintu masuk

• Diperlukan: true
• Jenis: string | string[]

Tentukan direktori entri. Referensi: Glob cepat

Misalnya:

• docs/*.md - cocok dengan semua file di dokumen
• docs/(a|b).md - cocok dengan file a.md dan b.md
• docs/!(a|b).md - cocok dengan file kecuali untuk a.md dan b.md

fastglobconfig

• Jenis: object

Konfigurasi Cepat-Glob

Outdir

• Diperlukan: true
• Ketik: string

Tentukan direktori output. Misalnya, `lib``

nama

• Diperlukan: true
• Ketik: string

Nama Perpustakaan Komponen.

versi

• Diperlukan: true
• Ketik: string

Versi Perpustakaan Komponen.

ruang angkasa

• Jenis: number | string

Menambahkan indentasi, ruang putih, dan garis istirahat garis ke teks JSON bernilai balik agar lebih mudah dibaca

pemisah

• Ketik: string
• Bawaan: /

Pemisah untuk Topsopsi, Slotssubtags, Ketik ...

RecomponentName

• Jenis: (title: string, fileName: string, path: string) => string
• Defult: hyphenate(title || fileName)

Menulis ulang nama komponen

misalnya (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()

redocurl

• Jenis: (fileName: string, header?: string, path: string) => string | undefind

Menulis ulang URL DOC dari komponen

Putar ulang

• Jenis: (value: string, key: string, row: string[], title: string) => string | undefined

arg

• Nilai: Nilai saat ini
• Kunci: Nilai kunci kolom saat ini
• Baris: Semua nilai baris saat ini
• Judul: Judul Tabel Saat Ini

Menulis ulang atribut komponen

Reveturdescription

• Jenis: (description?: string, defaultValue?: string, docUrl?: string) => string
• Default: sama seperti ${description}, default: ${defaultValue}.nn[Docs](${docUrl})

Menulis ulang deskripsi Vetur

REWEBTYPESSOURCE

• Jenis: (title: string, fileName: string, path: string) => Source

Menulis ulang sumber jenis web. (Nama Ekspor dari Perpustakaan Komponen)

REWEBTYPESTYPE

• Jenis: (type: string) => undefined | string | BaseContribution

Hanya beberapa jenis umum yang diproses secara internal, dan sisanya diekspor dari pustaka komponen secara default. Jika dokumen Anda juga merujuk jenis di perpustakaan pihak ketiga, Anda dapat memilih untuk mengganti perilaku yang relevan melalui fungsi ini

tag

• Ketik: string
• Default: tags.json

Nama untuk tag Vetur

atribut

• Ketik: string
• Default: attributes.json

Nama untuk atribut Vetur

Webtypes

• Ketik: string
• Default: web-types.json

Nama untuk jenis web dari badai web

alat peraga

• Jenis: string ( Ini adalah string biasa dan mengabaikan kasing. )
• Default: props

Judul tabel alat peraga. String lain di header akan diidentifikasi sebagai sub-komponen

Propsname

• Ketik: string
• Default: Name

Nama header Name di tabel alat peraga

Propsdescription

• Ketik: string
• Default: Description

Nama header Description di tabel alat peraga

Propstype

• Ketik: string
• Default: Type

Nama header Type di tabel props

Topsopsi

• Ketik: string
• Default: Options

Nama header Options di tabel Props

PropsDefault

• Ketik: string
• Default: Default

Nama header Default di tabel props

Acara

• Jenis: string ( Ini adalah string biasa dan mengabaikan kasing. )
• Default: events

Judul tabel acara. String lain di header akan diidentifikasi sebagai sub-komponen

eventsname

• Ketik: string
• Default: Name

Nama header Name di tabel acara

eventsdescription

• Ketik: string
• Default: Description

Nama header Description di tabel acara

slot

• Jenis: string ( Ini adalah string biasa dan mengabaikan kasing. )
• Default: slots

Judul tabel slot. String lain di header akan diidentifikasi sebagai sub-komponen

Slotsname

• Ketik: string
• Default: Name

Nama header Name di tabel slot

Slotsdescription

• Ketik: string
• Default: Description

Nama header Description di tabel slot

Slotstype

• Ketik: string
• Default: Type

Nama header Type di tabel slot

Slotssubtags

• Ketik: string
• Default: Subtags

Nama header Subtags di tabel slot

arahan

• Jenis: string ( Ini adalah string biasa dan mengabaikan kasing. )
• Default: directives

Judul tabel arahan. String lain di header akan diidentifikasi sebagai sub-komponen

arahanName

• Ketik: string
• Default: Name

Nama header Name di tabel arahan

DirectiveDescription

• Ketik: string
• Default: Description

Nama header Description di tabel arahan

Directivestype

• Ketik: string
• Default: Type

Nama header Type di tabel arahan

titleregexp

• Jenis: RegExp | string ( ini adalah string biasa. )
• Default: /#+s+(.*)n+([^(#|n)]*)/g €)/g

Cocokkan informasi judul dan deskripsi dari dokumen

tableregexp

• Jenis: RegExp | string ( ini adalah string biasa. )
• Default: /#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g n ?

Cocokkan judul dan tajuk tabel dan tabel berisi informasi dari dokumen

filenameregexp

• Jenis: RegExp | string ( ini adalah string biasa. )
• Default: //((w|-)+).w+$/

cocok dengan nama file dari jalur

Kemajuan

tentang titleregexp

cocok dengan informasi format pertama di dokumen

/#+ s+( .* ) n+( [^(#|n)]* )/

# title

description

Dan

## title

cocok dengan format lain, misalnya:

/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g

# title

> description

tentang tableregexp

cocok dengan informasi format di dokumen

/#+ s+( .* ) n+( |?.+|.+ ) n |? S*:?-+:? S*|.+( (n|?.+|.+)+ )/g

### title

| header |

| ------ |

| column |

| column |

Dan

sub-component title ###

| header |

| : ----- |

| column |

| column |

Secara default mencocokkan semua tabel, mengoptimalkannya melalui tableregexp, misalnya:

/#+ S+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n+( |?.+|.+ ) n |? S* (n|?.+|.+)+ ?

### Props / Events / Slots / Directives

| header |

| ------ |

| column |

| column |

Dan

### sub-component Props

| header |

| ------ |

| column |

| column |

lainnya

Ketika dokumen ini tidak termasuk judul utama atau Props Events Slots dan Directives , komponen ini tidak dibuat.

Lisensi

Mit