Skip to content

Latest commit

 

History

History
93 lines (74 loc) · 3.51 KB

TODO.md

File metadata and controls

93 lines (74 loc) · 3.51 KB

TODO

Book

  • Add docs for new filters: strip & slugify.
  • Links to example templates refer to main and not the current release. All links containing /~https://github.com/tnahs/readstor/main must be converted to a tag-aware one: /~https://github.com/tnahs/readstor/v0.3.0. Is it possible to automate this nicely for every release?
  • Add more documentation for each annotation/book field.

Next

  • Simplify template-groups file naming workflow. Add internal awareness of template groups.

  • Update README to focus on template outputs and exporting rather than a general purpose CLI.

  • Check cargo clippy GitHub Action.

  • Update how the summaries are printed out. With the ability to skip writing files, the current method will display incorrect information.

  • Find more fields in the iOS plist.

  • Display a more information-rich table when filtering:

     Found 11 annotations from 2 books
┌───────────────────────┬─────────────────┬──────────────────┐
│ Title                 │ Author          │ # of Annotations │
├───────────────────────┼─────────────────┼──────────────────┤
│ Think on These Things │ J. Krishnamurti │ 3                │
│ The Art Spirit        │ Robert Henri    │ 8                │
└───────────────────────┴─────────────────┴──────────────────┘

Continue? [y/N]: █

Ideas

  • Convert Book::authors into a list of authors?

  • Should we add pre- and post-processing options to the template's config? We could also keep the cli pre- and post-processing options and merge them with the ones local to each template.

    group: extended-config
# ...
pre-process:
  extract-tags: true
  normalize-whitespace: true
  convert-to-ascii: all # or 'symbols'
post-process:
  trim-blocks: true
  wrap-text: 80

  • Improve stdout messages with indicatif

    ◆ Rendering Templates:
  • initializing data...
  • running pre-processors...
  • initializing templates...
  • rendering templates...
  • running post-processors...
  • writing templates...
  • rendered 1 template into 99 files to /path/to/output/directory

  • Add more FilterTypes and FilterOperators.

Internal

  • Document cli crate.
  • Add more tests in:
    • lib/process/processors.rs
    • lib/process/mod.rs
  • Improve epubcfi parser.
  • Add teardown for testing.
  • Can we add tests inside the lib::render::template.rs to verify that the example template configs are valid? This should also check the names field for any errors in requested values.
  • Add filsystem tests for when skipping/overwriting files using the export and render commands.
  • Document cli module.
  • Is there a way to consolidate clippy lints between bin/lib?
  • Test Tera macros and inheritances.

Features

  • Config file support.

Future

  • Internationalization.