При выполнении любого проекта кодирования чистота синтаксиса кода может быть очень важна. От того, насколько аккуратна кодовая база, часто зависит, насколько легко ее прочитать и понять. Это особенно верно при работе в составе группы, где необходимо соблюдать согласованный набор правил форматирования. В этом блоге я покажу вам, как использовать инструмент под названием Prettier (https://prettier.io/docs/en/index.html) вместе с предварительной фиксацией (https://pre-commit.com /), чтобы настроить автоматическое форматирование кода перед его фиксацией в репозиторий Git. Это будет означать, что весь зафиксированный код будет отформатирован на основе указанных вами правил.

Для включения этих функций необходимо выполнить следующие шаги:

Шаг 1. Установите предварительную фиксацию с помощью одной из следующих команд:
brew install pre-commit (только в macOS) или pip install pre-commit

Шаг 2: Затем вам нужно создать файл конфигурации (.pre-commit-config.yaml) в корневом каталоге вашего проекта, в котором pre-commit указывает, какие инструменты вы хотите запустить, и любые соответствующие параметры. Файл состоит из определения любых внешних репозиториев, которые вы хотите включить вместе с версией, а затем перечисляет все хуки, которые вы хотите настроить. В нашем случае мы настраиваем один для Prettier. Фрагмент кода ниже показывает пример такого файла:

- repo: https://github.com/prettier/prettier 
  rev: 1.18.2 hooks: 
  — id: prettier 
    files: 'src/*'
    exclude_types: ['png']

Параметр files позволяет указать, на какие файлы/каталоги вы хотите воздействовать хуком, а параметр exclude_types позволяет исключить некоторые типы файлов, которые вы не хотите форматировать, например файлы изображений. Другие параметры также могут быть добавлены, как определено на https://pre-commit.com/.

Шаг 3: Если вы просто используете указанный выше файл конфигурации в одиночку, будут использоваться параметры форматирования по умолчанию, которые поставляются с Prettier. Чтобы добавить пользовательские настройки, например, выбрать, сколько пробелов составляет вкладка, вам необходимо создать файл конфигурации .prettierrc. По следующей ссылке подробно описано, как его создать: https://prettier.io/docs/en/configuration.html.

Шаг 4: Затем, чтобы установить файлы конфигурации, определенные выше, из корневого каталога выполните следующую команду: pre-commit install .

Шаг 5. После завершения установки вы можете добавить любые измененные файлы вместе с файлами конфигурации в промежуточную область Git с помощью команды
git add <files>.

Шаг 6: Затем вам нужно зафиксировать код, который вы только что добавили в промежуточную область, с помощью команды git commit -m <your message>. Эта команда должна привести к одному из трех выходных сообщений через несколько секунд:

  1. Пропущено — это означает, что файлов для проверки не нашлось и дальнейших действий не требуется.
  2. Пройдено — это означает, что файлы были проверены и никаких изменений в форматировании вносить не нужно. Никаких дальнейших действий не требуется.
  3. Ошибка — это означает, что некоторые изменения форматирования должны были быть внесены и автоматически применены к различным файлам. Затем будет предоставлен список соответствующих файлов. Чтобы продолжить, пользователь должен убедиться, что он доволен изменениями форматирования, прочитать и повторно подтвердить код. На этот раз проверки должны пройти.

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

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