Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.03 KB

readme.md

File metadata and controls

27 lines (18 loc) · 1.03 KB
Raw

git-hooks

git hooks for developing on unix like systems

pre-commit

For documentation on pre-commit, visit the website.

Dependencies

  • shellcheck
  • uncrustify

Quick Start

Copy example.pre-commit-config.yaml from this repo to the new project, edit as necessary, then follow standard pre-commit practices. Additional pre-commit hooks can be found here.

Note: The example file has all hooks in this repo enabled, make sure to disable hooks that are not required.

Supported Hooks

  • pretty-c - Make C source pretty
  • pretty-shell - Make shell scripts pretty
  • tab-fixer - Replace all tabs with spaces
  • windows-encoding-fixer - Replace Windows encoded files with UTF-8 encoded files

Configuration

pretty-c

pretty-c uses uncrustify at its core. In order to use the pretty-c hook, create a file called .uncrustify in the root of the project directory and fill it with the desired uncrustify configuration.