fix-whitespace: Fixes whitespace issues.

[ program, text ] [ Propose Tags ]

Removes trailing whitespace, lines containing only whitespace and ensure that every file ends in a newline character.


[Skip to Readme]
Versions [faq] 0.0.5
Change log CHANGELOG.md
Dependencies base (>=4.9.0.0 && <4.16), directory (>=1.2.6.2 && <1.4), extra (>=1.1 && <2.0), filepath (>=1.4.1.0 && <1.5), filepattern (==0.1.2.*), text (>=1.2.3.0 && <1.3), yaml (>=0.8.4 && <0.12) [details]
License LicenseRef-OtherLicense
Author fix-whitespace was originally written by Nils Anders Danielsson as part of Agda 2 with contributions from Ulf Norell, Andrés Sicard-Ramírez, Andreas Abel, Philipp Hausmann, Jesper Cockx, Vlad Semenov, and Liang-Ting Chen.
Maintainer Liang-Ting Chen <liang.ting.chen.tw@gmail.com>
Category Text
Home page https://github.com/agda/fix-whitespace
Bug tracker https://github.com/agda/fix-whitespace/issues
Source repo head: git clone https://github.com/agda/fix-whitespace.git
Uploaded by AndreasAbel at 2021-03-10T18:41:41Z
Distributions NixOS:0.0.5, Stackage:0.0.5
Executables fix-whitespace
Downloads 45 total (15 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
Last success reported on 2021-03-10 [all 2 reports]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for fix-whitespace-0.0.5

[back to package description]

fix-whitespace: Fixes whitespace issues

Hackage version Hackage CI fix-whitespace on Stackage Nightly Stackage LTS version Build status

This tool can keep your project and repository clean of trailing whitespace and missing terminal newline.

Usage: fix-whitespace [-h|--help] [-v|--verbose] [--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.

Available options:

  • -h --help

    Show this help information.

  • -v --verbose

    Show files as they are being checked.

  • --config=CONFIG

    Override the project configuration fix-whitespace.yaml.

  • --check

    With --check the program does not change any files, it just checks if any files would have been changed. In this case it returns with a non-zero exit code.

For an example configuration file see the one of Agda.