lefthook

Менеджер Git Hooks для Node.js, Ruby, Python и многих других типов проектов.

• Быстрый. Это написано в ходе. Может запустить команды параллельно.
• Мощный. Это позволяет управлять выполнением и файлами, которые вы передаете в свои команды.
• Простой. Это единственный двоичный файл без зависимости, который может работать в любой среде.

Документация

Прочитайте вводное сообщение

Установить

С Go (> = 1,23):

go install github.com/evilmartians/lefthook@latest

С NPM :

npm install lefthook --save-dev

Для Руби :

gem install lefthook

Для Python :

pip install lefthook

Руководство по установке с большим количеством способов установить левша: APT, BREW, WINGET и другие.

Использование

Настройте свои крючки, установите их один раз и забудьте об этом: полагаться на магию внизу.

TL; DR

 # Configure your hooks
vim lefthook.yml

# Install them to the git project
lefthook install

# Enjoy your work with git
git add -A && git commit -m ' ... ' 

Более подробная информация

• Конфигурация для параметров конфигурации lefthook.yml .
• Использование для вариантов CLI Lefthook , поддержанных ENVS и советов по использованию.
• Обсуждения по вопросам, идеям, предложениям.

Почему левша

• Параллельное исполнение

Дает вам больше скорости. док

 pre-push :
  parallel : true

• Гибкий список файлов

Если вы хотите свой собственный список. Пользовательские и предварительные примеры.

 pre-commit :
  commands :
    frontend-linter :
      run : yarn eslint {staged_files}
    backend-linter :
      run : bundle exec rubocop --force-exclusion {all_files}
    frontend-style :
      files : git diff --name-only HEAD @{push}
      run : yarn stylelint {files}

• Фильтры глобального и режима

Если вы хотите отфильтровать список файлов. Вы могли бы найти больше примеров шаблона глобуса здесь.

 pre-commit :
  commands :
    backend-linter :
      glob : " *.rb " # glob filter
      exclude : ' (^|/)(application|routes).rb$ ' # regexp filter
      run : bundle exec rubocop --force-exclusion {all_files}

• Выполнить в подчинке

Если вы хотите выполнить команды в относительном пути

 pre-commit :
  commands :
    backend-linter :
      root : " api/ " # Careful to have only trailing slash
      glob : " *.rb " # glob filter
      run : bundle exec rubocop {all_files}

• Запустить сценарии

Если команд Oneline недостаточно, вы можете выполнить файлы. док

 commit-msg :
  scripts :
    " template_checker " :
      runner : bash

• Теги

Если вы хотите контролировать группу команд. док

 pre-push :
  commands :
    packages-audit :
      tags :
        - frontend
        - linters
      run : yarn lint
    gems-audit :
      tags :
        - backend
        - security
      run : bundle audit

• Поддержка Docker

Если вы находитесь в среде Docker. док

 pre-commit :
  scripts :
    " good_job.js " :
      runner : docker run -it --rm <container_id_or_name> {cmd}

• Локальная конфигурация

Если вы являетесь разработчиком Frontend/Backend и хотите пропустить ненужные команды или переопределить что -то в Docker. док

 # lefthook-local.yml
pre-push :
  exclude_tags :
    - frontend
  commands :
    packages-audit :
      skip : true

• Прямой контроль

Если вы хотите запустить группу крючков напрямую.

$ lefthook run pre-commit

• Ваши собственные задачи

Если вы хотите запустить определенную группу команд напрямую.

 fixer :
  commands :
    ruby-fixer :
      run : bundle exec rubocop --force-exclusion --safe-auto-correct {staged_files}
    js-fixer :
      run : yarn eslint --fix {staged_files} 

$ lefthook run fixer

• Управление выводом

Вы можете контролировать то, что напечатает Lefthook с опцией вывода.

 output :
  - execution
  - failure

---

Гиды

• Установите с Node.js
• Установите с помощью Ruby
• Установите с Homebrew
• Установите с Winget
• Установить для Linux на основе Debian
• Установить для Linux на основе RPM
• Установить для Arch Linux
• Установите для Alpine Linux
• Использование
• Конфигурация

Примеры

Проверьте примеры

Статьи

• 5 прохладных (и удивительных) способов настройки левша для автоматизации радости
• Левша: сбить код вашей команды обратно в форму
• Левша + хрустальбол
• Поддерживая документацию OSS под контролем с DocSify, Lefthook и друзьями
• Автоматическое снятие контейнеров Docker
• Плавные обновления PostgreSQL в средах DockerDev с левтом
• Левша для нативных приложений React/React