Tệp MODULE.bazel

Báo cáo sự cố Hằng đêm · 7,3 · 7.2 · 7.1 · 7,0 · 6,5

Các phương thức có trong tệp MODULE.bazel.

Hội viên

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Chỉ định sự phụ thuộc này phải đến từ một tệp lưu trữ (zip, gzip, v.v.) tại một vị trí nhất định, thay vì từ sổ đăng ký. Lệnh này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc, thì các lượt ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Thông số Mô tả
module_name bắt buộc
Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này.
urls string; hoặc Có thể lặp lại của chuỗi; bắt buộc
URL của kho lưu trữ; có thể là URL http(s):// hoặc file://.
integrity giá trị mặc định là ''
Giá trị tổng kiểm dự kiến của tệp lưu trữ, ở định dạng Tính toàn vẹn của tài nguyên phụ.
strip_prefix giá trị mặc định là ''
Tiền tố thư mục để xóa khỏi các tệp đã giải nén.
patches Có thể lặp lại các chuỗi; giá trị mặc định là []
Danh sách các nhãn trỏ đến tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các đề xuất được áp dụng theo thứ tự danh sách.
patch_cmds Có thể lặp lại các chuỗi; giá trị mặc định là []
Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng bản vá.
patch_strip giá trị mặc định là 0
Giống như đối số --strip của bản vá Unix.

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

Khai báo phần phụ thuộc trực tiếp trên một mô-đun Bazel khác.

Tham số

Thông số Mô tả
name bắt buộc
Tên của mô-đun sẽ được thêm dưới dạng phần phụ thuộc trực tiếp.
version giá trị mặc định là ''
Phiên bản của mô-đun cần thêm dưới dạng phần phụ thuộc trực tiếp.
max_compatibility_level giá trị mặc định là -1
compatibility_level tối đa được hỗ trợ để thêm mô-đun dưới dạng phần phụ thuộc trực tiếp. Phiên bản của mô-đun ngụ ý mức tương thích tối thiểu được hỗ trợ cũng như mức tối đa nếu thuộc tính này không được chỉ định.
repo_name giá trị mặc định là ''
Tên của kho lưu trữ bên ngoài thể hiện phần phụ thuộc này. Theo mặc định, tên này là tên của mô-đun.
dev_dependency giá trị mặc định là False
Nếu đúng, phần phụ thuộc này sẽ bị bỏ qua nếu mô-đun hiện tại không phải là mô-đun gốc hoặc `--ignore_dev_Dependencies` được bật.

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')

Chỉ định một phần phụ thuộc phải đến từ một cam kết nhất định của kho lưu trữ Git. Lệnh này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc, thì các lượt ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Thông số Mô tả
module_name bắt buộc
Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này.
remote bắt buộc
URL của kho lưu trữ Git từ xa.
commit giá trị mặc định là ''
Cam kết cần được kiểm tra.
patches Có thể lặp lại các chuỗi; giá trị mặc định là []
Danh sách các nhãn trỏ đến tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các đề xuất được áp dụng theo thứ tự danh sách.
patch_cmds Có thể lặp lại các chuỗi; giá trị mặc định là []
Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng bản vá.
patch_strip giá trị mặc định là 0
Giống như đối số --strip của bản vá Unix.
init_submodules giá trị mặc định là False
Liệu các mô-đun con git trong kho lưu trữ đã tìm nạp có được khởi chạy đệ quy hay không.
strip_prefix giá trị mặc định là ''
Tiền tố thư mục để xóa khỏi các tệp đã giải nén. Bạn có thể dùng tệp này để nhắm mục tiêu một thư mục con của kho lưu trữ git. Xin lưu ý rằng thư mục con phải có tệp "MODULE.bazel" riêng có tên mô-đun giống với đối số "module_name" được chuyển đến "git_override" này.

bao gồm

None include(label)

Bao gồm nội dung của một tệp khác giống MODULE.bazel. Trên thực tế, include() sẽ hoạt động như thể tệp đi kèm được đặt theo văn bản ở vị trí thực hiện lệnh gọi include(), ngoại trừ việc các liên kết biến (chẳng hạn như các liên kết được sử dụng cho use_extension) chỉ hiển thị trong tệp chúng xuất hiện, chứ không xuất hiện trong bất kỳ tệp nào đi kèm hoặc bao gồm.

