fix-whitespace.yaml

   1 # This file contains the project-specific settings for `fix-whitespace` a tiny
   2 # but useful tool to
   3 #
   4 # * Removes trailing whitespace.
   5 # * Removes trailing lines containing nothing but whitespace.
   6 # * Ensures that the file ends in a newline character.
   7 #
   8 # By default, fix-whitespace checks every directory under the current working
   9 # directory but no files. This program should be placed under a text-based
  10 # project.
  11 #
  12 # For directories,
  13 #
  14 # 1) excluded-dirs is a black-list of directories,
  15 # 2) included-dirs is a white-list of excluded-dirs
  16 #
  17 # For files,
  18 #
  19 # 3) included-files is a white-list of files,
  20 # 4) excluded-files is a black-list of included-files.
  21 #
  22 # The extended glob pattern can be used to specify file/direcotory names.
  23 # For details, see http://hackage.haskell.org/package/filemanip-0.3.6.3/docs/System-FilePath-GlobPattern.html
  24 #
  25 included-dirs:
  26     # Without this line the above path will be excluded.
  27
  28 excluded-dirs:
  29   - "**/dist*"   # matches every dist* in any directory
  30   - _darcs
  31   - .git
  32   - .python-sphinx-virtualenv
  33   - .stack-work
  34   - .vscode
  35
  36 # Every matched filename is included unless it is matched by excluded-files.
  37 included-files:
  38   - .dockerignore
  39   - .gitignore
  40   - .gitattributes
  41   - AUTHORS
  42   - LICENSE
  43   - "*.project"
  44   - "cabal.project.*"
  45   - "*.ac"
  46   - "*.bat"
  47   - "*.bat_t"
  48   - "*.c"
  49   - "*.cabal"
  50   - "*.cmm"
  51   - "*.cobol"
  52   - "*.conf"
  53   - "*.config"
  54   - "*.cfg"
  55   - "*.cpp"
  56   - "*.csh"
  57   - "*.css"
  58   - "*.css_t"
  59   - "*.dhall"
  60   - "*.dockerfile"
  61   - "*.el"
  62   - "*.h"
  63   - "*.hs"
  64   - "*.hs-boot"
  65   - "*.hsc"
  66   - "*.hsig"
  67   - "*.html"
  68   - "*.html_t"
  69   - "*.in"
  70   - "*.inc"
  71   - "*.js"
  72   - "*.js_t"
  73   - "*.json"
  74   - "*.lhs"
  75   - "*.md"
  76   - "*.py"
  77   - "*.rst"
  78   - "*.rst_t"
  79   - "*.sh"
  80   - "*.sty"
  81   - "*.tex"
  82   - "*.tex_t"
  83   - "*.toml"
  84   - "*.txt"
  85   - "*.x"
  86   - "*.y"
  87   - "*.yaml"
  88   - "*.yml"
  89   - "*.zinza"
  90
  91 excluded-files:
  92 # Exceptions
  93   - Cabal-syntax/src/Distribution/Fields/Lexer.hs
  94   - Cabal-tests/tests/ParserTests/warnings/tab.cabal
  95   - Cabal-tests/tests/ParserTests/warnings/utf8.cabal
  96   - cabal-testsuite/PackageTests/Regression/T8507/pkg.cabal
  97
  98   # These also contain tabs that affect the golden value:
  99   # Could be removed from exceptions, but then the tab warning
 100   # has to be removed from the corresponding .format file.
 101   - Cabal-tests/tests/ParserTests/regressions/monad-param.cabal
 102   - Cabal-tests/tests/ParserTests/regressions/th-lift-instances.cabal
 103
 104 # Files that use tabs
 105   - Makefile
 106   - GNUmakefile
 107   - "*.mk"
 108   - .mailmap
 109
 110 # Generated files
 111   - TAGS
 112   - "*.buildinfo"
 113   - "*.check"
 114   - "*.expr"
 115   - "*.errors"
 116   - "*.format"
 117   - "*.freeze"
 118   - "*.golden"
 119   - "*.log"
 120   - "*.out"
 121   - doc/buildinfo-fields-reference.rst
 122
 123 # Binary files
 124   - "*.a"
 125   - "*.dylib"
 126   - "*.dyn_hi"
 127   - "*.dyn_hi-boot"
 128   - "*.enc"
 129   - "*.exe"
 130   - "*.gif"
 131   - "*.gz"
 132   - "*.hi"
 133   - "*.hi-boot"
 134   - "*.o"
 135   - "*.o-boot"
 136   - "*.p_hi"
 137   - "*.p_o"
 138   - "*.png"
 139   - "*.so"