ข้ามไปยังเนื้อหา

คำสั่ง Parse

codeknit parse อ่านไฟล์ซอร์สและเขียนสัญลักษณ์ (และความสัมพันธ์ระหว่างสัญลักษณ์ หากเลือก) เป็นไฟล์ .skt หรือ JSON คู่มือนี้ครอบคลุมสถานการณ์ที่คุณอาจพบบ่อยที่สุด สำหรับรายการแฟล็กทั้งหมดที่ใช้ร่วมกันในทุกคำสั่ง ดูที่ CLI flags reference สำหรับไวยากรณ์เอาต์พุต ดูที่ output format reference

Terminal window
codeknit parse ./src

codeknit เขียนไฟล์ .skt ที่แบ่งเป็นชิ้นไปยัง ./skeleton/ ได้แก่ map_001.skt, map_002.skt และต่อไป เปิดชิ้นส่วนที่ต้องการแทนที่จะโหลดทั้งหมดในครั้งเดียว

หากต้องการเขียนไปยังที่อื่น ให้ส่งไดเรกทอรีเอาต์พุตเป็นอาร์กิวเมนต์ที่สอง:

Terminal window
codeknit parse ./src ./output

ห้ามใช้ไดเรกทอรีซอร์สหรือไดเรกทอรีแม่ของซอร์สเป็นไดเรกทอรีเอาต์พุต

เลือกโหมดด้วย --output-mode

โหมด ใช้เมื่อ ผลลัพธ์
directory-flat การ parse โปรเจ็กต์ส่วนใหญ่ (ค่าเริ่มต้น) map_001.skt, map_002.skt, …
directory-tree คุณต้องการดูโครงสร้างโค้ดของไฟล์เดียว ไฟล์ .skt หนึ่งไฟล์ต่อไฟล์ซอร์ส โดยสะท้อนโครงสร้างต้นฉบับ
inline การ parse ไฟล์เดียว หรือส่งต่อไปยังเครื่องมืออื่น เอาต์พุตที่ stdout; ไม่ใช้ไดเรกทอรีเอาต์พุต

ในโหมด tree ชื่อไฟล์จะเก็บนามสกุลของซอร์ส: src/foo.c จะกลายเป็น src/foo.c.skt และ src/foo.h จะกลายเป็น src/foo.h.skt ไฟล์ขนาดใหญ่จะถูกแบ่งเป็น foo.c_part1.skt, foo.c_part2.skt และต่อไป

Terminal window
codeknit parse ./src --output-mode directory-tree

หลีกเลี่ยงการใช้ inline กับโปรเจ็กต์ทั้งหมด มันจะเขียนทุกอย่างไปยัง stdout และอาจทำให้เทอร์มินัลหรือหน้าต่างบริบทของ LLM ล้นได้

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการเลือกโหมด ดูที่ Output modes

codeknit ปฏิเสธการเขียนไปยังไดเรกทอรีที่มีเอาต์พุตที่สร้างขึ้นแล้วสำหรับรูปแบบที่เลือก เพื่อป้องกันไม่ให้ชิ้นส่วนที่เก่าและใหม่ผสมกัน เพิ่ม --clean เพื่อแทนที่เอาต์พุตก่อนหน้า:

Terminal window
codeknit parse ./src --clean

--clean จะไม่ลบอะไรล่วงหน้า codeknit สร้างเอาต์พุตใหม่ในไดเรกทอรีชั่วคราวและแทนที่ไฟล์ที่สร้างขึ้นเก่าเฉพาะหลังจากการสร้างสำเร็จ หากการสร้างล้มเหลวหรือกระบวนการถูกขัดจังหวะ เอาต์พุตก่อนหน้าจะถูกเก็บไว้หรือกู้คืนในการรันครั้งถัดไป ไฟล์ในไดเรกทอรีเอาต์พุตที่ codeknit ไม่ได้สร้างขึ้นจะถูกเก็บไว้ หากไฟล์ใดไฟล์หนึ่งชนกับพาธที่สร้างขึ้น การรันจะล้มเหลว

ในโหมด JSON กฎเดียวกันนี้ใช้กับ codeknit.json

ข้อผิดพลาด: ชิ้นส่วนผสม รหัสสัญลักษณ์ (S1, S2, …) และผลลัพธ์ความสัมพันธ์อาจเปลี่ยนแปลงระหว่างการรันและระหว่างเวอร์ชัน หลังจากอัปเกรดเป็น 0.5.0 ให้สร้างชุดเอาต์พุตทั้งหมดใหม่ด้วย --clean ห้ามรวมชิ้นส่วนจากการรันที่ต่างกัน

ชี้ parse ไปที่ไฟล์และใช้โหมด inline:

Terminal window
codeknit parse ./src/main.go --output-mode inline

เมื่อคุณเลือกไฟล์ซอร์สปกติอย่างชัดเจน codeknit จะข้ามการกรองไฟล์ที่ถูกละเว้นและไฟล์ทดสอบสำหรับไฟล์นั้น รูปแบบการรวม/ไม่รวมและขีดจำกัดขนาดยังคงมีผล

