Releases: ewels/rich-click
Releases · ewels/rich-click
v1.8.4
v1.8.3
v1.8.2
v1.8.1
v1.8.0
- Add
--rich-config
and--output
options to therich-click
CLI. - Lazy load Rich to reduce overhead when not rendering help text. [#154]
- Some internal refactors. These refactors are aimed at making the abstractions more maintainable over time, more consistent, and more adept for advanced used cases.
rich_click.py
is exclusively the global config; all formatting has been moved torich_help_rendering.py
.RichCommand
now makes use of methods in the super class:format_usage
,format_help_text
,format_options
, andformat_epilog
.- Global
formatter
object has been removed from the code. highlighter
is now constructed by theRichHelpFormatter
rather than being inside the config object.
- Added
RichHelpConfiguration.load_from_globals()
classmethod, which pulls all configuration fromrich_click.py
. - Fix bug with regex highlighter for options and switches.
RichHelpConfiguration()
is now asserted to be JSON serializable, as an option for porting configurations. That said, serialization is not a fully supported feature of the high-level API, so serialize the config at your own risk.- Related:
highlighter
is now deprecated inRichHelpConfiguration
; please usehighlighter_patterns
instead.
- Related:
- Moved exclusively to
pyproject.toml
and removedsetup.py
/setup.cfg
; thank you @Stealthii! - Moved to
text_markup: Literal["markdown", "rich", "ansi", None]
instead of booleans.- The default is now
ansi
instead ofNone
to help support usage ofclick.style()
.None
is still supported.
- The default is now
- Fixed issue where error messages would not print to
stderr
by default. - New configuration options: [#178]
STYLE_OPTIONS_PANEL_BOX
STYLE_COMMANDS_PANEL_BOX
STYLE_ERRORS_PANEL_BOX
- Many quality of life improvements for command and option groups:
- Support both
command_path
andcommand.name
. - Added wildcard (
*
) option for command groups and option groups, with thanks to @ITProKyle! - Resolve duplicates.
- Better typing for option groups and command groups with
TypedDict
[#156] - Added
panel_styles
support to groups. [#178] - Allow
table_styles
andpanel_styles
to be defined for the positional arguments group.
- Support both
v1.8.0dev7
Using __version__
instead of importlib
for the Click version check vastly improves performance.
v1.8.0dev6
- Significant improvements to styling for panels.
v1.8.0dev5
- Some quality of life improvements for command and option groups:
- Support both
ctx.command_path
andcommand.name
- Added wildcard (
*
) option for command groups and option groups, with thanks to @ITProKyle! - Resolve duplicates.
- Support both
v1.8.0dev4
- Mistake
v1.8.0dev3
- Fixed issue where error messages would not print to
stderr
by default.