components helper
v2.2.0
Com o suporte da Webstorm do Volar, você não precisa mais desta biblioteca.
É mais recomendado que você use o prompt de código do Volar, melhorando a declaração de tipo.
Se você ainda precisar desta biblioteca, pode continuar a usá -la, mas essa biblioteca não terá mais novas atualizações de recursos.
Com base nos documentos para fornecer arquivos de prompt de código para biblioteca de componentes VUE
Documentos de referência Formato Arquivos de teste de referência
Changelog
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )exemplo
então em 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[]Especifique o diretório de entrada. Consulte: Glob Fast
por exemplo:
docs/*.md - corresponde a todos os arquivos nos documentosdocs/(a|b).md - corresponde a arquivos a.md e b.mddocs/!(a|b).md - corresponde a arquivos, exceto para a.md e b.mdobjectA configuração de fast-glob
truestringEspecifique o diretório de saída. Por exemplo, `lib``
truestringNome da biblioteca de componentes.
truestringA versão da biblioteca de componentes.
number | stringAdiciona o indentação, o espaço branco e os caracteres de quebra de linha ao texto JSON de retorno-valor para facilitar a leitura
string/O separador para propoções, slotsSsubtags, tipo ...
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)reescrever o nome do componente
por exemplo (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefindReescrevendo o URL do DOC do componente
(value: string, key: string, row: string[], title: string) => string | undefined reescrever o atributo do componente
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Reescrevendo a descrição de Vetur
(title: string, fileName: string, path: string) => SourceReescrevendo a fonte de tipos da Web. (o nome da exportação da biblioteca de componentes)
(type: string) => undefined | string | BaseContributionApenas alguns tipos comuns são processados internamente e o restante é exportado da biblioteca de componentes por padrão. Se o seu documento também faz referência a tipos de tipos de bibliotecas de terceiros, você poderá substituir o comportamento relevante por meio desta função
stringtags.jsonNome para tags do vetur
stringattributes.jsonNome para atributos do Vetur
stringweb-types.jsonnome para tipos da web da tempestade da web
string ( esta é uma string regular e ignora o caso. )propsO título da tabela de adereços. Outra string no cabeçalho será identificada como subcomponente
stringName O nome do cabeçalho do Name na tabela de adereços
stringDescription O nome do cabeçalho da Description na tabela de adereços
stringType O nome do cabeçalho do Type na tabela de adereços
stringOptions O nome do cabeçalho das Options na tabela de adereços
stringDefault O nome do cabeçalho do Default na tabela de adereços
string ( esta é uma string regular e ignora o caso. )eventsO título da tabela de eventos. Outra string no cabeçalho será identificada como subcomponente
stringName O nome do cabeçalho do Name na tabela de eventos
stringDescription O nome do cabeçalho da Description na tabela de eventos
string ( esta é uma string regular e ignora o caso. )slotsO título da tabela de slots. Outra string no cabeçalho será identificada como subcomponente
stringName O nome do cabeçalho do Name na tabela de slots
stringDescription O nome do cabeçalho da Description na tabela de slots
stringType O nome do cabeçalho do Type na tabela de slots
stringSubtags O nome do cabeçalho das Subtags na tabela de slots
string ( esta é uma string regular e ignora o caso. )directivesO título da tabela de diretrizes. Outra string no cabeçalho será identificada como subcomponente
stringName O nome do cabeçalho do Name na tabela de diretrizes
stringDescription O nome do cabeçalho da Description na tabela de diretrizes
stringType O nome do cabeçalho do Type na tabela de diretrizes
RegExp | string ( esta é uma string regular. )/#+s+(.*)n+([^(#|n)]*)/g **)/GCombina o título e as informações de descrição dos documentos
RegExp | string ( esta é uma string regular. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/gCombina o título e o cabeçalho da tabela e a tabela contém informações dos documentos
RegExp | string ( esta é uma string regular. )//((w|-)+).w+$/corresponde ao nome do arquivo do caminho
corresponde às informações do primeiro formato nos documentos
/#+ s+( .* ) n+( [^(#|n)]* )/
titledescriptione
titlecorresponde a outros formatos, por exemplo:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptioncorresponde às informações do formato nos documentos
/#+ s+( .* ) n+( |?.+|.+ ) n |? s*:?-+:? s*|.+( (n|?.+|.+)+ )/g
title| header || column || column |e
sub-component title| header || column || column |Por padrão, corresponde a todas as tabelas, otimize -as através do tableRegexp, por exemplo:
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n+( |?.+|.+ ) n |? s*:?-+:? s*|+( (n|?.+|.+)+ |
Props / Events / Slots / Directives| header || column || column |e
sub-component Props| header || column || column | Quando este documento não inclui o título primário ou Slots e Directives Props Events esse componente não é criado.
Mit
