components helper
v2.2.0
С поддержкой Webstorm Volar вам больше не понадобится эта библиотека.
Более рекомендовано, чтобы вы использовали подсказку Volar, улучшив объявление типа.
Если вам все еще нужна эта библиотека, вы можете продолжать ее использовать, но эта библиотека больше не будет иметь новых обновлений функций.
На основе документов для предоставления файлов запросов на код для библиотеки компонентов VUE
Справочные документы форматируют справочные тестовые файлы
Изменение
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )пример
Затем в 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[]Укажите каталог записи. См.: Fast-Glob
например:
docs/*.md - соответствует всем файлам в документахdocs/(a|b).md - соответствует файлам a.md и b.mddocs/!(a|b).md - соответствует файлам, за исключением a.md и b.mdobjectКонфигурация быстрогогрового
truestringУкажите выходной каталог. Например, `lib`
truestringНазвание библиотеки компонентов.
truestringВерсия библиотеки компонентов.
number | stringДобавляет символы в отступление, белое пространство и линейные разрывы в текст json viture value, чтобы облегчить чтение
string/Сепаратор для репутации, слотов -подсуд, типа ...
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)переписывание названия компонента
Например (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefindПереписывание доктора компонента
(value: string, key: string, row: string[], title: string) => string | undefined переписывание атрибута компонента
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Переписывание описания ветера
(title: string, fileName: string, path: string) => SourceПереписывание источника веб-типов. (Имя экспорта из библиотеки компонентов)
(type: string) => undefined | string | BaseContributionТолько некоторые общие типы обрабатываются внутри, а остальные экспортируются из библиотеки компонентов по умолчанию. Если ваш документ также ссылается на типы в библиотеках сторонних лиц, вы можете переопределить соответствующее поведение через эту функцию
stringtags.jsonНазвание для тегов ветера
stringattributes.jsonНазвание для атрибутов ветера
stringweb-types.jsonНазвание для веб-типов веб-шарма
string ( это обычная строка и игнорирует случай. )propsНазвание таблицы реквизита. Другая строка в заголовке будет идентифицирована как субкомпонента
stringName Название заголовка Name в таблице реквизита
stringDescription Название заголовка Description в таблице реквизита
stringType Название заголовка Type в таблице реквизита
stringOptions Название заголовка Options в таблице реквизита
stringDefault Название заголовка по Default в таблице репута
string ( это обычная строка и игнорирует случай. )eventsНазвание таблицы событий. Другая строка в заголовке будет идентифицирована как субкомпонента
stringName Название заголовка Name в таблице событий
stringDescription Название заголовка Description в таблице событий
string ( это обычная строка и игнорирует случай. )slotsНазвание таблицы слотов. Другая строка в заголовке будет идентифицирована как субкомпонента
stringName Название заголовка Name в таблице слотов
stringDescription Название заголовка Description в таблице слотов
stringType Название заголовка Type в таблице слотов
stringSubtags Название заголовка Subtags в таблице слотов
string ( это обычная строка и игнорирует случай. )directivesНазвание таблицы директив. Другая строка в заголовке будет идентифицирована как субкомпонента
stringName Название заголовка Name в таблице директоров
stringDescription Название заголовка Description в таблице директоров
stringType Название заголовка Type в таблице директоров
RegExp | string ( это обычная строка. )/#+s+(.*)n+([^(#|n)]*)/gСопоставляет информацию о названии и описании из документов
RegExp | string ( это обычная строка. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g +s+(.*)n+(\|?соответствует заголовку заголовка и таблицы, а таблица содержит информацию от документов
RegExp | string ( это обычная строка. )//((w|-)+).w+$/соответствует имени файла с пути
Сопоставляет информацию о первом формате в документах
/#+ s+( .* ) n+( [^(#|n)]* )//
titledescriptionи
titleсоответствует другим форматам, например:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptionсоответствует информации о формате в документах
/#+ s+( .* ) n+( |?.+|.+ ) n |? (n|?.+|.+)+
title| header || column || column |и
sub-component title| header || column || column |По умолчанию соответствует всем таблицам, оптимизируйте его через Tablegexp, например:
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n+( |?.+|.+ ) (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |и
sub-component Props| header || column || column | Когда этот документ не включает в себя Slots и Directives Events и Props , этот компонент не создается.
Грань
