components helper
v2.2.0
Avec la prise en charge de la volée, vous n'aurez peut-être plus besoin de cette bibliothèque.
Il est plus recommandé d'utiliser l'invite de code de Volar en améliorant la déclaration de type.
Si vous avez toujours besoin de cette bibliothèque, vous pouvez continuer à l'utiliser, mais cette bibliothèque n'aura plus de nouvelles mises à jour de fonctionnalités.
Basé sur les documents pour fournir des fichiers d'invite de code pour la bibliothèque des composants VUE
Documents de référence Format Fichiers de test de référence
Changelog
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )exemple
puis dans 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[]Spécifiez le répertoire d'entrée. Report: Fast-Glob
Par exemple:
docs/*.md - correspond à tous les fichiers dans les documentsdocs/(a|b).md - correspond aux fichiers a.md et b.mddocs/!(a|b).md - correspond aux fichiers à l'exception de a.md et b.mdobjectLa configuration de Fast-Glob
truestringSpécifiez le répertoire de sortie. Par exemple, `lib` '
truestringNom de la bibliothèque des composants.
truestringLa version de la bibliothèque de composants.
number | stringAjoute l'indentation, l'espace blanc et les caractères de rupture de ligne au texte JSON de valeur de retour pour le rendre plus facile à lire
string/Le séparateur pour PropSoptions, Slotssubtags, Type ...
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)Réécriture du nom du composant
par exemple (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefindRéécriture de l'URL DOC du composant
(value: string, key: string, row: string[], title: string) => string | undefined Réécriture de l'attribut du composant
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Réécriture de la description de Vetur
(title: string, fileName: string, path: string) => SourceRéécriture de la source des types Web. (le nom de l'exportation de la bibliothèque des composants)
(type: string) => undefined | string | BaseContributionSeuls certains types courants sont traités en interne et les autres sont exportés de la bibliothèque de composants par défaut. Si votre document fait également référence aux types dans des bibliothèques tierces, vous pouvez choisir de remplacer le comportement pertinent via cette fonction
stringtags.jsonNom des étiquettes de la Vérure
stringattributes.jsonNom des attributs de la Vetur
stringweb-types.jsonNom des types Web du WebStorm
string ( il s'agit d'une chaîne régulière et ignore le cas. )propsLe titre de la table d'accessoires. Une autre chaîne de l'en-tête sera identifiée comme sous-composant
stringName Le nom d'en-tête du Name dans la table des accessoires
stringDescription Le nom d'en-tête de la Description dans la table des accessoires
stringType Le nom d'en-tête du Type dans la table des accessoires
stringOptions Le nom d'en-tête des Options dans la table des accessoires
stringDefault Le nom d'en-tête de la Default dans la table des accessoires
string ( il s'agit d'une chaîne régulière et ignore le cas. )eventsLe titre de la table d'événements. Une autre chaîne de l'en-tête sera identifiée comme sous-composant
stringName Le nom d'en-tête du Name dans le tableau des événements
stringDescription Le nom d'en-tête de la Description dans le tableau des événements
string ( il s'agit d'une chaîne régulière et ignore le cas. )slotsLe titre de la table des machines à sous. Une autre chaîne de l'en-tête sera identifiée comme sous-composant
stringName Le nom d'en-tête du Name dans la table des machines à sous
stringDescription Le nom d'en-tête de la Description dans la table des machines à sous
stringType Le nom d'en-tête du Type dans la table des machines à sous
stringSubtags Le nom d'en-tête des Subtags dans la table des machines à sous
string ( il s'agit d'une chaîne régulière et ignore le cas. )directivesLe titre de la table des directives. Une autre chaîne de l'en-tête sera identifiée comme sous-composant
stringName Le nom d'en-tête du Name dans le tableau des directives
stringDescription Le nom d'en-tête de la Description dans le tableau des directives
stringType Le nom d'en-tête du Type dans le tableau des directives
RegExp | string ( c'est une chaîne régulière. )/#+s+(.*)n+([^(#|n)]*)/g +s+(.*)n+ (^^(#|n)correspond aux informations sur le titre et la description des documents
RegExp | string ( c'est une chaîne régulière. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g :? -+:?s*|.correspond à l'en-tête du titre et de la table et la table contient des informations à partir des documents
RegExp | string ( c'est une chaîne régulière. )//((w|-)+).w+$/ /( w|-)+).w+$/correspond au nom du fichier depuis le chemin
correspond aux informations du premier format dans les documents
/ # + s + ( .* ) n + ( [^(#|n)]* ) /
titledescriptionet
titlecorrespond à d'autres formats, par exemple:
/ # + s + ( .* ) n +> s * ( [^(#|n)]* ) / g
titledescriptioncorrespond aux informations du format dans les documents
/ # + s + ( .* ) n + ( |?.+|.+ ) n |? s * :? - + :? s * |. + ( (n|?.+|.+)+ ) / g
title| header || column || column |et
sub-component title ###| header || column || column |Par défaut correspond à toutes les tables, l'optimisez via Tableregexp, par exemple:
/ # + s + ( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n + ( |?.+|.+ ) n |? S *:? - + :? S * |. + ( (n|?.+|.+)+ ) /)
Props / Events / Slots / Directives| header || column || column |et
sub-component Props| header || column || column | Lorsque ce document n'inclut pas les Slots et Directives Events de titre ou Props principaux, ce composant n'est pas créé.
Mit
