components helper
v2.2.0
مع دعم العاصفة على الويب من VOLAR ، قد لا تحتاج إلى هذه المكتبة.
يوصى باستخدام موجه رمز 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.mddocs/!(a|b).md - مطابقة الملفات باستثناء a.md و b.mdobjectتكوين سريع الزلاجات
truestringحدد دليل الإخراج. على سبيل المثال ، `lib``
truestringاسم مكتبة المكون.
truestringإصدار مكتبة المكون.
number | stringيضيف المسافة البادئة ، والمساحة البيضاء ، وكسر الخط إلى نص 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 DOC للمكون
(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) => Sourceإعادة كتابة مصدر أنواع الويب. (اسم التصدير من مكتبة المكون)
(type: string) => undefined | string | BaseContributionتتم معالجة بعض الأنواع الشائعة داخليًا فقط ، ويتم تصدير الباقي من مكتبة المكون بشكل افتراضي. إذا كان المستند الخاص بك يشير أيضًا إلى أنواع في مكتبات الطرف الثالث ، فيمكنك اختيار تجاوز السلوك ذي الصلة من خلال هذه الوظيفة
stringtags.jsonاسم لعلامات Vetur
stringattributes.jsonاسم لسمات Vetur
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 #+s+(.*)n+( Budap^(#|n)يطابق العنوان والوصف معلومات من المستندات
RegExp | string ( هذه سلسلة عادية. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g s+(.*)N+(||؟.+|يطابق رأس العنوان ورأس الجدول ويحتوي الجدول على معلومات من المستندات
RegExp | string ( هذه سلسلة عادية. )//((w|-)+).w+$/ WO-)+).W+$/يطابق اسم الملف من المسار
يطابق معلومات التنسيق الأول في المستندات
/#+ s+( .* ) n+( [^(#|n)]* )/
titledescriptionو
titleيطابق التنسيقات الأخرى ، على سبيل المثال:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptionيطابق معلومات التنسيق في المستندات
/#+ s+( .* ) |?.+|.+ (n|?.+|.+)+
title| header || column || column |و
sub-component title| header || column || column |بشكل افتراضي يطابق جميع الجداول ، قم بتحسينه من خلال TableRegexP ، على سبيل المثال:
|?.+|.+ #+ s+ .*s*Props|.*s*Events|.*s*Slots|.*s*Directives (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |و
sub-component Props| header || column || column | عندما لا يتضمن هذا المستند Slots Events Props الأساسي أو Directives ، لا يتم إنشاء هذا المكون.
معهد ماساتشوستس للتكنولوجيا
