Commit graph

11 commits

Author SHA1 Message Date
Marty Oehme 7ee8d4911e
refactor: Make formatters functions
Formatters have been classes so far which contained some data (the
tamplate to use for formatting and the annotations and documents to
format) and the actual formatting logic (an execute function).

However, we can inject the annotations to be formatted and the templates
so far are static only, so they can be simple variables (we can think
about how to inject them at another point should it come up, no
bikeshedding now).

This way, we can simply pass around one function per formatter, which
should make the code much lighter, easier to add to and especially less
stateful which means less areas of broken interactions to worry about.
2023-09-21 21:54:24 +02:00
Marty Oehme e511ffa48d
feat: Add CSV formatter
Added formatter for csv-compatible syntax. The formatting is quite basic
with no escaping happening should that be necessary. However, for an
initial csv output it suffices for me.
2023-09-20 09:15:00 +02:00
Marty Oehme 5a6d672c76
refactor: Move formatting logic to formatters
Formatters (previously templates) were pure data containers before,
continating the 'template' for how things should be formatted using
mustache. The formatting would be done a) in the exporters and b) in the
annotations.

This spread of formatting has now been consolidated into the Formatter,
which fixes the overall spread of formatting code and now can coherently
format a whole output instead of just individual annotations.

A formatter contains references to all documents and contained
annotations and will format everything at once by default, but the
formatting function can be invoked with reference to a specific
annotated document to only format that.

This commit should put more separation into the concerns of exporter and
formatter and made formatting a concern purely of the formatters and
annotation objects.
2023-09-20 09:14:58 +02:00
Marty Oehme 07d4de9a46
docs: Add docstrings 2023-09-20 09:13:04 +02:00
Marty Oehme 4eb983d9e3
refactor: Move templating to separate file 2023-09-20 09:12:59 +02:00
Marty Oehme 5450776eb2
refactor: Extract templating to model module 2023-09-20 09:12:45 +02:00
Marty Oehme e56f014136
Add formatting style Markdown 2023-08-31 21:40:17 +02:00
Marty Oehme c6b95a4742
Fix spacing in print output 2023-08-28 18:05:52 +02:00
Marty Oehme 2109c6535d
Add decoration to pretty printed author 2023-08-28 17:04:15 +02:00
Marty Oehme 1bb1b80620
Add debug logging for extractor 2023-08-28 12:53:17 +02:00
Marty Oehme a22cc635b2
initial commit 2023-08-28 10:28:06 +02:00