puffytools-0.0.0.1: A CLI assistant

Copyright	2014, Peter Harpending
License	BSD3
Maintainer	Peter Harpending <pharpend2@gmail.com>
Stability	experimental
Portability	Linux
Safe Haskell	None
Language	Haskell2010

PuffyTools.Journal

Description

Synopsis

Documentation

programName :: String Source

journalExt :: String Source

data Journal Source

A Journal is really a wrapper around a list of entries

Constructors

Journal
Fields journalSlug :: Slug journalTitle :: Text journalLastEdited :: UTCTime journalCreated :: UTCTime journalDescription :: Maybe Text journalEntries :: Vector Entry

Instances

Eq Journal
Show Journal
ToJSON Journal
FromJSON Journal

data Entry Source

Entries

Constructors

Entry
Fields entrySummary :: Text entryCreated :: UTCTime entryLastEdited :: UTCTime

Instances

Eq Entry
Show Entry
ToJSON Entry
FromJSON Entry

addEntry :: Journal -> Entry -> Journal Source

mkEntry :: Text -> IO Entry Source

mkJournal :: Slug -> IO Journal Source

Makes a journal, given a slug

mkJournal' :: Text -> IO Journal Source

Makes a journal, given a slug

generateJournalPath :: Journal -> IO FilePath Source

Figures out the file path for a journal

generateSlugPath :: Slug -> IO FilePath Source

writeJournal :: Journal -> IO () Source

Writes a journal to a file path

readJournalName :: Text -> IO Journal Source

Reads a journal from the default file path (~.puffytoolsjournal-title.json)

readJournalDef :: Slug -> IO Journal Source

Reads a journal from the default file path (~.puffytoolsjournal-title.json)

readJournalFromFile :: FilePath -> IO Journal Source

Reads a journal, given a file path

readJournalFromHandle :: Handle -> IO Journal Source

Reads a journal from a handle, close handle

listJournals :: IO [FilePath] Source

Deprecated: use listJournalFiles instead

listJournalFiles :: IO [FilePath] Source

List all of the journal file paths

listJournalSlugs :: IO [Text] Source

List all of the Journal slugs

ifJournal :: Text -> IO () -> IO () Source

Perform some action if a given journal exists

unlessJournal :: Text -> IO () -> IO () Source

Perform some action if a given journal does not exist