Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation.md: add pre-commit hook sample #1392

Merged
merged 3 commits into from
Jan 27, 2021
Merged

Documentation.md: add pre-commit hook sample #1392

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e08e5e
Documentation.md: add pre-commit hook sample
knocte Jan 25, 2021
3b87434
Add fair warning
nojaf Jan 26, 2021
8547fec
Merge branch 'master' into patch-5
nojaf Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/Documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1068,6 +1068,20 @@ 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
```

<small>This script assumes you have installed Fantomas globally as a [dotnet tool](https://www.nuget.org/packages/fantomas-tool/)</small>

**Please use with caution** as [Fantomas is not without bugs](https://github.com/fsprojects/fantomas/issues?q=is%3Aissue+is%3Aopen+label%3A%22bug+%28soundness%29%22).

## FAKE Helpers

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