https://github.com/andreasabel/fix-whitespace-action
Run fix-whitespace on your repo.
https://github.com/andreasabel/fix-whitespace-action
Last synced: about 1 year ago
JSON representation
Run fix-whitespace on your repo.
- Host: GitHub
- URL: https://github.com/andreasabel/fix-whitespace-action
- Owner: andreasabel
- Created: 2022-11-15T18:38:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T21:16:36.000Z (over 1 year ago)
- Last Synced: 2025-01-15T00:38:06.350Z (over 1 year ago)
- Size: 15.6 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fix-whitespace-action
Run [`fix-whitespace`](https://github.com/agda/fix-whitespace) on your repository.
The `fix-whitespace` tool checks for absense of _whitespace violations_, which are tabs, trailing whitespace, and lack of newline character at the end of the file.
Files which should be checked are specified in the configuration file, typically `fix-whitespace.yaml` in the repository root.
Standard use:
```
steps:
- uses: actions/checkout@v3
- uses: andreasabel/fix-whitespace-action@v1
```
This downloads the `fix-whitespace` binary, installs it into `~/.local/bin` and runs it with standard parameters on the repository root.
Example using all parameters:
```
steps:
- uses: actions/checkout@v3
- uses: andreasabel/fix-whitespace-action@v1
with:
version: 0.1
configfile: fix-whitespace.yaml
fix: true
verbose: true
```
Setting `fix: true` fixes whitespace violations in place.
Of course, these are fixed only in the checked-out version on the runner.
You may be able to push these fixes pack to your repository, e.g., by opening a PR on your repository.
Input `version` refers to the [version of the `fix-whitespace` program](https://github.com/agda/fix-whitespace/releases).
With input `configfile` one can specify the configuration file (defaults to `fix-whitespace.yaml`).
Exact position of violations can be displayed with `verbose: true`.