@spec app_path(keyword()) :: Path.t()

回傳組建中的應用程式路徑。

傳回的路徑將會展開。

範例

如果你的專案定義了應用程式 my_app

Mix.Project.app_path()
#=> "/path/to/project/_build/shared/lib/my_app"

@spec apps_paths(keyword()) :: %{optional(atom()) => Path.t()} | nil

回傳一個包含傘式架構子應用程式路徑的對應。

這些路徑基於 :apps_path 和 :apps 組態。

如果給定的專案組態識別出一個傘狀專案，傳回值會是 app => path 的對應，其中 app 是傘狀專案的子應用程式，而 path 是相對於傘狀專案根目錄的路徑。

如果給定的專案組態沒有識別出一個傘狀專案，則會傳回 nil。

範例

Mix.Project.apps_paths()
#=> %{my_app1: "apps/my_app1", my_app2: "apps/my_app2"}

@spec build_path(keyword()) :: Path.t()

回傳給定專案的組建路徑。

建置路徑基於 :build_path 組態 (預設為 "_build") 和一個子目錄建置。子目錄基於兩個因素建置

• 如果設定了 :build_per_environment，子目錄會是 Mix.env/0 的值 (可透過 MIX_ENV 設定)。否則會設定為 "shared"。

• 如果設定了 Mix.target/0 (通常透過 MIX_TARGET 環境變數)，它會用作子目錄的前置詞。

最後，環境變數 MIX_BUILD_ROOT 和 MIX_BUILD_PATH 可用於變更此函式的結果。 MIX_BUILD_ROOT 僅覆寫根目錄 "_build"，同時保持子目錄不變。這可能有助於出於快取原因變更它，通常是在持續整合 (CI) 期間。 MIX_BUILD_PATH 完全覆寫建置路徑，且通常由呼叫 mix CLI 的其他建置工具使用。

命名差異

理想情況下，組態選項 :build_path 會稱為 :build_root，因為它會完全反映環境變數。不過，它的名稱已保留，以維持向後相容性。

範例

Mix.Project.build_path()
#=> "/path/to/project/_build/shared"

如果 :build_per_environment 設為 true，它會為每個環境建立新的建置

Mix.env()
#=> :dev
Mix.Project.build_path()
#=> "/path/to/project/_build/dev"

@spec build_structure(keyword(), keyword()) :: :ok

為給定的應用程式組建專案結構。

選項

• :symlink_ebin - 連結 ebin，而不是複製它

@spec clear_deps_cache() :: :ok

清除目前環境的相依性。

當相依項需要因為全域狀態變更而重新載入時很有用。

例如，Nerves 使用此函式在更新系統環境後強制重新載入所有相依項。它大致如下

1. Nerves 擷取所有相依項，並尋找系統特定相依項
2. 找到系統特定相依項後，它會與環境變數一起載入它
3. 然後，Nerves 清除快取，強制重新載入相依項
4. 相依項會再次載入，現在使用更新的環境環境

@spec compile_path(keyword()) :: Path.t()

回傳給定專案編譯的路徑。

如果未提供組態，則會使用目前專案的組態。

傳回的路徑將會展開。

範例

如果你的專案定義了應用程式 my_app

Mix.Project.compile_path()
#=> "/path/to/project/_build/dev/lib/my_app/ebin"

@spec config() :: keyword()

回傳專案組態。

如果未定義專案，它仍會傳回具有預設值的關鍵字清單。這允許多個 Mix 工作在不需要基礎專案的情況下運作。

請注意，此組態在專案推送到堆疊後會快取。多次呼叫它不會導致它重新運算。

請勿使用 Mix.Project.config/0 尋找執行時期組態。僅使用它來組態專案的各個面向 (例如編譯目錄)，而不是應用程式執行時期。

@spec config_files() :: [Path.t()]

回傳此專案的專案組態檔案清單。

此函式通常用於編譯任務，以在這些組態檔變更時觸發完整重新編譯。

它會傳回鎖定清單，以及 config 目錄中所有不以句點開頭的組態檔（例如 .my_config.exs）。

注意：在 Elixir v1.13.0 之前，mix.exs 檔也包含在組態檔中，但自此之後，它已移至名為 project_file/0 的專屬函式。

@spec config_mtime() :: posix_mtime when posix_mtime: integer()

回傳組態檔案的最新修改時間。

此函式通常用於編譯任務，以在這些組態檔變更時觸發完整重新編譯。因此，會快取 mtime 以避免檔案系統查詢。

注意：在 Elixir v1.13.0 之前，mix.exs 檔也包含在 mtime 中，但現在已不再包含。您可以呼叫 project_file/0 來計算其修改日期。

@spec consolidation_path(keyword()) :: Path.t()

回傳儲存通訊協定合併的路徑。