Terminal window
codeknit parse ./src --output-mode inline --format json --edges

เอกสาร JSON มีฟิลด์ระดับบนสุด ได้แก่ files, symbols, edges (ถูกละเว้นเมื่อไม่มี) และ errors (ถูกละเว้นเมื่อไม่มี) ตัวอย่างเล็กน้อย:

{
"files": ["app.go"],
"symbols": [
{
"id": "app.go::User",
"short_id": "S1",
"name": "User",
"file": "app.go",
"category": "type",
"kind": "struct",
"signature": "type User struct",
"span": [3, 3]
},
{
"id": "app.go::Save",
"short_id": "S2",
"name": "Save",
"file": "app.go",
"category": "callable",
"kind": "function",
"signature": "Save(u: S1)",
"span": [5, 5]
}
],
"edges": [
{
"from": "app.go::Save",
"from_short": "S2",
"to": "app.go::User",
"to_short": "S1",
"kind": "references"
}
]
}

หากต้องการเขียน JSON ไปยังดิสก์แทน ให้ละเว้น --output-mode inline ในโหมดไดเรกทอรี JSON จะไปที่ codeknit.json JSON เป็นเอกสารเดียวและไม่ถูกแบ่งตามจำนวนบรรทัด

โดยค่าเริ่มต้น เอาต์พุตมีเพียงส่วน [symbols] เท่านั้น ซึ่งช่วยประหยัดโทเค็น เพิ่ม --edges เมื่อคุณต้องการทราบว่าอะไรเรียกใช้ อะไรบรรจุ อะไรสืบทอด หรืออะไรรีเฟอร์ไปยังอะไร:

Terminal window
codeknit parse ./src --edges

Codeknit วิเคราะห์ไวยากรณ์โดยไม่มีคอมไพเลอร์ ดังนั้นความสัมพันธ์บางอย่างจึงไม่สามารถระบุได้ แต่ละเส้นเชื่อมจะบอกว่ามั่นใจแค่ไหน:

S8 --references--> S5
S10 --references[unresolved]--> string, bool
S11 --calls[ambiguous]--> Helper [candidates=S12, S15]
  • --kind--> เป็นความสัมพันธ์ที่ถูกระบุ
  • --kind[unresolved]--> หมายความว่า codeknit ไม่สามารถระบุเป้าหมายได้
  • --kind[ambiguous]--> หมายความว่ามีเป้าหมายที่เป็นไปได้มากกว่าหนึ่งเป้าหมาย รหัสผู้สมัครจะถูกแสดงเมื่อมี

ผู้สมัครคือเป้าหมายที่เป็นไปได้ ไม่ใช่การพึ่งพาที่ได้รับการยืนยัน จุดปลายที่ทราบจะใช้ ShortID ใน JSON เส้นเชื่อมที่ไม่แน่นอนจะมี resolution ("unresolved" หรือ "ambiguous") และเมื่อมี candidates เป็นรหัสสัญลักษณ์เต็ม พวกเขาจะละเว้น to_short

สำหรับ C และ C++ คำสั่ง #include จะกลายเป็นสัญลักษณ์ meta/file และ meta/include ดังนั้นเส้นเชื่อมของพวกเขาจะมี ShortID ซึ่งบันทึกคำสั่งตามที่เขียน ไม่ได้หมายความว่า codeknit พบเฮดเดอร์

การวิเคราะห์กราฟไม่รวมเส้นเชื่อมที่ไม่แน่นอนและรายงานจำนวนที่ถูกละเว้น เครื่องมือดูกราฟ HTML แสดงจำนวนความสัมพันธ์ที่ไม่แน่นอนและไม่วาดพวกมัน หากต้องการตรวจสอบเส้นเชื่อมที่ไม่แน่นอนแต่ละรายการ ให้ใช้ --edges กับ parse ดู Graph commands สำหรับรายงานเหล่านั้น

ไวยากรณ์ของเส้นเชื่อมอยู่ใน output format reference กฎและข้อจำกัดการระบุอยู่ใน language support reference

หากต้องการบีบอัดโทเค็นที่ซ้ำกัน ให้เพิ่ม --minify:

Terminal window
codeknit parse ./src --minify

สิ่งนี้จะเขียนพจนานุกรมไปยัง dict.skt (หรือส่วน [dict] แบบ inline) แทนที่รหัส เช่น d0 และ d1 ด้วยค่าจากพจนานุกรมเมื่ออ่าน ประเภทความสัมพันธ์ก็ถูกเข้ารหัสเช่นกัน แต่ป้ายกำกับการระบุ เช่น [unresolved] ยังคงอ่านได้

หากต้องการควบคุมขนาดชิ้นส่วน ให้ใช้ --max-lines (ค่าเริ่มต้น 500):

  • ในโหมด directory-flat มันเป็นเป้าหมาย บล็อกซอร์สจะไม่ถูกแบ่ง ดังนั้นชิ้นส่วนอาจเกินขนาดได้หนึ่งบล็อก
  • ในโหมด directory-tree มันเป็นขีดจำกัดสูงสุดสำหรับแต่ละชิ้นส่วนซอร์ส ขั้นต่ำคือ 3 แต่ละชิ้นส่วนจะทำซ้ำส่วนหัว [symbols] และ ## source-path

