Headroom.FileSystem

Module providing functions for working with the local file system, its file and directories.

Type Aliases

type CreateDirectoryFn m

Arguments

 = FilePath

path of new directory

-> m ()

IO action result

Type of a function that creates new empty directory on the given path.

type DoesFileExistFn m

Arguments

 = FilePath

path to check

-> m Bool

whether the given path is existing file

Type of a function that returns True if the argument file exists and is not a directory, and False otherwise.

type FindFilesFn m

Arguments

 = FilePath

path to search

-> (FilePath -> Bool)

predicate to match filename

-> m [FilePath]

found files

Type of a function that recursively finds files on given path whose filename matches the predicate.

type FindFilesByExtsFn m

Arguments

 = FilePath

path to search

-> [Text]

list of file extensions (without dot)

-> m [FilePath]

list of found files

Type of a function that recursively finds files on given path by file extensions.

type FindFilesByTypesFn m

Arguments

 = CtHeadersConfig

configuration of license headers

-> [FileType]

list of file types

-> FilePath

path to search

-> m [FilePath]

list of found files

Type of a function that recursively find files on given path by their file types.

type GetCurrentDirectoryFn m = m FilePath

Type of a function that obtains the current working directory as an absolute path.

type ListFilesFn m

Arguments

 = FilePath

path to search

-> m [FilePath]

list of found files

Type of a function that recursively find all files on given path. If file reference is passed instead of directory, such file path is returned.

type LoadFileFn m

Arguments

 = FilePath

file path

-> m Text

file content

Type of a function that loads file content in UTF8 encoding.

Polymorphic Record

data FileSystem m

Polymorphic record composed of file system IO function types, allowing to abstract over concrete implementation. Whenever you need to use effectful functions from this module, consider using this record instead of using them directly, as it allows you to use different records for production code and for testing, which is not as easy if you wire some of the provided functions directly.

Constructors

FileSystem

Fields

• fsCreateDirectory :: CreateDirectoryFn m

  Function that creates new empty directory on the given path.

• fsDoesFileExist :: DoesFileExistFn m

  Function that returns True if the argument file exists and is not a directory, and False otherwise.

• fsFindFiles :: FindFilesFn m

  Function that recursively finds files on given path whose filename matches the predicate.

• fsFindFilesByExts :: FindFilesByExtsFn m

  Function that recursively finds files on given path by file extensions.

• fsFindFilesByTypes :: FindFilesByTypesFn m

  Function that recursively find files on given path by their file types.

• fsGetCurrentDirectory :: GetCurrentDirectoryFn m

  Function that obtains the current working directory as an absolute path.

• fsListFiles :: ListFilesFn m

  Function that recursively find all files on given path. If file reference is passed instead of directory, such file path is returned.

• fsLoadFile :: LoadFileFn m

  Function that loads file content in UTF8 encoding.

Instances

Has (FileSystem (RIO Env)) Env

Defined in Headroom.Command.Init

Methods

getter :: Env -> FileSystem (RIO Env)

modifier :: (FileSystem (RIO Env) -> FileSystem (RIO Env)) -> Env -> Env

hasLens :: Lens' Env (FileSystem (RIO Env))

viewL :: MonadReader Env m => m (FileSystem (RIO Env))

mkFileSystem :: MonadIO m => FileSystem m

Creates new FileSystem that performs actual disk IO operations.

Traversing the File System

findFiles :: MonadIO m => FindFilesFn m

Recursively finds files on given path whose filename matches the predicate.

findFilesByExts :: MonadIO m => FindFilesByExtsFn m

Recursively finds files on given path by file extensions.

findFilesByTypes :: MonadIO m => FindFilesByTypesFn m

Recursively find files on given path by their file types.

listFiles :: MonadIO m => ListFilesFn m

Recursively find all files on given path. If file reference is passed instead of directory, such file path is returned.

loadFile :: MonadIO m => LoadFileFn m

Loads file content in UTF8 encoding.

Working with Files Metadata

fileExtension

Arguments

:: FilePath

path from which to extract file extension

-> Maybe Text

extracted file extension

Returns file extension for given path (if file), or nothing otherwise.

>>> fileExtension "path/to/some/file.txt"
Just "txt"

Other

excludePaths

Arguments

:: [Regex]

patterns describing paths to exclude

-> [FilePath]

list of file paths

-> [FilePath]

resulting list of file paths

Takes list of patterns and file paths and returns list of file paths where those matching the given patterns are excluded.

>>> import Headroom.Data.Regex (re)
>>> :set -XQuasiQuotes
>>> excludePaths [[re|\.hidden|], [re|zzz|]] ["foo/.hidden", "test/bar", "x/zzz/e"]
["test/bar"]