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

Конфигурацию Runium можно задать в файле .runiumrc.json.

Описание

Файл конфигурации .runiumrc.json определяет поведение приложения для текущей рабочей директории.

Т.е., если в текущей рабочей директории есть файл .runiumrc.json, Runium будет его использовать.

Файл позволяет:

• расширить и переопределить настройки из профиля
• задать значения по умолчанию для опций команд

Назначение

Может возникнуть ситуация, когда требуются настройки, минимально отличающиеся от настроек профиля. В таком случае вместо создания нового профиля можно использовать файл конфигурации .runiumrc.json и переопределить только нужные настройки.

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

В файле конфигурации можно указать:

• путь к профилю
• пути к файлам с переменными окружения
• признак режима отладки
• перечень плагинов
• перечень проектов

WARNING

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

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

Например, если в файле конфигурации плагин отключен, то команда runium plugin enable не сможет его включить (он будет включен в профиле, но эффект не будет виден).

Формат

Файл конфигурации имеет четко определенный формат.

{
  "profile": {
    // настройки профиля
  },
  "output": {
    // настройки вывода
  },
  "plugins": {
    // настройки плагинов
  },
  "projects": {
    // настройки проектов
  },
  "env": {
    // настройки переменных окружения
  }
}

TIP

Подробнее о доступных настройках см. в справочнике.

Примеры

Указание пути к профилю.

Позволяет задать путь к профилю, который будет использоваться при запуске приложения.

Отпадает необходимость использования опции --profile при запуске.

{
  "profile": {
    "path": "/path/to/profile"
  }
}

Включение режима отладки.

Позволяет включить режим отладки приложения.

Отпадает необходимость использования опции --debug при запуске.

{
  "output": {
    "debug": true
  }
}

Подключение файла с переменными окружения.

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

Отпадает необходимость использования опции --env при запуске.

{
  "env": {
    "path": ["/path/to/env1.env", "/path/to/env2.env"]
  }
}

Добавление плагина.

Позволяет добавить плагин в список плагинов.

Отпадает необходимость использования команды runium plugin add при настройке профиля.

{
  "plugins": {
    "some-plugin": {
      "path": "@runium/some-plugin"
    }
  }
}

Отключение плагина.

Позволяет отключить плагин в списке плагинов.

Отпадает необходимость использования команды runium plugin disable при настройке профиля.

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

{
  "plugins": {
    "some-plugin": {
      "path": "@runium/some-plugin",
      "disabled": true
    }
  }
}

Добавление проекта.

Позволяет добавить проект в список проектов.

Отпадает необходимость использования команды runium project add при настройке профиля.

Проект будет доступен для запуска командой runium project start some-project.

{
  "projects": {
    "some-project": {
      "path": "/path/to/project/config.json"
    }
  }
}