Gitson.Util

Various functions used inside Gitson.

Documentation

entryPath :: FilePath -> FilePath -> FilePath

Combines two paths and adds the .json extension.

>>> entryPath "things" "entry"
"things/entry.json"

>>> entryPath "things/" "entry"
"things/entry.json"

lockPath :: FilePath

Path to the transaction lock file, relative to the repo root.

filterFilenamesAsKeys :: [String] -> [String]

Turns a list of filenames into a list of keys.

>>> filterFilenamesAsKeys [".", "..", "k1.json"]
["k1"]

insideDirectory :: FilePath -> IO a -> IO a

Returns an IO action that switches the current directory to a given path, executes the given IO action and switches the current directory back.

stripWhitespaceRight :: FilePath -> FilePath

Removes trailing whitespace like the newline you get from executing commands.

>>> stripWhitespaceRight "/path/to/thingy \n\n\n"
"/path/to/thingy"

findRepoRoot :: FilePath -> IO FilePath

Finds the path to the git repository a given path belongs to.

lastCommitText :: IO String

Returns the message of the last git commit in the repo where the current directory is located.

devNull :: IO Handle

A /dev/null handle.

shell :: String -> [String] -> IO ()

Runs a shell command with stdin, stdout and stderr set to devnull.