fix: diagnostics in docs

Author: psteinroe

docs/codegen/src/rules_docs.rs

@@ -2,8 +2,8 @@ use anyhow::{bail, Result};
 use biome_string_case::Case;
 use pglt_analyse::{AnalyserOptions, AnalysisFilter, RuleFilter, RuleMetadata};
 use pglt_analyser::{Analyser, AnalyserConfig};
-use pglt_console::fmt::{Formatter, HTML};
-use pglt_console::markup;
+use pglt_console::fmt::{Display, Formatter, Termcolor};
+use pglt_diagnostics::termcolor::NoColor;
 use pglt_diagnostics::{Diagnostic, DiagnosticExt, PrintDiagnostic};
 use pglt_query_ext::diagnostics::SyntaxDiagnostic;
 use pglt_workspace::settings::Settings;
@@ -17,6 +17,28 @@ use std::{
     str::{self, FromStr},
 };
 
+/// TODO: get this from jules pr
+/// Adapter type providing a std::fmt::Display implementation for any type that
+/// implements pglt_console::fmt::Display.
+pub struct StdDisplay<T: Display>(pub T);
+
+impl<T> std::fmt::Display for StdDisplay<T>
+where
+    T: Display,
+{
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let mut buffer: Vec<u8> = Vec::new();
+        let mut termcolor = Termcolor(NoColor::new(&mut buffer));
+        let mut formatter = Formatter::new(&mut termcolor);
+
+        self.0.fmt(&mut formatter).map_err(|_| std::fmt::Error)?;
+
+        let content = String::from_utf8(buffer).map_err(|_| std::fmt::Error)?;
+
+        f.write_str(content.as_str())
+    }
+}
+
 /// Generates the documentation page for each lint rule.
 ///
 /// * `docs_dir`: Path to the docs directory.
@@ -75,7 +97,7 @@ fn generate_rule_doc(
         writeln!(content, "> [!NOTE]")?;
         writeln!(
             content,
-            "> - This rule is recommended. A diagnostic error will appear when linting your code."
+            "> This rule is recommended. A diagnostic error will appear when linting your code."
         )?;
     }
 
@@ -165,16 +187,13 @@ fn write_documentation(
 
                 if let Some((test, block)) = language.take() {
                     if test.expect_diagnostic {
-                        write!(
-                            content,
-                            "<pre class=\"language-text\"><code class=\"language-text\">"
-                        )?;
+                        writeln!(content, "```sh")?;
                     }
 
                     print_diagnostics(group, rule, &test, &block, content)?;
 
                     if test.expect_diagnostic {
-                        writeln!(content, "</code></pre>")?;
+                        writeln!(content, "```")?;
                         writeln!(content)?;
                     }
                 }
@@ -411,12 +430,10 @@ fn print_diagnostics(
 ) -> Result<()> {
     let file_path = format!("code-block.{}", test.tag);
 
-    let mut write = HTML::new(content).with_mdx();
-
     let mut write_diagnostic = |_: &str, diag: pglt_diagnostics::Error| -> Result<()> {
-        Formatter::new(&mut write).write_markup(markup! {
-            {PrintDiagnostic::verbose(&diag)}
-        })?;
+        let printer = PrintDiagnostic::simple(&diag);
+        writeln!(content, "{}", StdDisplay(printer)).unwrap();
+
         Ok(())
     };
     if test.ignore {

docs/rules/ban-drop-column.md

@@ -3,7 +3,7 @@
 
 **Since**: `vnext`
 > [!NOTE]
-> - This rule is recommended. A diagnostic error will appear when linting your code.
+> This rule is recommended. A diagnostic error will appear when linting your code.
 
 Sources: 
 - Inspired from: <a href="https://squawkhq.com/docs/ban-drop-column" target="_blank"><code>squawk/ban-drop-column</code></a>
@@ -23,7 +23,15 @@ You can leave the column as nullable or delete the column once queries no longer
 alter table test drop column id;
 ```
 
-<pre class="language-text"><code class="language-text">code-block.sql <a href="https://pglt.dev/linter/rules/ban-drop-column">lint/safety/banDropColumn</a> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br />  <strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">Dropping a column may break existing clients.</span><br />  <br />  <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">You can leave the column as nullable or delete the column once queries no longer select or modify the column.</span><br />  <br /></code></pre>
+```sh
+code-block.sql lint/safety/banDropColumn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  × Dropping a column may break existing clients.
+  
+  i You can leave the column as nullable or delete the column once queries no longer select or modify the column.
+  
+
+```
 
 ## How to configure
 ```toml title="pglt.toml"

docs/rules/ban-drop-not-null.md

@@ -3,7 +3,7 @@
 
 **Since**: `vnext`
 > [!NOTE]
-> - This rule is recommended. A diagnostic error will appear when linting your code.
+> This rule is recommended. A diagnostic error will appear when linting your code.
 
 Sources: 
 - Inspired from: <a href="https://squawkhq.com/docs/ban-drop-not-null" target="_blank"><code>squawk/ban-drop-not-null</code></a>
@@ -23,7 +23,15 @@ You can consider using a marker value that represents NULL. Alternatively, creat
 alter table users alter column email drop not null;
 ```
 
-<pre class="language-text"><code class="language-text">code-block.sql <a href="https://pglt.dev/linter/rules/ban-drop-not-null">lint/safety/banDropNotNull</a> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br />  <strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">Dropping a NOT NULL constraint may break existing clients.</span><br />  <br />  <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">Consider using a marker value that represents NULL. Alternatively, create a new table allowing NULL values, copy the data from the old table, and create a view that filters NULL values.</span><br />  <br /></code></pre>
+```sh
+code-block.sql lint/safety/banDropNotNull ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  × Dropping a NOT NULL constraint may break existing clients.
+  
+  i Consider using a marker value that represents NULL. Alternatively, create a new table allowing NULL values, copy the data from the old table, and create a view that filters NULL values.
+  
+
+```
 
 ## How to configure
 ```toml title="pglt.toml"