เริ่มต้นใช้งาน
ในบทแนะนำนี้ คุณจะสร้าง codeknit จากซอร์สโค้ด รันการแยกวิเคราะห์ครั้งแรก และอ่านไฟล์เอาต์พุต .skt ที่เขียนขึ้น คุณจะแยกวิเคราะห์แพ็กเกจขนาดเล็กจากที่เก็บ codeknit ดังนั้นคุณจึงไม่จำเป็นต้องมีโปรเจ็กต์ของคุณเอง
ข้อกำหนดเบื้องต้น
หัวข้อที่มีชื่อว่า “ข้อกำหนดเบื้องต้น”- Go 1.26 หรือใหม่กว่า รัน
go versionเพื่อตรวจสอบ - คอมไพเลอร์ C codeknit ใช้ tree-sitter ซึ่งต้องการ CGo
- Git และ Make
1. สร้าง codeknit
หัวข้อที่มีชื่อว่า “1. สร้าง codeknit”โคลนที่เก็บและสร้าง:
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildคุณควรเห็นการสร้างเสร็จสิ้นโดยไม่มีข้อผิดพลาด และไบนารีที่ ./bin/codeknit
2. เพิ่ม codeknit ไปยัง PATH ของคุณ
หัวข้อที่มีชื่อว่า “2. เพิ่ม codeknit ไปยัง PATH ของคุณ”จากไดเรกทอรี codeknit ให้เพิ่ม bin ไปยัง PATH ของคุณโดยใช้บรรทัดสำหรับเชลล์ของคุณ
สำหรับ bash หรือ zsh:
export PATH="$PATH:$(pwd)/bin"สำหรับ fish:
fish_add_path (pwd)/binสิ่งนี้จะมีผลในเซสชัน bash หรือ zsh ปัจจุบันของคุณ เพื่อให้คงอยู่ในเซสชันถัดไป ให้เพิ่มบรรทัดเดียวกันไปยัง ~/.bashrc หรือ ~/.zshrc โดยใช้พาธแบบเต็มไปยัง bin แทนที่ $(pwd)/bin
3. ตรวจสอบการติดตั้ง
หัวข้อที่มีชื่อว่า “3. ตรวจสอบการติดตั้ง”codeknit --versionคุณควรเห็นเวอร์ชันของ codeknit ที่พิมพ์ออกมา
4. รันการแยกวิเคราะห์ครั้งแรก
หัวข้อที่มีชื่อว่า “4. รันการแยกวิเคราะห์ครั้งแรก”อยู่ในไดเรกทอรี codeknit และแยกวิเคราะห์แพ็กเกจ internal/console:
codeknit parse ./internal/console --edgescodeknit จะสแกนไดเรกทอรี แยกวิเคราะห์ไฟล์ซอร์สที่รองรับแต่ละไฟล์ และเขียนไฟล์ .skt ไฟล์ .skt คือไฟล์ข้อความขนาดกะทัดรัดที่แสดงรายการสัญลักษณ์ในโค้ดของคุณและความสัมพันธ์ระหว่างสัญลักษณ์นั้น ๆ แฟล็ก --edges จะเพิ่มความสัมพันธ์เหล่านั้น โดยปกติจะถูกละไว้เพื่อประหยัดพื้นที่
คุณควรเห็นสรุปสั้น ๆ เมื่อคำสั่งเสร็จสิ้น และไดเรกทอรีใหม่ ./skeleton ในไดเรกทอรีปัจจุบันของคุณ
แสดงรายการเอาต์พุต:
ls ./skeletonคุณควรเห็นไฟล์เช่น map_001.skt
5. อ่านเอาต์พุต
หัวข้อที่มีชื่อว่า “5. อ่านเอาต์พุต”เปิดไฟล์:
cat ./skeleton/map_001.sktคุณควรเห็นส่วน [symbols] ก่อน สัญลักษณ์ คือรายการที่มีชื่อในโค้ดของคุณ เช่น ฟังก์ชัน ประเภท หรือฟิลด์ สัญลักษณ์จะถูกจัดกลุ่มภายใต้หัวข้อ ## <source file> เอาต์พุตของคุณจะมีบรรทัดเช่นนี้:
[symbols]## <path to>/console.goS1 module/package L5-L5 consoleS2 type/struct L17-L25 Console {exported}...S10 callable/function L28-L41 New() -> *S2 {exported}...S12 callable/method L49-L49 Error(msg: string) {exported, receiver=*Console}แต่ละบรรทัดมีส่วนประกอบดังนี้:
| ส่วน | ตัวอย่าง | ความหมาย |
|---|---|---|
| Short ID | S10 |
ป้ายกำกับสั้นสำหรับสัญลักษณ์ ใช้ในที่อื่น ๆ ของเอาต์พุต |
| หมวดหมู่และชนิด | callable/function |
ชนิดของสัญลักษณ์ |
| ช่วงบรรทัด | L28-L41 |
บรรทัดที่สัญลักษณ์ครอบคลุมในไฟล์ซอร์ส |
| ลายเซ็น | New() -> *S2 |
ชื่อ พารามิเตอร์ และประเภทการคืนค่า |
| คุณสมบัติ | {exported} |
รายละเอียดเพิ่มเติมในวงเล็บ |
ใน New() -> *S2 S2 คือ Short ID ของประเภท Console codeknit จะแทนที่ชื่อประเภทด้วย Short ID เมื่อทราบสัญลักษณ์ หมายเลขบรรทัดอาจแตกต่างเล็กน้อยหากการเช็คเอาต์ของคุณใหม่กว่า
เลื่อนลงไปที่ส่วน [edges] เส้นเชื่อม คือความสัมพันธ์ระหว่างสัญลักษณ์สองตัว แต่ละบรรทัดของเส้นเชื่อมจะระบุสัญลักษณ์ต้นทาง ชนิดของความสัมพันธ์ และสัญลักษณ์ปลายทางหรือสัญลักษณ์ปลายทางหลายตัว:
[edges]S2 --contains--> S4S4 --calls--> S5ตัวอย่างนี้แสดงรูปแบบของบรรทัดเส้นเชื่อม หมายความว่า “S2 มี S4” และ “S4 เรียก S5” คุณสามารถค้นหา Short ID แต่ละตัวใน [symbols] เพื่อดูว่ามันอ้างอิงถึงอะไร
สิ่งที่คุณทำได้
หัวข้อที่มีชื่อว่า “สิ่งที่คุณทำได้”คุณได้สร้าง codeknit เพิ่มไปยัง PATH ของคุณ รัน codeknit parse และอ่านส่วน [symbols] และ [edges] ของเอาต์พุต .skt
ขั้นตอนถัดไป
หัวข้อที่มีชื่อว่า “ขั้นตอนถัดไป”- แยกวิเคราะห์โปรเจ็กต์ของคุณเอง เลือกโครงสร้างเอาต์พุตที่แตกต่าง และรันใหม่อย่างปลอดภัย: ดู คู่มือคำสั่ง parse
- แสดงภาพและวิเคราะห์โครงสร้างโค้ดของคุณ: ดู คู่มือคำสั่งกราฟ
- ค้นหารายการซ้ำและรายการที่เกือบซ้ำ: ดู คู่มือคำสั่ง fingerprint
- ค้นหาทุกส่วนของรูปแบบ
.skt: ดู ข้อมูลอ้างอิงรูปแบบเอาต์พุต - ค้นหาทุกแฟล็กบรรทัดคำสั่ง: ดู ข้อมูลอ้างอิงแฟล็ก CLI