Add rendering of rule markdown for terminal output #2747

ngnpope · 2023-02-10T22:13:52Z

Add rendering of rule markdown for terminal output

This is achieved by making use of the mdcat crate.

See the following links for details:

I'm a rust newbie, so this was interesting...

I thought to look to implement support for piping to a pager, which is implemented in mdcat - the source could be used for guidance on how to achieve that. But I wasn't sure whether that would be better implemented as a global option? This is enough for now and a vast improvement on the current output.

I also implemented support for NO_COLOR which will also give better output.

crates/ruff/src/rules/flake8_pyi/rules.rs

charliermarsh · 2023-02-10T22:21:11Z

Thank you for putting this together! The images look really nice. Excited to review.

Is there any way to force it to output raw markdown? We may want to preserve that option somehow.

ngnpope · 2023-02-10T22:50:14Z

Is there any way to force it to output raw markdown? We may want to preserve that option somehow.

Yup. Just coming up with something now...

ngnpope · 2023-02-10T23:38:55Z

Bedtime for me 😴 Enjoy!

charliermarsh · 2023-02-11T17:48:32Z

crates/ruff_cli/src/commands.rs

+
+    match format {
+        HelpFormat::Text => {
+            let parser = Parser::new_ext(


Ironically I expected HelpFormat::Text to be the "raw text" and HelpFormat::Markdown to be the "rendered Markdown".

Thinking about it more... I do think it makes sense for --format text to render as plain-text, and --format markdown to render with mdcat. We could then make --format markdown the default. What do you think?

Sure. I won't be able to get around to it for a few days, so feel free to rejig - should be straightforward🙂

Okay cool, will do :)

This is achieved by making use of the `mdcat` crate. See the following links for details: - https://crates.io/crates/mdcat - https://github.com/swsnr/mdcat - https://docs.rs/mdcat/latest/mdcat/

These were raised when following the commands in the contributing documentation.

This restores the raw markdown output for the `rule` subcommand. Because the `linter` subcommand shares `HelpFormat`, I decided to implement some markdown output for that command too to avoid copying and pasting `HelpFormat`.

not-my-profile · 2023-02-12T03:22:41Z

crates/ruff_cli/src/args.rs

@@ -284,6 +284,7 @@ pub struct CheckArgs {
 pub enum HelpFormat {
    Text,
    Json,
+    Markdown,


I think we should definitely choose a different name for this new format.

Because it's actually the text format that prints Markdown. The new format doesn't print Markdown but some rich text with escape sequences and special formatting. That it uses "mdcat" under the hood is only an implementation detail.

Maybe pretty? (inspired by the git pretty formats)

Opened #2797 to address this.

charliermarsh reviewed Feb 10, 2023

View reviewed changes

crates/ruff/src/rules/flake8_pyi/rules.rs Outdated Show resolved Hide resolved

ngnpope force-pushed the rule-command-improvements branch from 1c99135 to 9534bfa Compare February 10, 2023 22:24

ngnpope force-pushed the rule-command-improvements branch 2 times, most recently from 6632896 to b0ca115 Compare February 10, 2023 23:33

ngnpope requested review from charliermarsh and removed request for charliermarsh February 10, 2023 23:34

charliermarsh reviewed Feb 11, 2023

View reviewed changes

ngnpope and others added 5 commits February 11, 2023 21:10

Add dependency on mdcat, syntect, and pulldown-cmark

c7304b3

Add rendering of rule markdown for terminal output

281feb9

This is achieved by making use of the `mdcat` crate. See the following links for details: - https://crates.io/crates/mdcat - https://github.com/swsnr/mdcat - https://docs.rs/mdcat/latest/mdcat/

Fix existing issues raised by clippy

da06ccc

These were raised when following the commands in the contributing documentation.

Add --format=markdown for rule and linter subcommands

4549f1d

This restores the raw markdown output for the `rule` subcommand. Because the `linter` subcommand shares `HelpFormat`, I decided to implement some markdown output for that command too to avoid copying and pasting `HelpFormat`.

Make Markdown the default

358c6ab

charliermarsh force-pushed the rule-command-improvements branch from b0ca115 to 358c6ab Compare February 12, 2023 02:24

charliermarsh enabled auto-merge (squash) February 12, 2023 02:27

charliermarsh merged commit 551b810 into astral-sh:main Feb 12, 2023

not-my-profile reviewed Feb 12, 2023

View reviewed changes

ngnpope deleted the rule-command-improvements branch February 12, 2023 10:10

messense mentioned this pull request Feb 16, 2023

Put image behind a feature gate swsnr/mdcat#237

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rendering of rule markdown for terminal output #2747

Add rendering of rule markdown for terminal output #2747

ngnpope commented Feb 10, 2023

charliermarsh commented Feb 10, 2023 •

edited

Loading

ngnpope commented Feb 10, 2023

ngnpope commented Feb 10, 2023

charliermarsh Feb 11, 2023

charliermarsh Feb 11, 2023 •

edited

Loading

ngnpope Feb 11, 2023

charliermarsh Feb 11, 2023

not-my-profile Feb 12, 2023

not-my-profile Feb 12, 2023

not-my-profile Feb 12, 2023

ngnpope Feb 12, 2023

Add rendering of rule markdown for terminal output #2747

Add rendering of rule markdown for terminal output #2747

Conversation

ngnpope commented Feb 10, 2023

charliermarsh commented Feb 10, 2023 • edited Loading

ngnpope commented Feb 10, 2023

ngnpope commented Feb 10, 2023

charliermarsh Feb 11, 2023

Choose a reason for hiding this comment

charliermarsh Feb 11, 2023 • edited Loading

Choose a reason for hiding this comment

ngnpope Feb 11, 2023

Choose a reason for hiding this comment

charliermarsh Feb 11, 2023

Choose a reason for hiding this comment

not-my-profile Feb 12, 2023

Choose a reason for hiding this comment

not-my-profile Feb 12, 2023

Choose a reason for hiding this comment

not-my-profile Feb 12, 2023

Choose a reason for hiding this comment

ngnpope Feb 12, 2023

Choose a reason for hiding this comment

charliermarsh commented Feb 10, 2023 •

edited

Loading

charliermarsh Feb 11, 2023 •

edited

Loading