คำสั่งกราฟ
ใช้คำสั่งย่อย graph เพื่อดูว่ารหัสของคุณเชื่อมต่อกันอย่างไร ค้นหาปัญหาโครงสร้าง และตัดสินใจว่าควรปรับปรุงไฟล์ใดก่อน คู่มือนี้ถือว่าคุณได้ติดตั้ง codeknit และสามารถเรียกใช้ codeknit parse ได้
| งาน | คำสั่ง |
|---|---|
| สำรวจกราฟด้วยภาพ | codeknit graph show |
| ค้นหาปัญหาโครงสร้าง | codeknit graph analyze |
| ค้นหาไฟล์ที่สำคัญและมีการเปลี่ยนแปลงบ่อย | codeknit graph hotspots |
แสดงภาพกราฟโค้ด
หัวข้อที่มีชื่อว่า “แสดงภาพกราฟโค้ด”graph show จะแยกวิเคราะห์อินพุตและเขียนไฟล์ HTML ที่สามารถใช้งานได้ด้วยตัวเอง สัญลักษณ์ (ฟังก์ชัน คลาส ประเภท) จะเป็นโหนด ความสัมพันธ์ (การเรียกใช้ การบรรจุ การสืบทอด) จะเป็นเส้นเชื่อม
codeknit graph show ./myprojectไฟล์จะถูกเขียนไปที่ ./skeleton/codeknit-graph.html และเปิดในเบราว์เซอร์เริ่มต้นของคุณ
หากต้องการเลือกเส้นทางเอาต์พุตหรือรวมไฟล์ทดสอบ:
codeknit graph show ./myproject -o graph.htmlcodeknit graph show ./src --collect-test| Flag | ค่าเริ่มต้น | วัตถุประสงค์ |
|---|---|---|
-o, --output |
./skeleton/codeknit-graph.html |
เส้นทางไฟล์ HTML เอาต์พุต |
--collect-test |
false |
รวมไฟล์ทดสอบ |
--workers |
0 (NumCPU) |
จำนวน goroutines การแยกวิเคราะห์พร้อมกันสูงสุด |
--verbose |
false |
แสดงข้อมูลความคืบหน้า |
ตรวจสอบความสัมพันธ์ที่ไม่สามารถแก้ไขได้
หัวข้อที่มีชื่อว่า “ตรวจสอบความสัมพันธ์ที่ไม่สามารถแก้ไขได้”โปรแกรมดูจะวาดเฉพาะความสัมพันธ์ที่แก้ไขได้เท่านั้น จะแสดงจำนวนความสัมพันธ์ที่ไม่แน่นอน (unresolved หรือ ambiguous) แต่ไม่ได้วาดหรือแสดงลิงก์ผู้สมัคร
หากต้องการดูเส้นเชื่อมที่ไม่แน่นอนแต่ละรายการ ให้เรียกใช้ parse พร้อมกับ --edges:
codeknit parse ./src --output-mode inline --edgesเพิ่ม --format json สำหรับเอาต์พุต JSON ดูคู่มือรูปแบบเอาต์พุต สำหรับวิธีการเขียนเส้นเชื่อมและผู้สมัคร
วิเคราะห์โครงสร้างและค้นหาปัญหา
หัวข้อที่มีชื่อว่า “วิเคราะห์โครงสร้างและค้นหาปัญหา”graph analyze จะเรียกใช้อัลกอริทึมกราฟ 22 รายการและเขียนรายงาน .skt ที่สามารถอ่านได้โดย LLM
codeknit graph analyze ./myprojectรายงานจะถูกเขียนไปที่ ./skeleton/graph_analysis.skt อ่านโดยตรงหรือให้ LLM พร้อมกับซอร์สที่เกี่ยวข้อง
ปรับแต่งรายงาน
หัวข้อที่มีชื่อว่า “ปรับแต่งรายงาน”เพิ่มเกณฑ์เพื่อดูผลการค้นหาน้อยลง หรือลดเกณฑ์เพื่อดูผลการค้นหามากขึ้น:
codeknit graph analyze ./myproject -o analysis.skt --fan-threshold 15codeknit graph analyze ./myproject --top-n 50codeknit graph analyze ./src --collect-test--top-n 0 จะลบขีดจำกัดของส่วนที่จัดอันดับ
| Flag | ค่าเริ่มต้น | วัตถุประสงค์ |
|---|---|---|
-o, --output |
./skeleton/graph_analysis.skt |
เส้นทางไฟล์ .skt เอาต์พุต |
--collect-test |
false |
รวมไฟล์ทดสอบ |
--workers |
0 (NumCPU) |
จำนวน goroutines การแยกวิเคราะห์พร้อมกันสูงสุด |
--verbose |
false |
แสดงข้อมูลความคืบหน้า |
--fan-threshold |
10 |
จำนวน fan-in หรือ fan-out ขั้นต่ำเพื่อระบุสัญลักษณ์ฮับ |
--god-threshold |
15 |
จำนวนเส้นเชื่อมการบรรจุขั้นต่ำเพื่อระบุ god class หรือฟังก์ชัน |
--max-inheritance-depth |
5 |
ระบุลำดับการสืบทอดที่ลึกกว่านี้ |
--top-n |
30 |
จำกัดส่วนที่จัดอันดับ 0 หมายถึงไม่มีขีดจำกัด |
--betweenness-threshold |
0.001 |
ค่าความเป็นศูนย์กลางระหว่างness ขั้นต่ำที่จะรายงาน |
--propagation-cutoff |
0.05 |
คะแนนฮิวริสติกขั้นต่ำสำหรับการดำเนินการเผยแพร่การเปลี่ยนแปลงต่อ |
รู้ว่าผลการค้นหาใดตอบคำถามใด
หัวข้อที่มีชื่อว่า “รู้ว่าผลการค้นหาใดตอบคำถามใด”| อัลกอริทึม | ใช้เพื่อค้นหา |
|---|---|
| การพึ่งพาแบบวนรอบ (Tarjan’s SCC) | กลุ่มของสัญลักษณ์ที่พึ่งพาซึ่งกันและกันในลูป |
| การตรวจจับฮับ | สัญลักษณ์ที่มีการเชื่อมโยง fan-in หรือ fan-out สูง |
| การตรวจจับสัญลักษณ์กำพร้า | ผู้สมัครโค้ดที่ตายแล้ว |
| การตรวจจับ god class/ฟังก์ชัน | สัญลักษณ์ที่บรรจุจำนวนลูกมากเกินไป |
| เมตริกความไม่เสถียร | สัญลักษณ์และแพ็กเกจที่เปราะบางหรือเสถียร โดยใช้ Ce/(Ca+Ce) |
| ลำดับการสืบทอดที่ลึก | ลำดับชั้นที่ลึกกว่า --max-inheritance-depth |
| ความเป็นศูนย์กลางระหว่างness | คอขวดสัญลักษณ์ที่เส้นทางการพึ่งพาจำนวนมากผ่าน |
| จุดเชื่อมต่อ | จุดเดียวที่ล้มเหลวซึ่งการลบออกจะแยกกราฟ |
| PageRank | สัญลักษณ์ที่มีความสำคัญแบบเรียกซ้ำ |
| fan-in แบบส่งผ่าน | ขอบเขตผลกระทบ: ทุกสิ่งที่พึ่งพาสัญลักษณ์ ไม่ว่าจะโดยตรงหรือโดยอ้อม |
| การจำลองการเผยแพร่การเปลี่ยนแปลง | ระยะทางที่การเปลี่ยนแปลงสัญลักษณ์มีแนวโน้มที่จะแพร่กระจาย |
| การพึ่งพาแพ็กเกจแบบวนรอบ | ลูปการพึ่งพาระดับแพ็กเกจ |
| การตรวจจับการละเมิดเลเยอร์ | การพึ่งพาที่ข้ามเลเยอร์ในทิศทางที่ผิด |
| ความสามารถในการเข้าถึงจากจุดเข้า | โค้ดที่ไม่มีจุดเข้าเข้าถึง |
| องค์ประกอบที่เชื่อมต่อกันอย่างอ่อน | กลุ่มโค้ดที่แยกออกมา |
| น้ำหนักการพึ่งพา | ความแข็งแกร่งของการเชื่อมโยงระหว่างแพ็กเกจ |
| ระยะทางจาก Main Sequence | แพ็กเกจที่มีความเป็นนามธรรมและความไม่เสถียรไม่สมดุล |
| การตรวจจับการผ่าตัดแบบปืนลูกซอง | การเปลี่ยนแปลงที่จะส่งผลกระทบหลายที่ในแพ็กเกจ |
| การตรวจจับความอิจฉาคุณลักษณะ | สัญลักษณ์ที่ใช้แพ็กเกจอื่นมากกว่าแพ็กเกจของตนเอง |
| การละเมิดการพึ่งพาที่เสถียร | แพ็กเกจที่เสถียรที่พึ่งพาแพ็กเกจที่ไม่เสถียร |
| การละเมิดการแบ่งแยกอินเทอร์เฟซ | อินเทอร์เฟซที่สมาชิกส่วนใหญ่ไม่ได้ใช้โดยผู้ใช้ |
| ความลึกของการบรรจุ | สัญลักษณ์ที่ซ้อนกันลึก |
อ่านผลลัพธ์อย่างถูกต้อง
หัวข้อที่มีชื่อว่า “อ่านผลลัพธ์อย่างถูกต้อง”กฎเหล่านี้มีผลต่อความน่าเชื่อถือของผลการค้นหา:
- ความสัมพันธ์ที่ไม่แน่นอนจะถูกยกเว้น เมตริกการพึ่งพาจะใช้เฉพาะเส้นเชื่อมที่แก้ไขได้เท่านั้น รายงานจะนับความสัมพันธ์
unresolvedและambiguousที่ถูกละเว้น - เมตาดาต้าไฟล์และการรวมจะถูกละเว้น สัญลักษณ์
meta/fileและmeta/includeจะไม่มีผลต่อการจัดอันดับการพึ่งพาหรือผลการค้นหาโค้ดที่ตายแล้ว - fan-in และ fan-out จะนับเพื่อนบ้านที่แตกต่างกัน การบรรจุไม่ถือเป็นการพึ่งพา
- ความลึกของการสืบทอดครอบคลุมฐานและอินเทอร์เฟซทั้งหมด ลำดับชั้นแบบวนรอบจะไม่ได้รับการกำหนดความลึก
- ความสามารถในการเข้าถึงเริ่มต้นที่ callable
main,Mainหรือinitและตามเส้นเชื่อมการพึ่งพา สมาชิกที่สามารถเข้าถึงได้จะทำให้คอนเทนเนอร์ของมันมีความเกี่ยวข้อง แต่ไม่ใช่สมาชิกพี่น้อง หากการสแกนไม่พบจุดเข้าใด ๆ ที่รู้จัก ผลการค้นหาความสามารถในการเข้าถึงจะถูกละเว้น - Callbacks เป็นการอ้างอิง ไม่ใช่การเรียกใช้ อาร์กิวเมนต์ callback หรือ callable ที่ส่งคืนไม่ได้พิสูจน์ว่าคอลแบ็กทำงาน
- คะแนนเป็นฮิวริสติก การเผยแพร่การเปลี่ยนแปลงใช้เส้นทางการพึ่งพาที่แข็งแกร่งที่สุด คะแนนและกฎเลเยอร์ไม่ใช่ความน่าจะเป็นที่วัดได้หรือการรับประกันของคอมไพเลอร์
ดำเนินการตามผลการค้นหาอย่างปลอดภัย
หัวข้อที่มีชื่อว่า “ดำเนินการตามผลการค้นหาอย่างปลอดภัย”ปฏิบัติต่อผลการค้นหาทุกอย่างในฐานะผู้สมัครสำหรับการตรวจสอบ ก่อนที่จะเปลี่ยนแปลงโค้ด ให้เปิดสัญลักษณ์ที่รายงานระบุและตรวจสอบ:
- ผู้เรียกใช้ภายนอกนอกไดเรกทอรีที่สแกน
- การส่งผ่านแบบไดนามิก
- การพึ่งพาที่คุณไม่ได้สแกน
การวิเคราะห์อิงตามไวยากรณ์ ดังนั้นสิ่งเหล่านี้อาจเปลี่ยนแปลงข้อสรุปได้ ดูการแก้ไขความสัมพันธ์ในคู่มือการรองรับภาษา สำหรับกฎและข้อจำกัดในการแก้ไข
ค้นหาจุดร้อนที่คำนึงถึงประวัติ
หัวข้อที่มีชื่อว่า “ค้นหาจุดร้อนที่คำนึงถึงประวัติ”graph hotspots จะจัดอันดับไฟล์ที่มีการเปลี่ยนแปลงบ่อยและอยู่ในตำแหน่งที่สำคัญทางโครงสร้าง นอกจากนี้ยังรายงานการเชื่อมโยงตามเวลา: ไฟล์ที่มีการเปลี่ยนแปลงซ้ำในคอมมิตเดียวกัน เรียกใช้กับไดเรกทอรีภายในที่เก็บ Git
codeknit graph hotspots ./myprojectรายงานจะถูกเขียนไปที่ ./skeleton/hotspots.skt
จะรวมเมตริกสองกลุ่ม:
- ประวัติ: ความถี่ของคอมมิต การเปลี่ยนแปลงบรรทัดที่เพิ่มและลบ และความใหม่
- โครงสร้าง: PageRank ของไฟล์ระดับ fan-in แบบส่งผ่าน และความเป็นศูนย์กลางระหว่างness
รายงานรวมระดับความเชื่อมั่นตามจำนวนคอมมิตที่เกี่ยวข้องที่วิเคราะห์ ปฏิบัติต่อการจัดอันดับจากรายงานที่มีความเชื่อมั่นต่ำในฐานะข้อมูลเบื้องต้น
เปลี่ยนหน้าต่างประวัติและตัวกรอง
หัวข้อที่มีชื่อว่า “เปลี่ยนหน้าต่างประวัติและตัวกรอง”# วิเคราะห์สองปีและเขียน JSONcodeknit graph hotspots ./myproject --since 2y --format json -o hotspots.json
# อนุญาตคอมมิตที่ใหญ่ขึ้นและกำหนดความเชื่อมโยงตามเวลาที่แข็งแกร่งขึ้นcodeknit graph hotspots . --max-files-per-commit 100 --min-cochanges 5คอมมิตผสานจะถูกยกเว้นเว้นแต่คุณจะส่ง --include-merges คอมมิตที่เปลี่ยนแปลงไฟล์มากกว่า --max-files-per-commit จะถูกข้ามในฐานะคอมมิตจำนวนมาก ดังนั้นการเปลี่ยนแปลงที่สร้างขึ้นหรือเชิงกลไกจะไม่บิดเบือนการจัดอันดับ
| Flag | ค่าเริ่มต้น | วัตถุประสงค์ |
|---|---|---|
-o, --output |
./skeleton/hotspots.skt |
เส้นทางไฟล์เอาต์พุต |
--format |
skt |
รูปแบบเอาต์พุต: skt หรือ json |
--since |
12mo |
หน้าต่างประวัติ เช่น 180d, 12mo หรือ 2y |
--max-commits |
2000 |
จำนวนคอมมิตสูงสุดที่จะตรวจสอบ |
--max-files-per-commit |
50 |
ยกเว้นคอมมิตที่เปลี่ยนแปลงไฟล์มากกว่านี้ |
--min-cochanges |
3 |
จำนวนคอมมิตที่ใช้ร่วมกันขั้นต่ำเพื่อรายงานการเชื่อมโยงตามเวลา |
--top-n |
30 |
จำนวนผลลัพธ์สูงสุดต่อส่วน |
--include-merges |
false |
รวมคอมมิตผสานในเมตริกประวัติ |
--collect-test |
false |
รวมไฟล์ทดสอบ |
--workers |
0 (NumCPU) |
จำนวน goroutines การแยกวิเคราะห์พร้อมกันสูงสุด |
--verbose |
false |
แสดงข้อมูลความคืบหน้า |
อ่านเอาต์พุต JSON
หัวข้อที่มีชื่อว่า “อ่านเอาต์พุต JSON”เมื่อใช้ --format json จุดร้อนแต่ละจุดจะมี score, history_score, structure_score, recency_score, pagerank, betweenness, commits, churn และ transitive_fan_in การเชื่อมโยงตามเวลาแต่ละรายการจะมี left, right, strength และ co_changes ระดับบนสุดยังบันทึก commits_visited, commits_analyzed, skipped_merges และ skipped_bulk_commits ใช้จำนวนเหล่านี้เพื่อตรวจสอบว่าการจัดอันดับอิงจากประวัติมากน้อยเพียงใด
ควบคุมแหล่งที่มาที่จะสแกน
หัวข้อที่มีชื่อว่า “ควบคุมแหล่งที่มาที่จะสแกน”คำสั่งการประมวลผลแหล่งที่มาทั้งห้า (parse, fingerprint, graph show, graph analyze และ graph hotspots) ยอมรับ flag การเลือกเดียวกัน:
| Flag | ค่าเริ่มต้น | วัตถุประสงค์ |
|---|---|---|
--include GLOB |
แหล่งที่มาที่รองรับทั้งหมด | รวมเส้นทางที่ตรงกัน สามารถทำซ้ำได้ |
--exclude GLOB |
ไม่มี | ยกเว้นเส้นทางหรือไดเรกทอรีที่ตรงกัน สามารถทำซ้ำได้ การยกเว้นมีชัยเหนือการรวม |
--max-file-size BYTES |
10485760 (10 MiB) |
ข้ามไฟล์ที่ใหญ่กว่านี้ 0 ปิดใช้งานขีดจำกัด |
--strict |
false |
ล้มเหลวก่อนเขียนเอาต์พุตหากการสแกนหรือการแยกวิเคราะห์ไม่สมบูรณ์ |
รูปแบบเป็น glob แบบ gitignore สัมพัทธ์กับไดเรกทอรีอินพุต ใส่เครื่องหมายคำพูดเพื่อไม่ให้เชลล์ขยายรูปแบบ การรวมไม่ได้แทนที่กฎ .gitignore หรือการกรองทดสอบ
codeknit graph analyze ./src --include '**/*.go' --exclude '**/generated/' --strictจะข้าม symlink และไฟล์ที่ไม่ใช่ไฟล์ปกติและรายงาน ปัญหาการสแกนและการแยกวิเคราะห์จะปรากฏบน stderr หากไม่มี --strict codeknit จะเก็บผลลัพธ์บางส่วนที่ใช้งานได้ ดังนั้นให้ตรวจสอบ stderr ก่อนเชื่อถือรายงาน หากมี --strict การวิเคราะห์ที่ไม่สมบูรณ์จะหยุดก่อนที่จะมีการเขียนเอาต์พุตใด ๆ การรันที่ทุกแหล่งที่อ่านล้มเหลวจะล้มเหลวเสมอ
สำหรับการรับประกันที่แน่นอน ดูคู่มือความน่าเชื่อถือของการวิเคราะห์
หน้าที่เกี่ยวข้อง
หัวข้อที่มีชื่อว่า “หน้าที่เกี่ยวข้อง”- คู่มืออ้างอิง CLI flags: ทุก flag สำหรับทุกคำสั่ง
- คู่มือรูปแบบเอาต์พุต: ไวยากรณ์
.sktและ JSON - คู่มือการรองรับภาษา: ขีดจำกัดการแยกวิเคราะห์และการแก้ไข
- คู่มือคำสั่ง parse: แยกวิเคราะห์สัญลักษณ์และเส้นเชื่อมสำหรับไฟล์แต่ละไฟล์