傳回的路徑將會展開。

範例

如果你的專案定義了應用程式 my_app

Mix.Project.consolidation_path()
#=> "/path/to/project/_build/dev/lib/my_app/consolidated"

在傘狀結構中

Mix.Project.consolidation_path()
#=> "/path/to/project/_build/dev/consolidated"

@spec deps_apps() :: [atom()]

回傳所有相依性應用程式名稱。

保證傳回的順序已排序，以進行適當的相依性解析。例如，如果 A 相依於 B，則 B 會列在 A 之前。

@spec deps_path(keyword()) :: Path.t()

回傳給定專案的相依性儲存路徑。

如果未提供組態，則會使用目前專案的組態。

傳回的路徑將會展開。

範例

Mix.Project.deps_path()
#=> "/path/to/project/deps"

@spec deps_paths(keyword()) :: %{optional(atom()) => Path.t()}

回傳所有相依性的完整路徑，以對應形式呈現。

選項

• :depth - 僅傳回深度層級的相依性，深度為 1 時，僅會傳回頂層相依性
• :parents - 從指定的父項而非應用程式根目錄開始相依性遍歷

範例

Mix.Project.deps_paths()
#=> %{foo: "deps/foo", bar: "custom/path/dep"}

@spec deps_scms(keyword()) :: %{optional(atom()) => Mix.SCM.t()}

回傳所有相依性的 SCM，以對應形式呈現。

請參閱 Mix.SCM 模組文件，以進一步了解 SCM。

選項

• :depth - 僅傳回深度層級的相依性，深度為 1 時，僅會傳回頂層相依性
• :parents - 從指定的父項而非應用程式根目錄開始相依性遍歷

範例

Mix.Project.deps_scms()
#=> %{foo: Mix.SCM.Path, bar: Mix.SCM.Git}

@spec deps_tree(keyword()) :: %{optional(atom()) => [atom()]}

回傳所有相依性的相依性，以對應形式呈現。

選項

• :depth - 僅傳回深度層級的相依性，深度為 1 時，僅會傳回頂層相依性
• :parents - 從指定的父項而非應用程式根目錄開始相依性遍歷

範例

Mix.Project.deps_tree()
#=> %{foo: [:bar, :baz], bar: [], baz: []}

@spec ensure_structure(keyword(), keyword()) :: :ok

確保給定專案的專案結構存在。

如果存在，則為 no-op。否則，將會建置。

opts 是可以傳遞給 build_structure/2 的相同選項。

@spec get() :: module() | nil

如果有一個專案，則擷取目前的專案。

如果沒有目前的專案，則傳回 nil。這可能會發生在目前目錄中沒有 mix.exs 的情況。

如果您預期定義專案，亦即這是目前任務的要求，您應該改為呼叫 get!/0。

@spec get!() :: module()

與 get/0 相同，但如果沒有目前的專案，則會引發例外狀況。

這通常是由需要專案的其他功能的任務呼叫。由於此類任務通常取決於定義的專案，因此此功能會在沒有可用專案的情況下引發 Mix.NoProjectError 例外。

@spec in_project(atom(), Path.t(), keyword(), (module() -> result)) :: result
when result: term()

在給定的專案內執行給定的 fun。

此功能會變更目前工作目錄，並將指定目錄中的專案載入到專案堆疊中。

可以傳遞 post_config，它會合併到專案組態中。

fun 會呼叫指定 Mix.Project 的模組名稱。此功能的傳回值為 fun 的傳回值。

範例

Mix.Project.in_project(:my_app, "/path/to/my_app", fn module ->
  "Mix project is: #{inspect(module)}"
end)
#=> "Mix project is: MyApp.MixProject"

@spec manifest_path(keyword()) :: Path.t()

傳回儲存清單的路徑。

預設情況下，它們儲存在建置目錄內的應用程式路徑中。Umbrella 應用程式會將清單路徑設定為建置目錄的根目錄。目錄可能會在未來的版本中變更。

傳回的路徑將會展開。

範例

如果你的專案定義了應用程式 my_app

Mix.Project.manifest_path()
#=> "/path/to/project/_build/shared/lib/my_app/.mix"

@spec parent_umbrella_project_file() :: binary() | nil

如果有的話，傳回定義父層傘狀專案的檔案路徑。

大部分時間，它會指向 mix.exs 檔案。如果不在專案內或不在傘狀專案內，則傳回 nil。

@spec project_file() :: binary() | nil

傳回定義目前專案的檔案路徑。

大部分時間，它會指向 mix.exs 檔案。如果不在專案內，則傳回 nil。

@spec umbrella?(keyword()) :: boolean()

如果 config 是傘狀專案的組態，則傳回 true。

當不帶任何引數呼叫時，會告知目前的專案是否為傘狀專案。