From f5a3c90288bfa94cf521a972f7ffe6af9f346130 Mon Sep 17 00:00:00 2001
From: Martin Fischer <martin@push-f.com>
Date: Sun, 12 Feb 2023 05:06:03 +0100
Subject: [PATCH] Rename new `ruff rule` output format to "pretty"

The new `ruff rule` output format introduced in
551b810aebb86f396e4c45a8b6b4406a8cf8cf71 doesn't print Markdown but
rather some rich text with escape sequences for colors and links,
it's actually the "text" format that prints Markdown, so naming the new
format "markdown" is very confusing. This commit therefore renames it to
"pretty".

This isn't a breaking change since there hasn't been a release yet.
---
 crates/ruff_cli/src/args.rs            | 4 ++--
 crates/ruff_cli/src/commands/linter.rs | 2 +-
 crates/ruff_cli/src/commands/rule.rs   | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/crates/ruff_cli/src/args.rs b/crates/ruff_cli/src/args.rs
index 302277050e..784f0a9236 100644
--- a/crates/ruff_cli/src/args.rs
+++ b/crates/ruff_cli/src/args.rs
@@ -41,7 +41,7 @@ pub enum Command {
         rule: Rule,
 
         /// Output format
-        #[arg(long, value_enum, default_value = "markdown")]
+        #[arg(long, value_enum, default_value = "pretty")]
         format: HelpFormat,
     },
     /// List all supported upstream linters
@@ -284,7 +284,7 @@ pub struct CheckArgs {
 pub enum HelpFormat {
     Text,
     Json,
-    Markdown,
+    Pretty,
 }
 
 #[allow(clippy::module_name_repetitions)]
diff --git a/crates/ruff_cli/src/commands/linter.rs b/crates/ruff_cli/src/commands/linter.rs
index e2439e930d..1e90bbe18d 100644
--- a/crates/ruff_cli/src/commands/linter.rs
+++ b/crates/ruff_cli/src/commands/linter.rs
@@ -64,7 +64,7 @@ pub fn linter(format: HelpFormat) -> Result<()> {
             output.push('\n');
         }
 
-        HelpFormat::Markdown => {
+        HelpFormat::Pretty => {
             output.push_str(&format!("| {:>6} | {:<27} |\n", "Prefix", "Name"));
             output.push_str(&format!("| {:>6} | {:<27} |\n", "------", "-".repeat(27)));
 
diff --git a/crates/ruff_cli/src/commands/rule.rs b/crates/ruff_cli/src/commands/rule.rs
index 388886f996..5080f49f3f 100644
--- a/crates/ruff_cli/src/commands/rule.rs
+++ b/crates/ruff_cli/src/commands/rule.rs
@@ -27,7 +27,7 @@ pub fn rule(rule: &Rule, format: HelpFormat) -> Result<()> {
     let mut output = String::new();
 
     match format {
-        HelpFormat::Text | HelpFormat::Markdown => {
+        HelpFormat::Text | HelpFormat::Pretty => {
             output.push_str(&format!("# {} ({})", rule.as_ref(), rule.code()));
             output.push('\n');
             output.push('\n');
@@ -69,7 +69,7 @@ pub fn rule(rule: &Rule, format: HelpFormat) -> Result<()> {
         HelpFormat::Json | HelpFormat::Text => {
             writeln!(stdout, "{output}")?;
         }
-        HelpFormat::Markdown => {
+        HelpFormat::Pretty => {
             let parser = Parser::new_ext(
                 &output,
                 Options::ENABLE_TASKLISTS | Options::ENABLE_STRIKETHROUGH,