Codeknit จะ parse ไฟล์ .h เป็นภาษา C โดยค่าเริ่มต้น สำหรับเฮดเดอร์ C++ ที่มีนามสกุลนั้น ให้ตั้งค่า --header-language cpp:

Terminal window
codeknit parse ./src --header-language cpp

แฟล็กนี้มีผลเฉพาะกับไฟล์ .h ไฟล์ที่ตั้งชื่อ .hpp และ .hxx จะถูก parse เป็น C++ อยู่แล้ว และนามสกุลอื่นๆ จะใช้ parser ปกติ

คำสั่งประมวลผลซอร์สทั้งห้าคำสั่งยอมรับแฟล็กเหล่านี้ แสดงรายการทั้งหมดใน CLI flags reference

Terminal window
codeknit parse ./src --include '**/*.go' --exclude '**/generated/' --strict
  • --include GLOB และ --exclude GLOB สามารถใช้ซ้ำได้ เป็นรูปแบบ gitignore-style ที่สัมพันธ์กับไดเรกทอรีอินพุต ใส่เครื่องหมายคำพูดเพื่อไม่ให้เชลล์ขยายรูปแบบ ไฟล์ที่ถูกละเว้นจะชนะ รูปแบบการรวมไม่ได้แทนที่ .gitignore, การกรองไฟล์ทดสอบ หรือการยกเว้นในตัว
  • --max-file-size BYTES ข้ามไฟล์ที่ใหญ่กว่า ค่าเริ่มต้นคือ 10485760 (10 MiB) 0 ปิดการใช้งานขีดจำกัด
  • --strict ล้มเหลวก่อนเขียนเอาต์พุตใดๆ หากการสแกนหรือการ parse ไม่สมบูรณ์ ค่าเริ่มต้นคือ false

Codeknit ข้ามและรายงาน symlink และไฟล์ที่ไม่ใช่ไฟล์ปกติ กฎ .gitignore ของไดเรกทอรีแม่จะมีผลโดยไม่ขึ้นกับไดเรกทอรีทำงานของคุณ

ข้อผิดพลาด: ผลลัพธ์บางส่วน พาธที่ไม่สามารถอ่านได้ ไฟล์ขนาดใหญ่เกิน symlink ที่ถูกข้าม และคำเตือนไวยากรณ์ทำให้การวิเคราะห์ไม่สมบูรณ์ หากไม่มี --strict codeknit จะเก็บผลลัพธ์ที่ใช้ได้และรายงานปัญหา:

  • บน stderr,
  • ในฟิลด์ errors ของ JSON หรือ
  • ในส่วน SKT [errors] (แบบ inline หรือใน warnings.skt ในโหมดไดเรกทอรี)

อินพุตที่ไม่มีซอร์สที่รองรับที่ถูกเลือก หรือการรันที่ทุกซอร์สที่อ่านล้มเหลว จะออกไม่สำเร็จเสมอ สำหรับการรับประกันที่แน่นอน ดู Analysis reliability

แฟล็กเหล่านี้เป็นเฉพาะสำหรับ parse แฟล็กที่ใช้ร่วมกันอยู่ใน CLI flags reference

แฟล็ก ค่าเริ่มต้น คำอธิบาย
--output-mode directory-flat โหมดเอาต์พุต: inline, directory-flat หรือ directory-tree
--format skt รูปแบบเอาต์พุต: skt หรือ json
--header-language c Parser สำหรับไฟล์ .h: c หรือ cpp นามสกุลอื่นๆ ไม่เปลี่ยนแปลง
--max-lines 500 เป้าหมายจำนวนบรรทัดสำหรับเอาต์พุตแบบ flat; ขีดจำกัดสูงสุด (ขั้นต่ำ 3) สำหรับแต่ละชิ้นส่วนซอร์สแบบ tree
--collect-test false รวมไฟล์ทดสอบ
--minify false ใช้การบีบอัดแบบใช้พจนานุกรม
--edges false รวมส่วน [edges] (ปิดโดยค่าเริ่มต้นเพื่อประหยัดโทเค็น)
--clean false แทนที่เอาต์พุตที่สร้างขึ้นก่อนหน้า เฉพาะหลังจากการสร้างสำเร็จเท่านั้น
--workers NumCPU จำนวนสูงสุดของ goroutines การ parse ที่ทำงานพร้อมกัน
--verbose false พิมพ์ข้อมูลความคืบหน้า
  • ใช้ directory-flat สำหรับโปรเจ็กต์ส่วนใหญ่ และอ่านเฉพาะชิ้นส่วนที่ต้องการ
  • ใช้ --minify กับโค้ดเบสขนาดใหญ่เพื่อประหยัดโทเค็น
  • ส่ง --edges เฉพาะเมื่อคุณต้องการข้อมูลความสัมพันธ์
  • ตรวจสอบ เมทริกซ์ความสามารถที่ทดสอบและข้อจำกัดที่ทราบ ก่อนพึ่งพาการดึงข้อมูลสำหรับภาษาใดภาษาหนึ่ง