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 ，則不會創建此組件。
麻省理工學院
