Câu hỏi thường gặp

Sau đây là một số vấn đề và câu hỏi thường gặp khi viết tiện ích.

Tại sao tệp của tôi không được tạo / hành động của tôi không bao giờ được thực thi?

Bazel chỉ thực thi các hành động cần thiết để tạo tệp đầu ra được yêu cầu.

  • Nếu tệp bạn muốn có nhãn, bạn có thể yêu cầu trực tiếp: bazel build //pkg:myfile.txt

  • Nếu tệp nằm trong một nhóm đầu ra của mục tiêu, bạn có thể cần chỉ định nhóm đầu ra đó trên dòng lệnh: bazel build //pkg:mytarget --output_groups=foo

  • Nếu bạn muốn tệp được tạo tự động bất cứ khi nào mục tiêu của bạn được đề cập trên dòng lệnh, hãy thêm tệp đó vào đầu ra mặc định của quy tắc bằng cách trả về nhà cung cấp DefaultInfo.

Hãy xem trang Quy tắc để biết thêm thông tin.

Tại sao hàm triển khai của tôi không được thực thi?

Bazel chỉ phân tích các mục tiêu được yêu cầu cho bản dựng. Bạn nên đặt tên cho mục tiêu trên dòng lệnh hoặc một mục tiêu nào đó phụ thuộc vào mục tiêu đó.

Tệp bị thiếu khi hành động hoặc tệp nhị phân của tôi được thực thi

Đảm bảo rằng 1) tệp đã được đăng ký làm dữ liệu đầu vào cho hành động hoặc tệp nhị phân và 2) tập lệnh hoặc công cụ đang được thực thi đang truy cập vào tệp bằng đường dẫn chính xác.

Đối với các hành động, bạn khai báo dữ liệu đầu vào bằng cách truyền dữ liệu đó vào hàm ctx.actions.* tạo hành động. Bạn có thể lấy đường dẫn thích hợp cho tệp bằng cách sử dụng File.path.

Đối với tệp nhị phân (đầu ra có thể thực thi do lệnh bazel run hoặc bazel test chạy), bạn khai báo dữ liệu đầu vào bằng cách đưa dữ liệu đó vào runfiles. Thay vì sử dụng trường path, hãy sử dụng File.short_path, đây là đường dẫn của tệp tương ứng với thư mục runfiles mà tệp nhị phân thực thi.

Làm cách nào để kiểm soát những tệp được bazel build //pkg:mytarget tạo?

Sử dụng nhà cung cấp DefaultInfo để đặt đầu ra mặc định.

Làm cách nào để chạy một chương trình hoặc thực hiện thao tác I/O tệp như một phần của bản dựng?

Bạn có thể khai báo một công cụ dưới dạng mục tiêu, giống như bất kỳ phần nào khác của bản dựng và chạy trong giai đoạn thực thi để giúp tạo các mục tiêu khác. Để tạo một hành động chạy một công cụ, hãy sử dụng ctx.actions.run và truyền công cụ đó dưới dạng tham số executable.

Trong giai đoạn tải và phân tích, một công cụ không thể chạy, cũng như bạn không thể thực hiện thao tác I/O tệp. Điều này có nghĩa là các công cụ và nội dung tệp (ngoại trừ nội dung của tệp BUILD và .bzl) không thể ảnh hưởng đến cách tạo biểu đồ mục tiêu và hành động.

Tôi phải làm gì nếu cần truy cập vào cùng một dữ liệu có cấu trúc cả trước và trong giai đoạn thực thi?

Bạn có thể định dạng dữ liệu có cấu trúc dưới dạng tệp .bzl. Bạn có thể load() tệp để truy cập vào tệp đó trong giai đoạn tải và phân tích. Bạn có thể truyền tệp đó dưới dạng dữ liệu đầu vào hoặc tệp runfiles cho các hành động và tệp thực thi cần tệp đó trong giai đoạn thực thi.

Tôi nên ghi lại mã Starlark như thế nào?

Đối với các quy tắc và thuộc tính quy tắc, bạn có thể truyền một chuỗi tài liệu (có thể là chuỗi được trích dẫn ba lần) đến tham số doc của rule hoặc attr.*(). Đối với các hàm và macro trợ giúp, hãy sử dụng một chuỗi tài liệu được trích dẫn ba lần theo định dạng được cung cấp tại đây. Các hàm triển khai quy tắc thường không cần chuỗi tài liệu riêng.

Việc sử dụng chuỗi ký tự ở những vị trí dự kiến giúp công cụ tự động dễ dàng trích xuất tài liệu hơn. Bạn có thể thoải mái sử dụng các nhận xét không phải là chuỗi tiêu chuẩn ở bất cứ nơi nào có thể giúp người đọc mã của bạn.