คำถามที่พบบ่อย

นี่คือปัญหาและคำถามที่พบบ่อยเกี่ยวกับการเขียนส่วนขยาย

เหตุใดระบบจึงไม่สร้างไฟล์หรือไม่มีการดำเนินการตามที่ฉันสั่ง

Bazel จะดำเนินการเฉพาะการดำเนินการที่จำเป็นในการสร้างไฟล์เอาต์พุต ที่ขอ

• หากไฟล์ที่ต้องการมีป้ายกำกับ คุณสามารถขอไฟล์นั้นได้โดยตรงโดยใช้คำสั่ง bazel build //pkg:myfile.txt

• หากไฟล์อยู่ในกลุ่มเอาต์พุตของเป้าหมาย คุณอาจต้องระบุกลุ่มเอาต์พุตนั้นในบรรทัดคำสั่งโดยใช้คำสั่ง bazel build //pkg:mytarget --output_groups=foo

• หากต้องการให้ระบบสร้างไฟล์โดยอัตโนมัติทุกครั้งที่มีการกล่าวถึงเป้าหมายในบรรทัดคำสั่ง ให้เพิ่มไฟล์ลงในเอาต์พุตเริ่มต้นของกฎโดยการแสดงผลผู้ให้บริการ DefaultInfo

ดูข้อมูลเพิ่มเติมได้ที่หน้ากฎ

เหตุใดระบบจึงไม่ดำเนินการฟังก์ชันการใช้งาน

Bazel จะวิเคราะห์เฉพาะเป้าหมายที่ขอให้สร้าง คุณควรตั้งชื่อเป้าหมายในบรรทัดคำสั่งหรือตั้งชื่อสิ่งที่ขึ้นอยู่กับเป้าหมาย

ระบบไม่พบไฟล์เมื่อมีการดำเนินการตามที่ฉันสั่งหรือมีการดำเนินการไบนารี

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

สำหรับการดำเนินการ คุณจะประกาศอินพุตโดยส่งอินพุตไปยังฟังก์ชัน ctx.actions.* ที่สร้างการดำเนินการ คุณสามารถรับเส้นทางที่เหมาะสมสำหรับไฟล์ได้โดยใช้ File.path

สำหรับไบนารี (เอาต์พุตที่เรียกใช้งานได้ซึ่งเรียกใช้โดย bazel run หรือ bazel test คำสั่ง) คุณจะประกาศอินพุตโดยรวมอินพุตไว้ใน runfiles ให้ใช้ path แทนช่อง File.short_path ซึ่งเป็นเส้นทางของไฟล์ที่สัมพันธ์กับ ไดเรกทอรีไฟล์ที่เรียกใช้งานได้ซึ่งไบนารีเรียกใช้งาน

ฉันจะควบคุมไฟล์ที่ bazel build //pkg:mytarget สร้างได้อย่างไร

ใช้ผู้ให้บริการ DefaultInfo เพื่อ ตั้งค่าเอาต์พุตเริ่มต้น

ฉันจะเรียกใช้โปรแกรมหรือดำเนินการ I/O ของไฟล์เป็นส่วนหนึ่งของการบิลด์ได้อย่างไร

คุณสามารถประกาศเครื่องมือเป็นเป้าหมายได้เช่นเดียวกับส่วนอื่นๆ ของบิลด์ และเรียกใช้เครื่องมือในระยะการดำเนินการเพื่อช่วยสร้างเป้าหมายอื่นๆ หากต้องการสร้างการดำเนินการ ที่เรียกใช้เครื่องมือ ให้ใช้ ctx.actions.run และส่งเครื่องมือ เป็นพารามิเตอร์ executable

ในระยะการโหลดและการวิเคราะห์ เครื่องมือ จะเรียกใช้งานไม่ได้ และคุณจะดำเนินการ I/O ของไฟล์ไม่ได้ ซึ่งหมายความว่าเครื่องมือและเนื้อหาของไฟล์ (ยกเว้นเนื้อหาของไฟล์ BUILD และ .bzl) จะไม่ส่งผลต่อวิธีสร้างกราฟเป้าหมายและการดำเนินการ

ฉันควรทำอย่างไรหากต้องการเข้าถึง Structured Data เดียวกันทั้งก่อนและระหว่างระยะการดำเนินการ

คุณสามารถจัดรูปแบบ Structured Data เป็นไฟล์ .bzl และ load() ไฟล์เพื่อเข้าถึงไฟล์นั้นในระยะการโหลดและการวิเคราะห์ นอกจากนี้ คุณยังส่งไฟล์เป็นอินพุตหรือไฟล์ที่เรียกใช้งานได้ไปยังการดำเนินการและไฟล์ที่เรียกใช้งานได้ซึ่งจำเป็นต้องใช้ไฟล์นั้นในระยะการดำเนินการได้ด้วย

ฉันควรจัดทำเอกสารโค้ด Starlark อย่างไร

สำหรับกฎและแอตทริบิวต์ของกฎ คุณสามารถส่งสตริง docstring (อาจเป็นสตริงที่อยู่ในเครื่องหมายคำพูด 3 ตัว) ไปยังพารามิเตอร์ doc ของ rule หรือ attr.*() สำหรับฟังก์ชันและมาโครตัวช่วย ให้ใช้สตริง docstring ที่อยู่ในเครื่องหมายคำพูด 3 ตัวตามรูปแบบที่ระบุไว้ ที่นี่ โดยทั่วไปแล้ว ฟังก์ชันการใช้งานกฎไม่จำเป็นต้องมี docstring ของตัวเอง

การใช้สตริงในตำแหน่งที่คาดไว้จะช่วยให้เครื่องมืออัตโนมัติแยกเอกสารได้ง่ายขึ้น คุณสามารถใช้ความคิดเห็นที่ไม่ใช่สตริงมาตรฐานได้ทุกที่ที่อาจเป็นประโยชน์ต่อผู้อ่านโค้ด