components helper
v2.2.0
在Volar的Webstorm支持下，您可能不再需要此库。
建议您通过改进类型声明来使用Volar的代码提示。
如果您仍然需要此库，则可以继续使用它，但是该库将不再具有新功能更新。
基于文档，为VUE组件库提供代码提示文件
参考文档格式参考测试文件
ChangElog
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[]指定输入目录。请参阅：快速整个
例如：
docs/*.md匹配文档中的所有文件docs/(a|b).md匹配文件a.md和b.mddocs/!(a|b).md匹配文件，除了a.md和b.mdobjectFast-Glob的配置
truestring指定输出目录。例如，``lib''
truestring组件库的名称。
truestring组件库的版本。
number | string在返回值JSON文本中添加凹痕，空白空间和线路断开字符，以使阅读更容易
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重写组件的DOC URL
(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重写Web类型的来源。 （来自组件库的导出名称）
(type: string) => undefined | string | BaseContribution默认情况下，仅在内部处理一些常见类型，其余类型将从组件库中导出。如果您的文档还引用了第三方库中的类型，则可以选择通过此功能覆盖相关行为
stringtags.json兽医标签的名称
stringattributes.json兽医属性的名称
stringweb-types.jsonWebStorm的Web类型的名称
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 s+（.*） n+（匹配文档的标题和描述信息
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匹配文档中的格式信息
/＃+ (n|?.+|.+)+ s+ .* |?.+|.+
title| header || column || column |和
sub-component title| header || column || column |默认情况下，匹配所有表，例如：
/＃+ s+ .*s*Props|.*s*Events|.*s*Slots|.*s*Directives |?.+|.+ (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |和
sub-component Props| header || column || column |当此文档不包括主要标题或Props Events Slots和Directives ，则不会创建此组件。
麻省理工学院
