devanych/yii-location-of-default-configs.md

## yii-location-of-default-configs.md

      
    Raw
  

              yii-location-of-default-configs.md
            
          
    Варианты расположения дефолтных конфигурационных файлов


Issue: yiisoft/config#72

В текущей реализации все дефолтные конфигурационные файлы, которые расположены в вендоре в соответствующих пакетах,
копируются в приложение автоматически при установке приложения (composer <create-project|install|update>).
Таким образом все конфигурации пакетов контролирует пользователь.
Предлагается не копировать конфигурации в приложение, а оставлять их в вендоре. Если же пользователю нужно будет
переопределить конфигурацию пакета, то он скопирует файлы из вендора (используя консольную команду)
в приложение и переопределит. Команда будет выглядеть следующим образом:
// Копировать конфигурацию одного пакета.
composer yii-config-copy yiisoft/aliases

// Копировать конфигурации нескольких пакетов.
composer yii-config-copy yiisoft/aliases yiisoft/view

Текущая реализация

Плюсы:

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

"Игнорировать, ничего не делать."
"Заменить локальную версию файла новой версией."
"Скопировать новую версию файла с постфиксом .dist."
"Вывести diff-файлов в консоль."


Минусы:

Большое количество файлов конфигураций в приложении.
Все дефолтные файлы конфигураций хранятся в приложении и визуально не понятно, что в приложении
сконфигурировано кастомно (для этого нужно вызвать composer config-diff).

Предлагаемая реализация

Плюсы:

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

Минусы:

Меньше контроля над файлами.

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


Альтернативная реализация


PR: yiisoft/config#81

Глобальные зменения:

Все дефолтные конфигурационные файлы находятся в вендоре, а в приложении только переопределенные.
Добавлена команда yii-config-copy для копирования конфигурационных файлов из вендора в приложение.
Добавлена команда yii-config-rebuild для обновления плана слияния.
Удален параметр output-directory, осталась только source-directory для всех пакетов.
Удален весь интерактив и отслеживание изменений файлов.
Удалена папка config/packages и файл dist.loc.
План слияния перенесен в папку config.

Конфигурации загружаются следующим образом:

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

Полноценного слияния также не происходит. Существует три слоя: пакеты из вендора, корневой пакет (приложение) и
окружения приложения. Одинаковые ключи могут быть в разных слоях, но если в пакетах из вендора или корневой пакете,
или в окружениях приложения есть совпадение ключей, то будет брошено исключение о дубликате ключей.
В текущей реализации в подавляющем большинстве, нужно переопределить один ключ, в логгере например, это реализация
Psr\Log\LoggerInterface, из-за этого в приложение копируется все конфиг-файлы пакета. В альтернативной реализации,
он может в любом конфиг-файле приложения переопределить только реализацию интерфейса, а все остальное подтянется
из вендора.
При таком подходе у пользователя практически нет ограничений не в чем. Он сможет создать любую структуру папок.
Пользователь может копировать куски кода вручную (как в Yii2 было) или использовать команду. Работать будет и так и так.
Команда копирования

Команда копирует файлы конфигурации пакета от поставщика в каталог конфигурации корневого пакета (приложения):
composer yii-config-copy <package-name> [target-path] [files]
Копирует все файлы конфигурации пакета yiisoft/view:
# To the `config` directory
composer yii-config-copy yiisoft/view

# To the `config/my/path` directory
composer yii-config-copy yiisoft/view my/path
Копирует указанные файлы конфигурации пакета yiisoft/view:
# To the `config` directory
composer yii-config-copy yiisoft/view / params.php web.php

# To the `config/my/path` directory and without the file extension
composer yii-config-copy yiisoft/view my/path params web
Чтобы избежать конфликтов с именами файлов, к именам скопированных файлов добавляется префикс:
yiisoft-view-params.php, yiisoft-view-web.php.
Команда обновления плана слияния

Команда обходит все файлы конфигурации и обновляет файл плана слияния. Это может потребоваться, если в структуру файлов
конфигураций приложения добавлены файлы или папки, которые не были указаны в composer.json корневого пакета.
Необходимо добавить в информацию о новых файлах в composer.json корневого пакета и вызвать команду:
composer yii-config-rebuild