PathFilter

Documentation

data PathAccept

Does a filter accept a path?

Constructors

Accept

Filter accepts the path.

Reject

Filter rejects the path.

Instances

Show PathAccept

Defined in PathFilter

Methods

showsPrec :: Int -> PathAccept -> ShowS

show :: PathAccept -> String

showList :: [PathAccept] -> ShowS

toBool :: PathAccept -> Bool

Convert a PathAccept type to a Bool suitable for filtering.

fromBool :: Bool -> PathAccept

Convert a Bool to a PathAccept.

newtype PathFilter

Path filter: examine a relative file and decide if we accept it.

Constructors

PathFilter

Fields

• unPathFilter :: Path Rel File -> PathAccept

Instances

Semigroup PathFilter

Defined in PathFilter

Methods

(<>) :: PathFilter -> PathFilter -> PathFilter

sconcat :: NonEmpty PathFilter -> PathFilter

stimes :: Integral b => b -> PathFilter -> PathFilter

Monoid PathFilter

Defined in PathFilter

Methods

mempty :: PathFilter

mappend :: PathFilter -> PathFilter -> PathFilter

mconcat :: [PathFilter] -> PathFilter

pfNoHidden :: PathFilter

PathFilter that excludes hidden files or directories, starting with a period.

For example:

>>> :set -XQuasiQuotes
>>> import qualified Path
>>> unPathFilter pfNoHidden [Path.relfile|src/.hidden/something.txt|]
Reject
>>> unPathFilter pfNoHidden [Path.relfile|src/nothidden/something.txt|]
Accept

pfNoDistNewstyle :: PathFilter

PathFilter that excludes any path components that are named dist-newstyle.

pfExtension :: ShortText -> PathFilter

PathFilter that keeps only files with a given extension.

The extension to be tested should start with a period.

For example:

>>> :set -XQuasiQuotes -XOverloadedStrings
>>> import qualified Path
>>> pfHs = pfExtension ".hs"
>>> unPathFilter pfHs [Path.relfile|src/ModuleA/ModuleB.hs|]
Accept
>>> unPathFilter pfHs [Path.relfile|src/ModuleA/something.txt|]
Reject

componentFilter :: (ShortText -> PathAccept) -> PathFilter

Create a filter from a function that examines each component of a path.

pathComponents :: Path Rel File -> [ShortText]

Return the components of a path as a list.

For example:

>>> :set -XQuasiQuotes
>>> import qualified Path
>>> pathComponents [Path.relfile|dir/package/file.txt|]
["dir","package","file.txt"]
>>> pathComponents [Path.relfile|file.txt|]
["file.txt"]