Chỉ mô-đun gốc mới có thể dùng include(); thì đó là lỗi nếu tệp MODULE của bazel_dep sử dụng include().

Bạn chỉ có thể bao gồm các tệp trong kho lưu trữ chính.

include() cho phép bạn phân đoạn tệp mô-đun gốc thành nhiều phần để tránh có một tệp MODULE.bazel khổng lồ hoặc để quản lý hiệu quả hơn khả năng kiểm soát quyền truy cập cho từng phân đoạn ngữ nghĩa riêng lẻ.

Tham số

Thông số Mô tả
label bắt buộc
Nhãn trỏ đến tệp cần đưa vào. Nhãn phải trỏ đến một tệp trong kho lưu trữ chính; nói cách khác, đường dẫn liên kết này phải bắt đầu bằng dấu gạch chéo đôi (//).

local_path_override

None local_path_override(module_name, path)

Chỉ định một phần phụ thuộc phải đến từ một thư mục nhất định trên ổ đĩa cục bộ. Lệnh này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc, thì các lượt ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Thông số Mô tả
module_name bắt buộc
Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này.
path bắt buộc
Đường dẫn đến thư mục chứa mô-đun này.

mô-đun

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

Khai báo một số thuộc tính của mô-đun Bazel được biểu thị bằng kho lưu trữ Bazel hiện tại. Các thuộc tính này có thể là siêu dữ liệu thiết yếu của mô-đun (chẳng hạn như tên và phiên bản) hoặc ảnh hưởng đến hành vi của mô-đun hiện tại và các phần phụ thuộc.

Bạn nên gọi lệnh này tối đa một lần và nếu được gọi, thì đó phải là lệnh đầu tiên trong tệp MODULE.bazel. Chỉ có thể bỏ qua nếu mô-đun này là mô-đun gốc (như trong, nếu mô-đun không bị phụ thuộc bởi một mô-đun khác).

Tham số

Thông số Mô tả
name giá trị mặc định là ''
Tên của mô-đun. Chỉ có thể bỏ qua nếu mô-đun này là mô-đun gốc (như trong, nếu mô-đun không bị phụ thuộc bởi một mô-đun khác). Tên mô-đun hợp lệ phải: 1) chỉ chứa chữ thường (a-z), chữ số (0-9), dấu chấm (.), dấu gạch nối (-) và dấu gạch dưới (_); 2) bắt đầu bằng một chữ cái viết thường; 3) kết thúc bằng một chữ cái hoặc chữ số viết thường.
version giá trị mặc định là ''
Phiên bản của mô-đun. Chỉ có thể bỏ qua nếu mô-đun này là mô-đun gốc (như trong, nếu mô-đun không bị phụ thuộc bởi một mô-đun khác). Phiên bản phải ở định dạng SemVer thoải mái; hãy xem tài liệu để biết thêm chi tiết.
compatibility_level giá trị mặc định là 0
Mức độ tương thích của mô-đun; mã này phải được thay đổi mỗi khi có thay đổi lớn không tương thích. Đây về cơ bản là "phiên bản chính" của mô-đun theo SemVer, ngoại trừ việc mô-đun không được nhúng vào chuỗi phiên bản mà tồn tại dưới dạng một trường riêng biệt. Các mô-đun có mức độ tương thích khác nhau sẽ tham gia vào quá trình phân giải phiên bản như thể đó là các mô-đun có tên khác nhau, nhưng biểu đồ phần phụ thuộc cuối cùng không được chứa nhiều mô-đun có cùng tên nhưng khác mức độ tương thích (trừ phi multiple_version_override có hiệu lực). Hãy xem tài liệu để biết thêm chi tiết.
repo_name giá trị mặc định là ''
Tên của kho lưu trữ đại diện cho mô-đun này, như được nhìn thấy bởi chính mô-đun. Theo mặc định, tên của kho lưu trữ là tên của mô-đun. Bạn có thể chỉ định việc này để dễ dàng di chuyển các dự án đang sử dụng tên kho lưu trữ khác với tên mô-đun.
bazel_compatibility Có thể lặp lại các chuỗi; giá trị mặc định là []
Danh sách các phiên bản Bazel cho phép người dùng khai báo phiên bản Bazel nào tương thích với mô-đun này. Việc này KHÔNG ảnh hưởng đến việc giải quyết phần phụ thuộc, nhưng bzlmod sẽ sử dụng thông tin này để kiểm tra xem phiên bản Bazel hiện tại của bạn có tương thích hay không. Định dạng của giá trị này là một chuỗi gồm một số giá trị ràng buộc được phân tách bằng dấu phẩy. Có 3 điều kiện ràng buộc được hỗ trợ: <=X.X.X: Phiên bản Bazel phải bằng hoặc cũ hơn X.X.X. Được dùng khi có thay đổi đã biết là không tương thích trong phiên bản mới hơn. >=X.X.X: Phiên bản Bazel phải bằng hoặc mới hơn phiên bản X.X.X.Dùng khi bạn phụ thuộc vào một số tính năng chỉ có từ phiên bản X.X.X. -X.X.X: Phiên bản Bazel X.X.X không tương thích. Dùng khi xảy ra lỗi trong X.X.X khiến bạn gặp lỗi nhưng đã được khắc phục trong các phiên bản sau này.

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

