Характеристики

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

Возвращает путь к приложению внутри сборки.

Возвращаемый путь будет расширен.

Примеры

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

Характеристики

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"}

Характеристики

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

Возвращает путь сборки для данного проекта.

Если конфигурация не задана, используется конфигурация текущего проекта.

Возвращаемый путь будет расширен.

Примеры

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"

Характеристики

build_structure(keyword(), keyword()) :: :ok

Создает структуру проекта для данного приложения.

Параметры

• :symlink_ebin — создание символической ссылки ebin вместо копирования

Характеристики

clear_deps_cache() :: :ok

Очищает кэш зависимостей для текущего окружения.

Полезно, когда зависимости нужно перезагрузить из-за изменения глобального состояния.

Например, Nerves использует эту функцию для принудительной перезагрузки всех зависимостей после обновления системной среды. Общий процесс выглядит так:

1. Nerves загружает все зависимости и ищет зависимости, специфичные для системы
2. Найдя зависимость, специфичную для системы, она загружает ее вместе с переменными среды
3. Nerves очищает кэш, принуждая перезагрузить зависимости
4. Зависимости загружаются снова, теперь с обновлённой переменной среды

Характеристики

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

Возвращает пути, к которым компилируется данный проект.

Если конфигурация не задана, используется конфигурация текущего проекта.

Возвращаемый путь будет расширен.

Примеры

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

Характеристики

config() :: keyword()

Возвращает конфигурацию проекта.

Если проект не определен, возвращается список ключевых слов со значениями по умолчанию. Это позволяет многим задачам Mix работать без необходимости в базовом проекте.

Обратите внимание, что эта конфигурация кэшируется после добавления проекта в стек. Ее вызов несколько раз не приведет к повторному вычислению.

Не используйте Mix.Project.config/0 для поиска конфигурации во время выполнения. Используйте его только для настройки аспектов вашего проекта (например, каталогов компиляции), а не конфигурации вашего приложения во время выполнения.

Характеристики

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

Возвращает список файлов конфигурации проекта для этого проекта.

Эта функция обычно используется в задачах компиляции, чтобы инициировать полную перекомпиляцию при изменении таких файлов конфигурации.

Она возвращает файл mix.exs, манифест блокировки и все файлы конфигурации в каталоге config, которые не начинаются с точки (например, .my_config.exs).

Характеристики

config_mtime() :: posix_mtime when posix_mtime: integer()

Возвращает последнее время изменения файлов конфигурации.

Эта функция обычно используется в задачах компиляции для запуска полной перекомпиляции при изменении таких файлов конфигурации. По этой причине mtime кэшируется, чтобы избежать запросов к файловой системе.

Характеристики

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

Возвращает путь, где хранятся консолидации протоколов.

Возвращаемый путь будет расширен.

Примеры

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

Внутри проектов-«зонтиков»:

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

Характеристики

deps_apps() :: [atom()]

Возвращает все имена приложений-зависимостей.

Порядок, в котором они возвращаются, гарантированно отсортирован для правильного разрешения зависимостей. Например, если A зависит от B, то B будет указан до A.

Характеристики

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

Возвращает путь, где хранятся зависимости для данного проекта.

Если конфигурация не задана, используется конфигурация текущего проекта.

Возвращаемый путь будет расширен.

Примеры

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

Характеристики

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

Возвращает полный путь всех зависимостей в виде карты.

Параметры

• :depth — возвращает только зависимости до заданного уровня вложенности; глубина 1 вернёт только зависимости верхнего уровня
• :parents — начинает обход зависимостей с указанных родителей вместо корня приложения

Примеры

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

Характеристики

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}

Характеристики

ensure_structure(keyword(), keyword()) :: :ok

Обеспечивает существование структуры проекта для данного проекта.

В случае если структура уже существует, это ничто. В противном случае она создается.

Характеристики

get() :: module() | nil

Возвращает текущий проект, если он есть.

Если текущего проекта нет, возвращается nil. Это может произойти в тех случаях, когда в текущем каталоге нет mix.exs.

Если ожидается, что проект будет определен, т. е. это требование текущей задачи, следует вызвать get!/0 вместо этого.

Характеристики

get!() :: module()

То же, что и get/0, но вызывает исключение, если текущего проекта нет.

Это обычно вызывается задачами, которым требуются дополнительные функции для определения проекта. Поскольку такие задачи обычно зависят от определения проекта, эта функция вызывает исключение Mix.NoProjectError, если проект недоступен.

Характеристики

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"

Характеристики

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

Возвращает путь к хранению манифестов.

По умолчанию они хранятся в пути приложения внутри каталога сборки. В приложениях-зонтиках путь к манифесту устанавливается в корень каталога сборки. Пути могут быть изменены в будущих версиях.

Возвращаемый путь будет расширен.

Примеры

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

Характеристики

umbrella?(keyword()) :: boolean()

Возвращает true если config является конфигурацией проекта-зонтика.

При вызове без аргументов указывает, является ли текущий проект проектом-зонтиком.