本機存放區規則

回報問題 查看原始碼 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

下列函式可從 @bazel_tools//tools/build_defs/repo:local.bzl 載入。

將本機檔案系統中的目錄做為存放區使用的規則。

設定

如要在模組擴充功能中使用這些規則,請在 .bzl 檔案中載入這些規則,然後從擴充功能的實作函式呼叫這些規則。舉例來說,如要使用 local_repository

load("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository")

def _my_extension_impl(mctx):
  local_repository(name = "foo", path = "foo")

my_extension = module_extension(implementation = _my_extension_impl)

或者,您也可以直接在 MODULE.bazel 檔案中使用 use_repo_rule 呼叫這些存放區規則:

local_repository = use_repo_rule("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository")
local_repository(name = "foo", path = "foo")

local_repository

local_repository(name, path, repo_mapping)

將已包含 Bazel 檔案的本機目錄設為存放區。這個目錄應已包含 Bazel BUILD 檔案和一個存放區邊界檔案。如果不包含這些檔案,建議改用 <a href="#new_local_repository"><code>new_local_repository</code></a>。

屬性

name 名稱 (必填)

這個存放區的專屬名稱。

path 字串;必要

要提供做為存放區的目錄路徑。

路徑可以是絕對路徑,也可以是相對於工作區根目錄的相對路徑。

repo_mapping 字典:字串 -> 字串;必要

從本機存放區名稱到全域存放區名稱的字典。這樣就能控管此存放區依附元件的依附元件解析工作區。

舉例來說,如果有個項目 `"@foo": "@bar"`,表示這個存放區每次依賴 `@foo` 時 (例如依賴 `@foo//some:target`),實際上應在全域宣告的 `@bar` (`@bar//some:target`) 中解析該依附元件。

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping)

將不含 Bazel 檔案的本機目錄設為可用版本庫。這個目錄不需要包含 Bazel BUILD 檔案或存放區邊界檔案,因為這些檔案會由這個存放區規則建立。如果目錄中已包含 Bazel 檔案,建議改用 <a href="#local_repository"><code>local_repository</code></a>。

屬性

name 名稱;必填

此存放區的專屬名稱。

build_file 標籤 (選用)

這個檔案會用於做為本存放區的 BUILD 檔案。

必須指定 build_filebuild_file_content 其中之一。

這個標籤所指向的檔案名稱不必是 BUILD,但可以是 BUILD。BUILD.new-repo-name 之類的名稱可能會與實際的 BUILD 檔案有所區別。

build_file_content String; 選用

要為此存放區建立的 BUILD 檔案內容。

必須指定 build_filebuild_file_content 其中一個。

path 字串;必填

要提供做為存放區的目錄路徑。

路徑可以是絕對路徑,也可以是工作區根目錄的相對路徑。

repo_mapping 字典:字串 -> 字串;必要

從本機存放區名稱到全域存放區名稱的字典。這樣就能控管此存放區依附元件的依附元件解析工作區。

舉例來說,項目 `"@foo": "@bar"` 會宣告,每當這個存放區在任何情況下都依賴 `@foo` (例如對 `@foo//some:target` 上的依附元件),實際上應在全域宣告的 `@bar` (`@bar//some:target`) 中解析該依附元件。