kescobo / Term.jl

Playing with terminal utilities in Julia

Related:

• https://github.com/KristofferC/Crayons.jl
• https://github.com/Aerlinger/AnsiColor.jl

Roadmap

docs/examples

• re-write docstrings; https://docs.julialang.org/en/v1/manual/documentation/
• README generated by Term like Rich's
• logo
• TODO either remove text utils from API docs or avoid importing it
• docs

  • installation

  • basic usage

    • markup
    • apply style
    • macros

  • colors

    • allowed colors
    • how to use them and exmaples

  • renderabletext, textbox/panels + nesting

    • segments
    • measure
    • panels
    • textbox

  • layout

    • the idea
    • vstack vs hstack
    • nesting
    • hline
    • vLine
    • Spacer

  • inspect

  • errors

  • logging

  • API

    • term
    • markup
    • color
    • console
    • inspect
    • layout
    • logging
    • panel
    • renderables
    • segment
    • measure
    • style

To do & bugs

• highlight sometimes doesnt apply styles correctly when >1 elements per line
• BUG: read code style from file sometimes gives the wrong line (towards end of file)
• logging accept symbols and expressions in message
• refactor TextBox and RenderableText
• use project board

Future features

• add :time and :date options for panel's subtitles

• pretty print commond data structure such as Dict

• progress bar

• allow things like Panel and TextBox to fill their parent renderable

• tree visualization

• type hierarchy tree (https://towardsdatascience.com/runtime-introspection-julias-most-powerful-best-kept-secret-bf845e282367)

• logging:

  • get "stack trace" of logging: where is the log message triggered from?

• allow for user created Themes

• add additional error types to error messages

  • SystemError
  • UndefRefError
  • EOFError
  • InterruptException