agda/fix-whitespace

Fixes whitespace issues

Agda 2

Note that this README is only about Agda, not its standard library. See the Agda Wiki for information about the library.

Documentation

• User manual (per-commit pdf can be downloaded from the github actions page)
• CHANGELOG

Getting Started

• Installation
• Quick guide to editing, type checking and compiling Agda code

Contributing to Agda

• Contribution how-to: HACKING
• Haskell style-guide

fix-whitespace's Issues

Support GHC 9.2

Please add issues with GHC 9.2 compilation to this list:

• bytestring (haskell/bytestring#414)
• mono-traversable (snoyberg/mono-traversable#199)
• conduit (snoyberg/conduit#473)
• integer-logarithms (haskellari/integer-logarithms#29)
• aeson (haskell/aeson#885)

Add testsuite

Add a golden value testsuite.
Since there is now printing of error locations, we should test for correct outputs:

• #7

Build with GHC 9.8

Blocked on:

• glguy/th-abstraction#103
• glguy/th-abstraction#105
• haskell/aeson#1055

Make tab expansion optional (new option `--tab`).

Some files have tabs as part of the syntax, like Makefile.
I propose to put the tab-expansion under a flag --tab, which could have a number argument TABSIZE that defaults to 8.

This is a breaking change, so, new major version: 0.1.

create_release workflow is outdated; use `gh release`

One can now use the gh tool to create a release:

gh release create v0.1 [FILE] --generate-notes
gh release upload v0.1 FILE --clobber

Report error when file does not end with a newline character

Lifted from #44 (comment).

The following violation type does not produce an error:

fix-whitespace/README.md

Line 21 in eb7062c

* Ensure that the file ends in a newline character.

Reason: After breaking the file into lines, we cannot observe anymore whether the last line ended in a newline character. So maybe we have to implement our own line-breaking function which gives an error if the last line does not end with newline.

unknown package: filepattern

Even after running cabal update, I keep getting an error telling me that
filepattern is an unknown package.

[__1] unknown package: filepattern (dependency of fix-whitespace)

Release a github action that does `fix-whitespace --check`

Turn existing instances of fix-whitespace CI workflows into a github action.

• https://github.com/agda/agda/blob/5d2d77abbc0c97f5b23d7089797c3ef8796508dc/src/github/workflows/whitespace.yml
• https://github.com/haskell/cabal/blob/ca0386467a435dc5df1d5d0a2e71b68d228b8e50/.github/workflows/whitespace.yml

Consider making binary releases for the github action platforms to speed up the action (no need to install GHC, Cabal, build fix-whitespace...).

stack warning: Failed to decode module interface

I'm getting the following warning:

$ stack install --stack-yaml=stack-8.10.1.yaml --system-ghc
...
Warning: Failed to decode module interface:
         /home/asr/src/fix-whitespace/.stack-work/dist/x86_64-linux/Cabal-3.2.0.0/build/fix-whitespace/fix-whitespace-tmp/ParseConfig.hi Decoding
         failure: Invalid magic: e49ceb0f

You can see also the warning in Travis.

It seems the warning is related to commercialhaskell/stack#5134.

Catch error `hGetContents: invalid argument (invalid byte sequence)`

Files that are not readable should be skipped (and included in the report), rather than making fix-whitespace crash, as in the case of:

hGetContents: invalid argument (invalid byte sequence)

Support GHC 9.0.1

GHC 9.0.1 was released.

Known issues (2021-02-17)

• hashhable (haskell-unordered-containers/hashable#193)
• split (byorgey/split#9)

Support GHC 8.10.6

What the title says.

Add `--version` option

Add --version option to print the program version.

Release new version supporting GHC 8.10.7

Can someone make the release? If someone add me as maintainer in Hackage (user AndresSicardRamirez) I could make the release.

`--check` should be the default, option `--fix` should touch files

--check should be the default, option --fix should fix the whitespace issues in files.
This is the safer UI.

Symlink treated as directory

With these additional files in test/interaction,

/test/interaction$ tree issue-4828-NEve/
issue-4828-NEve/
├── src
│   └── Issue4828.agda
└── sym
    └── Issue4828.agda -> issue-4828-NEve/src/Issue4828.agda

I get this error:

$ fix-whitespace --check
fix-whitespace: .../test/interaction/issue-4828-NEve/sym/Issue4828.agda/: getDirectoryContents:openDirStream: does not exist (No such file or directory)

Seems like a symlink is treated as a directory somehow.

UPDATE: Blocked upstream:

• ndmitchell/filepattern#5

Release fix-whitespace on hackage

I'd like to use fix-whitespace in other projects. Thanks to your work, it is no longer tied to Agda.

Let's release it on hackage!

Here is a candidate: https://hackage.haskell.org/package/fix-whitespace-0.0.5/candidate

TODO: Show a warning if no configuration file is found

As title.

Support GHC 8.10.3

What the title says.

Performance problem with error message feature

After PR #44, performance has degraded for large files with lots of violations.

Reproducer:

runhaskell test/GenerateViolations.hs 200000
FW=$(cabal list-bin fix-whitespace)
time $FW --check 200000-violations.txt 2> /dev/null

Takes 30sec on my machine. The released (0.0.11) finishes in a fraction of a second.

Proposed procedure:

1. Try to fix the performance problem
2. Guard error reporting under --verbose flag.

Fix trailing tabs, too.

Fix tabs that lurk around, also in empty lines, too.

Enhancement: more verbose error reporting

It would be nice if fix-whitespace would tell (a) what kind of error it discover, and more importantly, (b) where in the file it is. That would be particularly helpful for large non-trivial files.

Use `fix-whitespace.yaml` as filter when file arguments are given

Use case:

git ls-tree -r master --name-only | xargs fix-whitespace --config fix-whitespace.yaml 

or simply

git ls-tree -r master --name-only | xargs fix-whitespace

This should filter the FILES given to fix-whitespace through the configuration given in fix-whitespace.yaml.

A new flag, like --config - could be used if really all of the given FILES should be processed.