Directory layout description

Regular file with some contents or empty

>>> let layout = file "foo"

Symbolic link

>>> let layout = symlink "foo" "bar"

Directory

>>> :{
let layout = dir "foo" $ do
      file "bar"
      file "baz"
:}

A nested list of directories

>>> :{
let layout = dirs ["foo", "bar"] $ do
               file "qux"
               file "quux"
:}

Empty directory

>>> let layout = emptydir "foo"

An optic into file contents

Regular file contents

Binary contents

>>> let layout = file "foo" & contents ?~ binary (ByteString.pack [1..10])

Plain text contents

>>> let layout = file "foo" & contents ?~ text (Data.Text.pack "hello")

A handy quasiquoter to work with the multiline file contents

Strips the longest common leading spaces segment. All spacey characters are treated equally. The first line is ignored if it's spaces only.

>>> :{
putStr [dedent|
  hello
    world
    !
|]
:}
hello
  world
  !

Contents are the copy of whose of the real file

>>> let layout = file "foo" & contents ?~ copyOf "/home/user/.vimrc"

An optic into symbolic link source

>>> symlink "foo" "bar" ^? source
Just "bar"

An optic into symbolic link source expected existence

>>> let layout = symlink "foo" "bar" & exists .~ True

File owner

An optic into file owner

>>> let layout = file "foo" & user ?~ uid 0

Set the file owner by uid

Set the file owner by username

>>> let layout = file "foo" & user ?~ username "root"

File group

An optic into file group

>>> let layout = file "foo" & group ?~ gid 0

Set the file group by groupname

Set the file group by groupname

>>> let layout = file "foo" & group ?~ groupname "wheel"

An optic into file mode

>>> let layout = file "foo" & mode ?~ 0o100777

Anything

>>> let layout = file "foo" & contents .~ anything
>>> let layout = file "foo" & user .~ anything

An optic into the directory contents of the particular directory

>>> :{
dirs ["foo", "bar", "baz"] (symlink "qux" "quux")
  ^? into "foo".into "bar".into "baz".focus "qux".source
:}
Just "quux"

An optic into the particular node