rich-click icon indicating copy to clipboard operation
rich-click copied to clipboard

`text_markup: Literal["rich", "markdown", "rst", None]` config option

Open dwreeves opened this issue 1 year ago • 3 comments

  • Add text_markup: Literal["rich", "markdown", "rst", None].
  • Add optional rich-click[rst] support via the rich-rst package. https://github.com/wasi-master/rich-rst Very small package, but seems fine, so an optional dependency would work.
  • Silently deprecate/discourage use_markdown: bool and use_rich_markup: bool.
    • I don't not think it is worth warning.warn()ing users about this one. This is the sort of thing I'd deprecate only on release of a rich-click==2.0.0. It's just too trivial to support the bool args, and I would feel bad warning polluting users' warnings with this one.
    • However, I do think we should start to warn users via UserWarning when there are conflicts in in the config, since only one can be supported at a time.
      enabled_markup_options = sum(map(bool, [self.use_rich_markup, self.use_markdown, self.use_rst]))
      if enabled_markup_options > 1:
          import warnings
          warnings.warn(...)
      if enabled_markup_options == 1 and self.text_markup is not None:
          import warnings
          warnings.warn(...)
      

dwreeves avatar Apr 08 '24 19:04 dwreeves

Oh no, this can't go out for 1.8. The rich-rst library has some issues that make it not play nicely with what we're doing. I will have to reach out to the owner of this library separately and see what we can do.

dwreeves avatar Apr 09 '24 00:04 dwreeves

rich-rst was fixed last I checked, and it can be something we support as an optional dependency, so should be straightforward as a 1.9 or even 1.8.x roadmap feature.

dwreeves avatar Nov 17 '24 22:11 dwreeves

One reason I want to add this in a 1.9 is because I like having a lot of fun and exciting features bundled together. It would be quite easy to add, but I think it should be marketed in the context of a bigger release.

dwreeves avatar Dec 03 '24 15:12 dwreeves