components helper
v2.2.0
ด้วยการสนับสนุน WebStorm ของ Volar คุณอาจไม่ต้องการไลบรารีนี้อีกต่อไป
ขอแนะนำให้คุณใช้พรอมต์รหัสของ Volar โดยการปรับปรุงการประกาศประเภท
หากคุณยังต้องการไลบรารีนี้คุณสามารถใช้งานต่อไปได้ แต่ไลบรารีนี้จะไม่มีการอัปเดตคุณสมบัติใหม่อีกต่อไป
ขึ้นอยู่กับเอกสารเพื่อระบุไฟล์พรอมต์รหัสสำหรับไลบรารี Vue Component
เอกสารอ้างอิงรูปแบบไฟล์อ้างอิงอ้างอิง
การเปลี่ยนแปลง
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การกำหนดค่าของ Fast-Glob
truestringระบุไดเร็กทอรีเอาต์พุต ตัวอย่างเช่น `lib``
truestringชื่อของไลบรารีส่วนประกอบ
truestringเวอร์ชันของไลบรารีส่วนประกอบ
number | stringเพิ่มการเยื้องพื้นที่สีขาวและอักขระแบ่งสายไปยังข้อความ return-value JSON เพื่อให้อ่านง่ายขึ้น
string/ตัวคั่นสำหรับ propsoptions, slotsubtags, พิมพ์ ...
(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ชื่อแท็กของสัตว์แพทย์
stringattributes.jsonชื่อสำหรับคุณลักษณะของสัตว์แพทย์
stringweb-types.jsonชื่อเว็บประเภทของ WebStorm
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 Teตรงกับข้อมูลชื่อและคำอธิบายจากเอกสาร
RegExp | string ( นี่คือสตริงปกติ )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g +Tตรงกับชื่อและส่วนหัวของตารางและตารางมีข้อมูลจากเอกสาร
RegExp | string ( นี่คือสตริงปกติ )//((w|-)+).w+$/ w|-)+)จับคู่ชื่อไฟล์จากเส้นทาง
ตรงกับข้อมูลรูปแบบแรกในเอกสาร
/#+ s+( .* ) n+( [^(#|n)]* )//
titledescriptionและ
titleจับคู่รูปแบบอื่น ๆ เช่น:
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescriptionตรงกับข้อมูลรูปแบบในเอกสาร
/#+ s+( .* ) n+( |?.+|.+ ) n |? s*:?-+:? s*|.+( (n|?.+|.+)+
title| header || column || column |และ
sub-component title| header || column || column |โดยค่าเริ่มต้นจับคู่ตารางทั้งหมดให้เพิ่มประสิทธิภาพผ่าน tablegexp ตัวอย่างเช่น:
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n+( |?.+|.+ ) n |? s* (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |และ
sub-component Props| header || column || column | เมื่อเอกสารนี้ไม่รวมชื่อหลักหรือ Props Events Slots และ Directives ส่วนประกอบนี้จะไม่ถูกสร้างขึ้น
มิกซ์
