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[]エントリディレクトリを指定します。参照：fast-glob
例えば：
docs/*.mdドキュメント内のすべてのファイルと一致しますdocs/(a|b).mdファイルa.mdおよびb.md一致させますdocs/!(a|b).md a.mdおよびb.mdを除くファイルと一致しますobjectfast-globの構成
truestring出力ディレクトリを指定します。たとえば、「lib」
truestringコンポーネントライブラリの名前。
truestringコンポーネントライブラリのバージョン。
number | stringインデンテーション、ホワイトスペース、およびラインブレイク文字をreturn-value JSONテキストに追加して、読みやすくします
string/Propsoptions、slotssubtags、タイプのセパレーター...
(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コンポーネントのドキュメントURLを書き換えます
(value: string, key: string, row: string[], title: string) => string | undefined コンポーネントの属性の書き換え
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})と同じVeturの説明を書き直します
(title: string, fileName: string, path: string) => SourceWebタイプのソースの書き換え。 （コンポーネントライブラリからのエクスポートの名前）
(type: string) => undefined | string | BaseContribution一部の一般的なタイプのみが内部で処理され、残りはデフォルトでコンポーネントライブラリからエクスポートされます。ドキュメントがサードパーティライブラリのタイプも参照する場合、この機能を介して関連する動作をオーバーライドすることを選択できます
stringtags.jsonVeturのタグの名前
stringattributes.json獣医の属性の名前
stringweb-types.jsonウェブストームの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+( [^(#| n）]*)/gドキュメントのタイトルと説明情報と一致します
RegExp | string （これは通常の文字列です。 ）/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g s+（タイトルとテーブルヘッダーと一致し、テーブルにはドキュメントからの情報が含まれています
RegExp | string （これは通常の文字列です。 ）//((w|-)+).w+$/ /(( w|-)+）.w+$/パスのファイル名を一致させます
ドキュメントの最初の形式情報と一致します
/＃+ s+（ .* ） n+（ [^(#|n)]* ）/
titledescriptionそして
titleたとえば、他の形式と一致します。
/＃+ s+（ .* ） n+> s*（ [^(#|n)]* ）/g
titledescriptionドキュメントのフォーマット情報と一致します
/＃+ s+（ .* ） n+（ |?.+|.+ ） n |？ s*：？ - +：？ s*|。+（（ (n|?.+|.+)+ ）/g
title| header || column || column |そして
sub-component title| header || column || column |デフォルトでは、すべてのテーブルと一致し、TableGexpを使用して最適化します。たとえば、次のようになります。
/＃+ 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が含まれていない場合、このコンポーネントは作成されません。
mit
