Jacob v0.1.1 Jacob.Files View Source

Manages the dot directory. i.e. ~/.jacob

Every jacob application may need to store application related files. Following other cli’s conventions we will put them in a dot directory in the user’s home directory.

The dot directory name is infered by the cli app name therefore a jacob app called rabbi will see it’s dot directory stored at ~/.rabbi.

Link to this section Summary

Functions

Return the dot directory’s full path. e.g. /home/username/.jacob/

Join the given path to the dot directory path

Read from the dot directory. Returns what File.read/1 would return

Write some file in the dot directory. If the file already exists it will be overwritten. If the dot directory does not exits it will be created. Returns what File.write/2 would return

Link to this section Functions

Return the dot directory’s full path. e.g. /home/username/.jacob/

Link to this function dot_directory_path(path_to_join) View Source

Join the given path to the dot directory path.

Read from the dot directory. Returns what File.read/1 would return.

Link to this function save(file_name, content) View Source

Write some file in the dot directory. If the file already exists it will be overwritten. If the dot directory does not exits it will be created. Returns what File.write/2 would return.