คู่มือการพัฒนา CoE CLI (เลิกใช้แล้ว)

คู่มือเป็นกุญแจสำคัญในการทำความเข้าใจว่า CLI ทำงานอย่างไร เมื่อคุณเพิ่มคำสั่งใหม่ ให้พิจารณาคู่มือต่อไปนี้:

• เพิ่มหน้า Markdown
• บันทึกบรรทัดคําสั่ง

เพิ่มหน้า Markdown

เพิ่มหน้าใหม่ไปที่วิธีใช้ที่อธิบายคำสั่งใหม่และอธิบายให้ผู้ใช้ทราบถึงการใช้งานที่คาดหมาย

พิจารณาเพิ่มสิ่งต่อไปนี้ในเพจ:

1. รูปภาพแบบคงที่ที่สรุปการดำเนินการ
2. บันทึกบรรทัดคำสั่งเพื่อแสดงกระบวนการ

ไดอะแกรม

สำหรับแผนผังการตัดสินใจ ไดอะแกรมจะถูกสร้างขึ้นผ่าน Mermaid

ตัวอย่างไดอะแกรม:

• การครบกำหนด
• แผนผังการตัดสินใจ AA4PP

รูปแบบไดอะแกรม

ในการกำหนดลักษณะแผนผัง sample.mmd:

1. ใช้สไตล์กลุ่มย่อย

   graph
       subgraph journey[Journey]
         start(Start) --> finish(Finish Here)
       end
   
       style journey fill:transparent,stroke:green,stroke-width:2px
   

2. นำรูปแบบ CSS ที่มีไฟล์ในโฟลเดอร์เดียวกันมาใช้ ตัวอย่างเช่น สร้าง sample.css ในโฟลเดอร์เดียวกับไฟล์ .mmd

   #L-start-finish path {
      stroke: red
   }
   

หมายเหตุ

1. ตรวจสอบ รูปร่างโหนด เพื่อการควบคุมสัญลักษณ์ที่ปรากฏ

2. กำหนดลักษณะวงกลมล์โดยใช้วิธีการต่อไปนี้

   graph TD
      subgraph Journey
         start(Start Here) ---> finish((End Here))
      end
   

   หากต้องการระบายสีวงกลมท้ายเป็นสีเขียว ให้ใช้ แอตทริบิวต์ CSS^=ตัวเลือกค่า ตัวเลือกนี้จำเป็นเนื่องจากแต่ละรายการจะมี ID ที่ไม่ซ้ำกันซึ่งกำหนดโดย Mermaid

   [id^=flowchart-finish] circle {
      stroke: green;
      fill: lightgreen
   }
   

3. กำหนดสีของเส้น แต่ละบรรทัดจะมีรูปแบบ L-start-finish สําหรับ pathซึ่งเป็นเส้น และคลาส .pathซึ่งเป็นเส้นรอบๆ หัวลูกศร

   #L-start-finsh path,
   #L-start-finsh .path
    {
      stroke: green;
   }
   

อัปเดตไดอะแกรม

รูปภาพแบบคงที่สำหรับแต่ละไดอะแกรมจะถูกสร้างขึ้นดังนี้

1. ไปที่หน้าโฟลเดอร์ coe-cli

   cd coe-cli
   

2. สร้างแฟ้มแบบคงที่

   npm run diagrams
   

เพิ่มหน้าความช่วยเหลือ

เพิ่มหน้าความช่วยเหลือใหม่ไปที่ ความช่วยเหลือ หน้าความช่วยเหลือแต่ละหน้าให้ข้อมูลโดยละเอียดเกี่ยวกับคำสั่งและตัวเลือก ไฟล์ Markdown ความช่วยเหลือสามารถเข้าถึงได้โดยใช้คำสั่ง help ซึ่งจะแสดงไฟล์ Markdown วิธีใช้ที่เกี่ยวข้องในหน้าต่างคอนโซล

coe help alm

คำสั่งนี้แสดงเนื้อหาของวิธีใช้

บันทึกบรรทัดคําสั่ง

หากต้องการรวมการบันทึกภาพเคลื่อนไหวสั้นๆ ของคำสั่งที่แสดงผลลัพธ์ที่คาดไว้ ให้ใช้กระบวนการต่อไปนี้

1. ติดตั้ง termtosvg ในเทอร์มินัลที่ใช้ Unix

   pip3 install --user termtosvg
   

   กระบวนการนี้ทำงานข้ามแพลตฟอร์มและสามารถใช้ตัวเลือกใดๆ ต่อไปนี้ได้:

   • Native Unix shell บน macOS หรือ Linux distribution
   • รูปภาพ Docker พร้อมเชลล์ Unix
   • ระบบย่อย Windows สำหรับ Linux บน Windows

2. บันทึกเซสชันไปยังไฟล์แคสต์

   termtosvg record test.cast
   

   ไฟล์กการแปลงที่ส่งเป็นไฟล์ข้อความธรรมดาที่สามารถแก้ไขได้ด้วยโปรแกรมแก้ไขข้อความใดๆ

3. ลบการหยุดชั่วคราวโดยใช้ term-trim.ps1

   ./term-trim.ps1 -Input test.cast -Output test2.cast -Trim 1
   
   

4. สร้างไฟล์ svg

   termtosvg render test2.cast test.svg -t window_frame