pterm / pterm Goto Github PK

Add unit tests counter badge

Count tests with: go test -v ./... | grep -c RUN

Add a tree list printer like BulletListPrinter.
Style: like tree in cmd

Todo:

pterm.NewStyle(...) -> pterm.Style.New(...)
pterm.NewRGB(...) -> pterm.RGB.New(...)
pterm.NewRGBFromHex(...) -> pterm.RGB.NewFromHEX(...)

Every function exported by PTerm should be tested.

Check test coverage with go test -cover .

Option to disable all output.

pterm.DisableOutput = true

🔝 this should disable all Print functions, so that PTerm does not print anything.
Can be used to run CLI tools in quiet or silent mode.

Can be done using ./_examples. Each dir which does not contain a - will be excluded and so leave only the basic features of PTerm. Demo must also be excluded.

Remove Progressbar.UpdateDelay.

Only print if pterm.Debug == true.

Add tests

Add PrintAbove to Progressbar to print a line above the progressbar.
Possibly autodetect running progressbars while using pterm.Print and automaitcally use PrintAbove

Change SetXXX to WithXXX. It actually does not set something permanently, which could be misunderstood.

Add an option to remove Progressbar when done.

Update CONTRIBUTING.md file.

Check if performance can be improved.
PTerm is fast, but it can be faster 😉

CenterPrinter should print centered text. Renderable printer. Custom screen size.

Add EnableDebug() and DisableDebug().

CI System hangs on Counting unit tests (sometimes).
Need to investigate.

Also make sure that tests and examples are updated.

Rename RemoveColors to RemoveColorFromString.

Add theme support to PTerm.

• Theme should be a struct.
• A default theme should be used for default printers.
• Each printer should have a theme option.

Theme Support

• PrefixPrinter
• HeaderPrinter
• Progressbar
• Spinner
• Table
• Section

Current progress in https://github.com/pterm/pterm/tree/feat/theme-support

Add TextPrinter variant which prints normal text - this can be used to resolve progressbars and spinners for example.

Change WithXXX(b bool) to WithXXX(b ...bool). If no boolean is set, it will set the boolean to true.
Makes it easier to understand, as for example WithFatal() would be enough to enable the fatal mode. WithFatal(false) would explicitly set it to false.

• Add a type to print with HEX formatted colors.
• Add functions to between RGB and HEX.

Add markdown printer

Add test coverage badge with Codecov.

Fade from one color over another or several others to a color.

Add a method to fade colors from one color to another.
Should return RGB format.

Show progress of Progressbar in the middle of the progressbar.

Export writer which formats input to colored text

Currently, the level is unused.

Each printer should have a WithTheme(theme Theme) function, which sets all styles to the given theme styles.

Depends on #49

Timer should show the time something needs

Remove Version constant

This must be done in the CI system, appending the Restarting... spinner text to the end of the generated JSON with calculated timestamps.

Make new icon before v1.0.0 is released. Icon will be used by the organization profile and in the README.md.

Icon must be released under CC0 or similar.

Add Issue templates

Try to make Style accept RGB values.

Implement TextPrinter interface in RGB.

Currently, the examples need some time to restart. It would be more convenient if they would restart without showing a blank screen between.

This change affects the CI System in ./ci.

Add timer to spinner end.

Progressbar doesn't finish if the program finishes before incrementing the last task.
Results in 99%

Add CSV support to TablePrinter

Make examples look better and refactor them + docs.

ListPrinter should implement TextPrinter. Should be able to print leveled lists.

Example:

- Level one
  - Level two
- This is an example
  - level 2
    - level 3

should print:

• Level one
  • Level two
• This is an example
  • level 2
    • level 3

The CI System is located here: https://github.com/pterm/pterm/blob/master/ci/main.go
This program is executed on each push and updates the animations of the individual components. Since a goroutine is started for each component, it is a bit tricky to arrange the console output.

The goal of this ticket is to output errors that happen during the generation and make the action fail.

Add todo list to PR template which includes testing, etc.

Replace Theme White values with Default where possible.

Add a list of features to readme. List items should be linked to an example in the readme.

Add DisableOutput() and EnableOutput(). Those functions should set DisableOutput accordingly.
Also, tests should be added, to check if disabled output does not print anything.
Note: There are methods in ./internal/test_utils.go which can check the output of code.