Как настроить Prettier для Git?

Для настройки Prettier для Git, вам потребуется выполнить несколько шагов. Prettier - это инструмент форматирования кода, который может использоваться для автоматической стилизации вашего кода в соответствии с выбранными правилами.

Шаг 1: Установка Prettier
Перед настройкой Prettier, убедитесь, что у вас установлена последняя версия Prettier. Для этого выполните следующую команду в командной строке:

npm install --global prettier

Шаг 2: Создание файла .prettierrc
Далее, вы должны создать файл конфигурации Prettier в корневом каталоге вашего проекта. Имя файла должно быть .prettierrc. Этот файл будет содержать настройки форматирования конкретно для вашего проекта.

Пример файл .prettierrc:

{
  "singleQuote": true,
  "trailingComma": "es5",
  "tabWidth": 2
}

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

Шаг 3: Настройка Git Hooks
Чтобы автоматически форматировать код перед коммитом в Git, можно использовать Git Hooks. Git Hooks - это скрипты, которые вызываются в конкретные моменты исполнения Git команд. В нашем случае, мы хотим настроить pre-commit хук.

Создайте скрипт с именем pre-commit в папке .git/hooks и добавьте следующий код в файл:

#!/bin/sh

prettier --write "**/*.{js,jsx,ts,tsx,css,scss,less,json,graphql,md}"
git add .

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

Убедитесь, что скрипт имеет права на исполнение, иначе Git не сможет его вызывать:

chmod +x .git/hooks/pre-commit

Шаг 4: Проверка работы
После выполнения всех шагов, вы можете протестировать настройку, сделав изменения в коде и сделав коммит. При попытке сделать коммит, Git вызовет pre-commit хук, который запустит Prettier для форматирования кода.

Если Prettier обнаружит нарушение форматирования, он выполнит соответствующие изменения и добавит их в индекс Git. Если все файлы успешно отформатированы, коммит будет выполнен.

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