The ignore package

[Tags:bsd3, library, program, test]

Library and tiny tool for working with ignore files of different version control systems

[Skip to Readme]


Dependencies base (==4.*), directory (>=, Glob (>=0.7), ignore, mtl (>=, path (>=0.5.1), pcre-heavy (>=0.2), text (>= [details]
License BSD3
Copyright (c) 2015 Alexander Thiemann
Author Alexander Thiemann <>
Maintainer Alexander Thiemann <>
Category System
Home page
Source repository head: git clone
Uploaded Sun Aug 23 19:01:38 UTC 2015 by AlexanderThiemann
Distributions LTSHaskell:, NixOS:, Stackage:, Tumbleweed:
Downloads 567 total (3 in the last 30 days)
0 []
Status Docs available [build log]
Last success reported on 2015-08-23 [all 1 reports]




without-pcreDisable pcre support. If you enable this flag, version control ignore files that rely on pcre will not work correctlyDisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees

Readme for ignore

Readme for ignore-


Build Status Hackage


Hackage: ignore Stackage: ignore

Handle ignore files of different VCSes

Cli Usage: ignore

$ ignore --help
The ignore tool
(c) 2015 Alexander Thiemann

Tiny tool to check if a file in a repo is ignored by a VCS

Usage: ignore [--help|-h] file1 file2 file3 ... fileN

Library Usage Example

module Main where

import Ignore

import Path
import System.Environment
import System.Directory

main :: IO ()
main =
    do dir <- getCurrentDirectory >>= parseAbsDir
       ignoreFiles <- findIgnoreFiles [VCSGit, VCSMercurial, VCSDarcs] dir
       checker <- buildChecker ignoreFiles
       case checker of
           Left err -> error err
           Right (FileIgnoredChecker isFileIgnored) ->
                  putStrLn $
                    "Main.hs is "
                    ++ (if isFileIgnored "Main.hs"
                        then "ignored" else "not ignored")


  • Using cabal: cabal install ignore
  • Using Stack: stack install ignore
  • From Source (cabal): git clone && cd ignore && cabal install
  • From Source (stack): git clone && cd ignore && stack build


Supported GHC Versions


Released under the BSD3 license. (c) 2015 Alexander Thiemann