View Source Memorex.Parser (Memorex v0.1.0)

Parses Memorex Markdown Memorex.Domain.Deck files. The Memorex.Parser is invoked from the mix task memorex.read_notes. This mix task invokes read_note_dirs which is the main entry point to Memorex.Parser; the rest of the funtions are implementation details (which are public simply so they can be tested in isolation).

Link to this section Summary

Link to this section Functions

Link to this function

is_bidirectional_note?(line)

View Source
@spec is_bidirectional_note?(String.t()) :: boolean()
@spec is_note_line?(String.t()) :: boolean()
Link to this function

parse_file_contents(contents, opts \\ [])

View Source
@spec parse_file_contents(String.t(), Keyword.t()) :: :ok
Link to this function

parse_line(line, category)

View Source
@spec parse_line(String.t(), String.t() | nil) :: Memorex.Domain.Note.t()
@spec read_dir(String.t()) :: :ok
Link to this function

read_file(filename, opts \\ [])

View Source
@spec read_file(String.t(), Keyword.t()) :: :ok
Link to this function

read_note_dirs(note_dirs \\ Application.get_env(:memorex, Memorex.Note)[:note_dirs])

View Source
@spec read_note_dirs([String.t()] | nil) :: :ok
Link to this function

read_toml_deck_config(filename)

View Source
@spec read_toml_deck_config(String.t()) :: map()