Summoner.Tree

Data type for representing filesystem structure via tree.

Documentation

data TreeFs

Describes simple structure of filesystem tree.

Constructors

Dir FilePath [TreeFs]

Name of directory (relative) and its containing entries

File FilePath Text

File name (relative) and file content

Instances

Eq TreeFs

Defined in Summoner.Tree

Methods

(==) :: TreeFs -> TreeFs -> Bool

(/=) :: TreeFs -> TreeFs -> Bool

Ord TreeFs

Defined in Summoner.Tree

Methods

compare :: TreeFs -> TreeFs -> Ordering

(<) :: TreeFs -> TreeFs -> Bool

(<=) :: TreeFs -> TreeFs -> Bool

(>) :: TreeFs -> TreeFs -> Bool

(>=) :: TreeFs -> TreeFs -> Bool

max :: TreeFs -> TreeFs -> TreeFs

min :: TreeFs -> TreeFs -> TreeFs

Show TreeFs

Defined in Summoner.Tree

Methods

showsPrec :: Int -> TreeFs -> ShowS

show :: TreeFs -> String

showList :: [TreeFs] -> ShowS

Generic TreeFs

Defined in Summoner.Tree

Associated Types

type Rep TreeFs :: Type -> Type

Methods

from :: TreeFs -> Rep TreeFs x

to :: Rep TreeFs x -> TreeFs

type Rep TreeFs

Defined in Summoner.Tree

type Rep TreeFs = D1 ('MetaData "TreeFs" "Summoner.Tree" "summoner-2.0.1.1-inplace" 'False) (C1 ('MetaCons "Dir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TreeFs])) :+: C1 ('MetaCons "File" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

traverseTree :: TreeFs -> IO ()

Walks through directory tree and write file contents, creating all intermediate directories.

pathToTree :: FilePath -> Text -> TreeFs

This function converts a string file path to the tree structure.

For a path like this: ".githubworkflowci.yml"

This function produces the following tree:

.github/
└── workflow/
    └── ci.yml

insertTree :: TreeFs -> [TreeFs] -> [TreeFs]

This functions inserts given TreeFs node into the list of existing TreeFs nodes. The behavior of this function is the following:

1. It merges duplicating directories.
2. It overrides existing File with the given TreeFs in case of duplicates.

showBoldTree :: TreeFs -> Text

Pretty shows the directory tree content.

showTree

Arguments

:: Bool

Print directories bold.

-> TreeFs

Given tree.

-> Text

Pretty output.

Pretty shows tree with options.