Консольный интерфейс

Как и многие другие утилиты для сборки проектов, YDA запускается с помощью консоли, при этом необходимо предварительно заполнить файл конфигурации (обычно это yda.config.yaml). На данный момент консольный интерфейс YDA предельно прост — 1 команда, 3 опции, при этом 1 обязательная.

Вызов из консоли утилиты YDA начинается с yda, что вполне логично. При этом, как и в случае с другими консольными утилитами, одной только установки YDA в проект (обычно с помощью команды npm install @yamato-daiwa/automation -D) недостаточно для того, чтобы такие терминалы как CMD или PowerShell распознали команду yda. Здесь часто предлагают выполнить глобальную установку (npm install с флагом -g), но в то же время такой тип установки часто не рекомендуется, поскольку одна зависимость на несколько проектов может стать причиной будущих проблем, таких как потребность в разных версиях. Куда более лучший вариант — вызов yda посредством npm-скриптов, объявленных в файле package.json проекта:

{
  "private": true,
  "scripts": {
    "build": "yda build --mode PRODUCTION"
  },
  "devDependencies": {
    "@yamato-daiwa/automation": "0.7.0"
  }
}

При наличии файла package.json с приведённым выше содержимым и установленных npm-зависимостях, сборку проекта можно запустить командой, npm run build, при этом npm знает, что утилиту yda надо искать ниже node_modules.

Основная команда утилиты

Команда build является командой по умолчанию, а потому yda build можно сократить до yda, при этом необходимо указать как минимум 1 опцию — --mode, например:

yda --mode PRODUCTION

Опции

На данный момент предлагается всего 3, при этом 1 из них — --mode — обязательная. Довольно часто используется опция selectiveExecution, а configurationFile — разве только в случае, если Вас не устраивает имя файла конфигурации по умолчанию — yda.config.yaml.

mode — Режим сборки проекта

Используется для указания режима сборки проекта. Поскольку в YDA отсутствует режим сборки проекта по умолчанию, то данная опция является обязательной. Значением опции может быть только один из следующих вариантов:

STATIC_PREVIEW

Режим статического превью

LOCAL_DEVELOPMENT

Режим локальной разработки

TESTING

Режим тестирования

STAGING

Режим инсценировки (стэйджинг)

PRODUCTION

Режим эксплуатации (продакшен)

Возможно использование сокращения -m вместо ключа опции --mode:

yda -m PRODUCTION

selectiveExecution — Выборочное выполнение

Используется для указания выборочного выполнения , при этом для корректной сборки проекта указанный идентификатор выборочного выполнения должен быть предварительно объявлен в файле конфигурации (обычно это yda.config.yaml).

yda --selectingExecution application --mode PRODUCTION

• Поскольку для средних и больших проектов наличие выборочных выполнений является нормой, то данная опция хотя и необязательная, но довольно популярная.
• Возможно использование сокращения -s вместо ключа опции --selectiveExecution:

yda -s application -m PRODUCTION

configurationFile — Файл конфигурации

Если Вас по какой-либо причине не устраивает имя файла конфигурации по умолчанию (yda.config.yaml или yda.config.yml), то при запуске YDA необходимо указать желаемое имя файла с помощью опции --configurationFile (сокращение: -c):

yda --mode PRODUCTION --configurationFile yda.yaml