Skip to content

Commit

Permalink
Documentation.md: add pre-commit hook sample
Browse files Browse the repository at this point in the history
  • Loading branch information
knocte committed Jan 25, 2021
1 parent 6d75fff commit 4e08e5e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -1068,6 +1068,16 @@ Exclusion applies both to formatting and the format checking.

See [CodeFormatter.fsi](../src/Fantomas/CodeFormatter.fsi) to view the public API of Fantomas.

## A git pre-commit hook sample

A very elegant and transparent way to use fantomas is including it in a pre-commit git hook, by creating a `.git/hooks/pre-commit` file with:

```
#!/bin/sh
git diff --cached --name-only --diff-filter=ACM -z | xargs -0 $HOME/.dotnet/tools/fantomas
git diff --cached --name-only --diff-filter=ACM -z | xargs -0 git add
```

## FAKE Helpers

Fantomas also exposes some less official helper functions when formatting code in FAKE scripts.
Expand Down

0 comments on commit 4e08e5e

Please sign in to comment.