-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.md
58 lines (37 loc) · 2.32 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
fix-whitespace: Fixes whitespace issues
=======================================
[](http://hackage.haskell.org/package/fix-whitespace)
[](https://stackage.org/nightly/package/fix-whitespace)
[](https://www.stackage.org/package/fix-whitespace)
[](https://github.com/agda/fix-whitespace/actions)
[](https://github.com/agda/fix-whitespace/actions/workflows/haskell-ci.yml)
This tool can keep your project and repository clean of trailing
whitespace and missing terminal newline.
Usage: `fix-whitespace [-h|--help] [-v|--verbose] [--version] [--check] [--config CONFIG] [FILES]`
The program does the following to files specified in `FILES` or in the
configuration file `fix-whitespace.yaml` under the current directory
(and its subdirectories):
* Remove trailing whitespace.
* Remove trailing lines containing nothing but whitespace.
* Ensure that the file ends in a newline character.
* Expand tabs to spaces (optionally).
Available options:
* `-h --help`
Show this help information.
* `-v --verbose`
Show files as they are being checked.
* `--version`
Show program's version.
* `--config=CONFIG`
Override the project configuration `fix-whitespace.yaml`.
* `--tab=TABSIZE`
Expand tab characters to TABSIZE (default: 8) many spaces.
Keep tabs if 0 is given as TABSIZE. _(Option available since 0.0.9.)_
* `--check`
With `--check` the program does not change any files,
it just checks if any files would have been changed.
In the latter case, it returns with a non-zero exit code.
For an example configuration file see [the one of Agda](https://github.com/agda/agda/blob/f9a181685397517b5d14943ca88a1c0acacc2075/fix-whitespace.yaml).
Continuous integration
----------------------
`fix-whitespace` comfortably integrates into your GitHub CI via the [`fix-whitespace-action`](https://github.com/andreasabel/fix-whitespace-action).