Chỉ định rằng một phần phụ thuộc vẫn phải đến từ sổ đăng ký nhưng nhiều phiên bản của phần phụ thuộc đó phải được phép cùng tồn tại. Hãy xem tài liệu để biết thêm chi tiết. Lệnh này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc, thì các lượt ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Thông số Mô tả
module_name bắt buộc
Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này.
versions Có thể lặp lại các chuỗi; bắt buộc
Chỉ định rõ ràng các phiên bản được phép cùng tồn tại. Các phiên bản này phải có sẵn trong quá trình lựa chọn trước biểu đồ phần phụ thuộc. Các phần phụ thuộc trên mô-đun này sẽ được "nâng cấp" lên phiên bản cao hơn được phép gần nhất ở cùng mức độ tương thích, trong khi các phần phụ thuộc có phiên bản cao hơn bất kỳ phiên bản nào được cho phép ở cùng mức độ tương thích sẽ gây ra lỗi.
registry giá trị mặc định là ''
Ghi đè sổ đăng ký cho mô-đun này; thay vì tìm mô-đun này từ danh sách sổ đăng ký mặc định, bạn nên sử dụng sổ đăng ký cụ thể.

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

Chỉ định các nền tảng thực thi đã xác định sẽ được đăng ký khi mô-đun này được chọn. Phải là mẫu mục tiêu tuyệt đối (ví dụ: bắt đầu bằng @ hoặc //). Xem bài viết giải quyết chuỗi công cụ để biết thêm thông tin.

Tham số

Thông số Mô tả
dev_dependency giá trị mặc định là False
Nếu giá trị là true, các nền tảng thực thi sẽ không được đăng ký nếu mô-đun hiện tại không phải là mô-đun gốc hoặc lệnh "--ignore_dev_Dependencies" được bật.
platform_labels trình tự của chuỗi; bắt buộc
Nhãn của các nền tảng mà bạn muốn đăng ký.

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

Chỉ định các chuỗi công cụ đã xác định sẽ được đăng ký khi mô-đun này được chọn. Phải là mẫu mục tiêu tuyệt đối (ví dụ: bắt đầu bằng @ hoặc //). Xem bài viết giải quyết chuỗi công cụ để biết thêm thông tin.

Tham số

Thông số Mô tả
dev_dependency giá trị mặc định là False
Nếu giá trị là true, chuỗi công cụ sẽ không được đăng ký nếu mô-đun hiện tại không phải là mô-đun gốc hoặc lệnh "--ignore_dev_Dependencies" được bật.
toolchain_labels trình tự của chuỗi; bắt buộc
Nhãn của các chuỗi công cụ cần đăng ký. Các nhãn có thể bao gồm :all, trong trường hợp đó, tất cả các mục tiêu cung cấp chuỗi công cụ trong gói sẽ được đăng ký theo thứ tự từ điển học theo tên.

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

Chỉ định rằng phần phụ thuộc vẫn phải đến từ sổ đăng ký, nhưng phiên bản của phần phụ thuộc phải được ghim hoặc sổ đăng ký bị ghi đè, hoặc danh sách bản vá được áp dụng. Lệnh này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc, thì các lượt ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Thông số Mô tả
module_name bắt buộc
Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này.
version giá trị mặc định là ''
Ghi đè phiên bản đã khai báo của mô-đun này trong biểu đồ phần phụ thuộc. Nói cách khác, mô-đun này sẽ được "ghim" cho phiên bản ghi đè này. Bạn có thể bỏ qua thuộc tính này nếu tất cả những gì muốn ghi đè là sổ đăng ký hoặc bản vá.
registry giá trị mặc định là ''
Ghi đè sổ đăng ký cho mô-đun này; thay vì tìm mô-đun này từ danh sách sổ đăng ký mặc định, bạn nên sử dụng sổ đăng ký cụ thể.
patches Có thể lặp lại các chuỗi; giá trị mặc định là []
Danh sách các nhãn trỏ đến tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các đề xuất được áp dụng theo thứ tự danh sách.
patch_cmds Có thể lặp lại các chuỗi; giá trị mặc định là []
Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng bản vá.
patch_strip giá trị mặc định là 0
Giống như đối số --strip của bản vá Unix.

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

Trả về đối tượng proxy đại diện cho một tiện ích mô-đun; các phương thức của nó có thể được gọi để tạo thẻ mở rộng mô-đun.

Tham số

Thông số Mô tả
extension_bzl_file bắt buộc
Nhãn cho tệp Starlark xác định đuôi mô-đun.
extension_name bắt buộc
Tên của tiện ích mô-đun sẽ sử dụng. Biểu tượng có tên này phải được tệp Starlark xuất.
dev_dependency giá trị mặc định là False
Nếu đúng, việc sử dụng tiện ích mô-đun này sẽ bị bỏ qua nếu mô-đun hiện tại không phải là mô-đun gốc hoặc "--ignore_dev_Dependency" được bật.
isolate giá trị mặc định là False
Thử nghiệm. Thông số này đang trong giai đoạn thử nghiệm và có thể thay đổi bất cứ lúc nào. Vui lòng đừng phụ thuộc vào tính năng này. Bạn có thể bật tính năng này trên cơ sở thử nghiệm bằng cách đặt ---experimental_isolated_extension_usages
Nếu đúng, việc sử dụng tiện ích mô-đun này sẽ được tách biệt với tất cả cách sử dụng khác, cả trong mô-đun này và các mô-đun khác. Các thẻ được tạo cho mục đích sử dụng này không ảnh hưởng đến những trường hợp sử dụng khác, đồng thời kho lưu trữ do tiện ích tạo cho mục đích sử dụng này sẽ khác biệt với tất cả kho lưu trữ khác do tiện ích tạo.

Tham số này hiện đang trong giai đoạn thử nghiệm và chỉ dùng được với cờ --experimental_isolated_extension_usages.

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Nhập một hoặc nhiều kho lưu trữ được tạo bởi tiện ích mô-đun nhất định vào phạm vi của mô-đun hiện tại.

Tham số

Thông số Mô tả
extension_proxy bắt buộc
Đối tượng proxy mở rộng mô-đun do lệnh gọi use_extension trả về.
args bắt buộc
Tên của các kho lưu trữ cần nhập.
kwargs bắt buộc
Chỉ định một số kho lưu trữ nhất định cần nhập vào phạm vi của mô-đun hiện tại bằng các tên khác. Khoá phải là tên để sử dụng trong phạm vi hiện tại, trong khi các giá trị phải là tên gốc mà tiện ích mô-đun xuất.

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

Trả về giá trị proxy có thể được gọi trực tiếp trong tệp MODULE.bazel dưới dạng quy tắc kho lưu trữ, một hoặc nhiều lần. Các kho lưu trữ được tạo theo cách đó chỉ hiển thị với mô-đun hiện tại, dưới tên được khai báo bằng thuộc tính name trên proxy. Thuộc tính Boolean dev_dependency ngầm ẩn cũng có thể được dùng trên proxy để biểu thị rằng một repo nhất định chỉ được tạo khi mô-đun hiện tại là mô-đun gốc.

Tham số

Thông số Mô tả
repo_rule_bzl_file bắt buộc
Nhãn cho tệp Starlark xác định quy tắc kho lưu trữ.
repo_rule_name bắt buộc
Tên của quy tắc kho lưu trữ sẽ sử dụng. Biểu tượng có tên này phải được tệp Starlark xuất.