components helper
v2.2.0
Mit der Webstorm -Unterstützung von Volar benötigen Sie diese Bibliothek möglicherweise nicht mehr.
Es wird mehr empfohlen, dass Sie die Code -Eingabeaufforderung von Volar durch Verbesserung der Typdeklaration verwenden.
Wenn Sie diese Bibliothek noch benötigen, können Sie sie weiterhin verwenden, diese Bibliothek verfügt jedoch nicht mehr über neue Funktionen.
Basierend auf den Dokumenten, um Code -Eingabeaufforderung Dateien für die Vue -Komponenten -Bibliothek bereitzustellen
Referenzdokumente Format Referenz -Testdateien
Changelog
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )Beispiel
dann in 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"
}truestring | string[]Geben Sie das Eintragsverzeichnis an. Siehe: Fast-Glob
Zum Beispiel:
docs/*.md - stimmt mit allen Dateien in den Dokumenten übereindocs/(a|b).md - übereinstimmt Dateien a.md und b.mddocs/!(a|b).md - übereinstimmt Dateien mit Ausnahme von a.md und b.mdobjectDie Konfiguration von Fast-Glob
truestringGeben Sie das Ausgabeverzeichnis an. Zum Beispiel `lib``
truestringName der Komponentenbibliothek.
truestringDie Version der Komponentenbibliothek.
number | stringFügt den JSON-Text-Texte des Rückkehrwerts Eindrückung, Weiß- und Zeilenumbrüche hinzu, um das Lesen zu erleichtern
string/Das Trennzeichen für Requisitionen, SlotsSubtags, Typ ...
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)Schreiben Sie den Namen der Komponente neu
Zum Beispiel (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefindSchreiben Sie die DOC -URL der Komponente neu
(value: string, key: string, row: string[], title: string) => string | undefined Schreiben Sie das Attribut der Komponente neu
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Schreiben Sie die Beschreibung des Vetur neu
(title: string, fileName: string, path: string) => SourceSchreiben Sie die Quelle von Web-Typen neu. (Der Name des Exports aus der Komponentenbibliothek)
(type: string) => undefined | string | BaseContributionNur einige gemeinsame Typen werden intern verarbeitet und der Rest werden standardmäßig aus der Komponentenbibliothek exportiert. Wenn Ihr Dokument auch in Bibliotheken von Drittanbietern verweist, können Sie das relevante Verhalten über diese Funktion überschreiben
stringtags.jsonName für Tags des Tierarztes
stringattributes.jsonName für Attribute des Tierarztes
stringweb-types.jsonName für Webstormes für Webstorm
string ( dies ist eine reguläre Zeichenfolge und ignoriert den Fall. )propsDer Titel der Props -Tabelle. Eine andere Zeichenfolge im Kopf wird als Subkomponent identifiziert
stringName Der Header -Name des Name in der Props -Tabelle
stringDescription Der Header -Name der Description in der Props -Tabelle
stringType Der Headername des Type in der Props -Tabelle
stringOptions Der Header -Name der Options in der Props -Tabelle
stringDefault Der Header -Name der Default in der Props -Tabelle
string ( dies ist eine reguläre Zeichenfolge und ignoriert den Fall. )eventsDer Titel der Ereignisstabelle. Eine andere Zeichenfolge im Kopf wird als Subkomponent identifiziert
stringName Der Header -Name des Name in der Ereignisentabelle
stringDescription Der Header -Name der Description in der Ereignisentabelle
string ( dies ist eine reguläre Zeichenfolge und ignoriert den Fall. )slotsDer Titel der Slots -Tabelle. Eine andere Zeichenfolge im Kopf wird als Subkomponent identifiziert
stringName Der Header -Name des Name in der Slots -Tabelle
stringDescription Der Header -Name der Description in der Slots -Tabelle
stringType Der Headername des Type in der Slots -Tabelle
stringSubtags Der Headername der Subtags in der Slots -Tabelle
string ( dies ist eine reguläre Zeichenfolge und ignoriert den Fall. )directivesDer Titel der Richtlinie Tabelle. Eine andere Zeichenfolge im Kopf wird als Subkomponent identifiziert
stringName Der Header -Name des Name in der Richtlinie Tabelle
stringDescription Der Header -Name der Description in der Richtlinie Tabelle
stringType Der Headername des Type in der Richtlinie -Tabelle
RegExp | string ( dies ist eine reguläre Zeichenfolge. )/#+s+(.*)n+([^(#|n)]*)/g ( -^(#|n) weibliches*)/gentspricht den Titel- und Beschreibungsinformationen von DOCs
RegExp | string ( dies ist eine reguläre Zeichenfolge. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g S+(.*)n+(| .+|.+)N|?S*:?-+-+entspricht dem Titel- und Tabellenheader und die Tabelle enthält Informationen von DOCs
RegExp | string ( dies ist eine reguläre Zeichenfolge. )//((w|-)+).w+$/Übereinstimmt mit dem Dateinamen vom Pfad
entspricht den ersten Formatinformationen in den Dokumenten
/#+ s+( .* ) n+( [^(#|n)]* )//
titledescriptionUnd
titleentspricht zum Beispiel mit anderen Formaten:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptionentspricht den Formatinformationen in den Dokumenten
/#+ s+( .* ) n+( |?.+|.+ ) n |? s*:?-+:? s*|.+ (n|?.+|.+)+ )/g
title| header || column || column |Und
sub-component title| header || column || column |Standardmäßig entspricht standardmäßig alle Tabellen und optimieren Sie es über TableReGexp, zum Beispiel:
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives |?.+|.+ (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |Und
sub-component Props| header || column || column | Wenn dieses Dokument nicht Slots primären Titel- oder Props Events und Directives enthält, wird diese Komponente nicht erstellt.
MIT
