components helper
v2.2.0
Con el soporte de tormenta web de Volar, es posible que ya no necesite esta biblioteca.
Se recomienda más que use la solicitud de código de Volar mejorando la declaración de tipo.
Si aún necesita esta biblioteca, puede continuar usándola, pero esta biblioteca ya no tendrá nuevas actualizaciones de características.
Basado en los documentos para proporcionar archivos de solicitud de código para la biblioteca de componentes VUE
Documentos de referencia Formato de archivos de prueba de referencia
Colegio de cambios
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )ejemplo
luego en paquete.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[]Especifique el directorio de entrada. Consulte: Fast-Glob
Por ejemplo:
docs/*.md : coincide con todos los archivos en los documentosdocs/(a|b).md : coincide con los archivos a.md y b.mddocs/!(a|b).md : coincide con los archivos excepto a a.md y b.mdobjectLa configuración de Fast-GLOB
truestringEspecifique el directorio de salida. Por ejemplo, `lib``
truestringNombre de la biblioteca de componentes.
truestringLa versión de la biblioteca de componentes.
number | stringAgrega los caracteres de sangría, espacio en blanco y ruptura de línea al texto JSON de valor de retorno para que sea más fácil de leer
string/El separador para PropsOptions, SlotsSubtags, Tipo ...
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)Reescribir el nombre del componente
por ejemplo (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefindReescribir la URL DOC del componente
(value: string, key: string, row: string[], title: string) => string | undefined Reescribir el atributo del componente
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Reescribir la descripción de Vetur
(title: string, fileName: string, path: string) => SourceReescribir la fuente de tipos web. (El nombre de la exportación de la biblioteca de componentes)
(type: string) => undefined | string | BaseContributionSolo algunos tipos comunes se procesan internamente, y el resto se exportan desde la biblioteca de componentes de forma predeterminada. Si su documento también hace referencia a los tipos de bibliotecas de terceros, puede optar por anular el comportamiento relevante a través de esta función
stringtags.jsonNombre para las etiquetas del vetur
stringattributes.jsonNombre para los atributos del vetur
stringweb-types.jsonNombre para los tipos web de la tormenta web
string ( esta es una cadena regular e ignora el caso ).propsEl título de la tabla de accesorios. Otra cadena en el encabezado se identificará como subcomponente
stringName El nombre del encabezado del Name en la tabla de accesorios
stringDescription El nombre del encabezado de la Description en la tabla de accesorios
stringType El nombre del encabezado del Type en la tabla de accesorios
stringOptions El nombre del encabezado de las Options en la tabla de accesorios
stringDefault El nombre del encabezado del valor Default en la tabla de accesorios
string ( esta es una cadena regular e ignora el caso ).eventsEl título de la tabla de eventos. Otra cadena en el encabezado se identificará como subcomponente
stringName El nombre del encabezado del Name en la tabla de eventos
stringDescription El nombre del encabezado de la Description en la tabla de eventos
string ( esta es una cadena regular e ignora el caso ).slotsEl título de la tabla de tragamonedas. Otra cadena en el encabezado se identificará como subcomponente
stringName El nombre del encabezado del Name en la tabla de ranuras
stringDescription El nombre del encabezado de la Description en la tabla de ranuras
stringType El nombre del encabezado del Type en la tabla de ranuras
stringSubtags El nombre del encabezado de las Subtags en la tabla de ranuras
string ( esta es una cadena regular e ignora el caso ).directivesEl título de la tabla de directivas. Otra cadena en el encabezado se identificará como subcomponente
stringName El nombre del encabezado del Name en la tabla de directivas
stringDescription El nombre del encabezado de la Description en la tabla de directivas
stringType El nombre del encabezado del Type en la tabla de directivas
RegExp | string ( esta es una cadena normal)./#+s+(.*)n+([^(#|n)]*)/gcoincide con la información del título y la descripción de los documentos
RegExp | string ( esta es una cadena normal)./#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g #+s+(coincide con el título y el encabezado de la tabla y la tabla contiene información de los documentos
RegExp | string ( esta es una cadena normal).//((w|-)+).w+$/coincide con el nombre del archivo de la ruta
coincide con la información del primer formato en los documentos
/#+ s+( .* ) n+( [^(#|n)]* )//
titledescriptiony
titlecoincide con otros formatos, por ejemplo:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptioncoincide con la información de formato en los documentos
/#+ s+( .* ) |?.+|.+ (n|?.+|.+)+
title| header || column || column |y
sub-component title| header || column || column |Por defecto, coincide con todas las tablas, optimice a través de TablerEgexp, por ejemplo:
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) (n|?.+|.+)+ |?.+|.+
Props / Events / Slots / Directives| header || column || column |y
sub-component Props| header || column || column | Cuando este documento no incluye las Slots y Directives Events del título o del Props principal, este componente no se crea.
MIT
