Skip to content

Commit

Permalink
v0.1: CHANGELOG, README, LICENSE, --help
Browse files Browse the repository at this point in the history
Document new feature in `--verbose` and mention contributor.
  • Loading branch information
andreasabel committed Aug 7, 2023
1 parent 46be4d2 commit c6470a1
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 9 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Version history.

# 0.1 Rainy Summer edition released 2023-08-07

- Flag `--verbose` now also displays locations of whitespace violations
([#7](https://github.com/agda/fix-whitespace/issues/7), contributed by Artem Pelenitsyn).
- Tested with GHC 8.0.2 - 9.8.1-alpha1.

## 0.0.11 Santa Clause edition released 2022-12-06

- Delete trailing tabs even when `--tab=0`
Expand Down
7 changes: 5 additions & 2 deletions FixWhitespace.hs
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,15 @@ options =
[ Option ['h'] ["help"]
(NoArg (\opts -> opts { optHelp = True }))
"Show this help information."
, Option [] ["version"]
, Option ['V'] ["version"]
(NoArg (\opts -> opts { optVersion = True }))
"Show the program's version."
, Option ['v'] ["verbose"]
(NoArg (\opts -> opts { optVerbose = True }))
"Show files as they are being checked."
(unlines
[ "Show files as they are being checked."
, "Display location of detected whitespace violations."
])
, Option ['t'] ["tab"]
(ReqArg (\ts opts -> opts { optTabSize = ts }) "TABSIZE")
(unlines
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Copyright (c) 2005-2021 remains with the authors.
Copyright (c) 2005-2023 remains with the authors.

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.
Vlad Semenov, Liang-Ting Chen, and Artem Pelenitsyn.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ fix-whitespace: Fixes whitespace issues
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]`
Usage: `fix-whitespace [-h|--help] [-v|--verbose] [-V|--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
Expand All @@ -30,8 +30,9 @@ Available options:
* `-v --verbose`

Show files as they are being checked.
_Since 0.1:_ Display location of detected whitespace violations.

* `--version`
* `-V --version`

Show program's version.

Expand Down
6 changes: 3 additions & 3 deletions fix-whitespace.cabal
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
cabal-version: 2.2
name: fix-whitespace
version: 0.1.0
version: 0.1
build-type: Simple

category: Text
synopsis: Fixes whitespace issues.
description: Removes trailing whitespace, lines containing only whitespace, expands tabs,
and ensures that every file ends in a newline character.
license: LicenseRef-OtherLicense
license: MIT
license-file: LICENSE
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.
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, Liang-Ting Chen, and Artem Pelenitsyn.
maintainer: Andreas Abel, Liang-Ting Chen <[email protected]>
homepage: https://github.com/agda/fix-whitespace
bug-reports: https://github.com/agda/fix-whitespace/issues
Expand Down

0 comments on commit c6470a1

Please sign in to comment.