feat: Allow all titles to have IDs

Author: Muscraft

src/level.rs

@@ -74,9 +74,9 @@ impl<'a> Level<'a> {
     /// </div>
     pub fn header(self, header: &'a str) -> Message<'a> {
         Message {
-            id: None,
             groups: vec![Group::new().element(Element::Title(Title {
                 level: self,
+                id: None,
                 title: header,
                 is_pre_styled: false,
             }))],
@@ -93,6 +93,7 @@ impl<'a> Level<'a> {
     pub fn title(self, title: &'a str) -> Title<'a> {
         Title {
             level: self,
+            id: None,
             title,
             is_pre_styled: false,
         }
@@ -109,6 +110,7 @@ impl<'a> Level<'a> {
     pub fn pre_styled_title(self, title: &'a str) -> Title<'a> {
         Title {
             level: self,
+            id: None,
             title,
             is_pre_styled: true,
         }

src/renderer/mod.rs

@@ -338,13 +338,6 @@ impl Renderer {
                             title,
                             max_line_num_len,
                             title_style,
-                            message.id.as_ref().and_then(|id| {
-                                if g == 0 && i == 0 {
-                                    Some(id)
-                                } else {
-                                    None
-                                }
-                            }),
                             matches!(peek, Some(Element::Title(_))),
                             buffer_msg_line_offset,
                         );
@@ -524,7 +517,6 @@ impl Renderer {
             &title,
             0, // No line numbers in short messages
             TitleStyle::MainHeader,
-            message.id.as_ref(),
             false,
             0,
         );
@@ -546,7 +538,6 @@ impl Renderer {
         title: &Title<'_>,
         max_line_num_len: usize,
         title_style: TitleStyle,
-        id: Option<&Id<'_>>,
         is_cont: bool,
         buffer_msg_line_offset: usize,
     ) {
@@ -582,7 +573,7 @@ impl Renderer {
         if title.level.name != Some(None) {
             buffer.append(buffer_msg_line_offset, title.level.as_str(), label_style);
             label_width += title.level.as_str().len();
-            if let Some(Id { id: Some(id), url }) = id {
+            if let Some(Id { id: Some(id), url }) = title.id {
                 buffer.append(buffer_msg_line_offset, "[", label_style);
                 if let Some(url) = url.as_ref() {
                     buffer.append(

src/snippet.rs

@@ -13,7 +13,6 @@ pub(crate) const WARNING_TXT: &str = "warning";
 /// Top-level user message
 #[derive(Clone, Debug)]
 pub struct Message<'a> {
-    pub(crate) id: Option<Id<'a>>, // for "correctness", could be sloppy and be on Title
     pub(crate) groups: Vec<Group<'a>>,
 }
 
@@ -26,7 +25,15 @@ impl<'a> Message<'a> {
     ///
     /// </div>
     pub fn id(mut self, id: &'a str) -> Self {
-        self.id.get_or_insert(Id::default()).id = Some(id);
+        let Some(Element::Title(title)) =
+            self.groups.get_mut(0).and_then(|g| g.elements.first_mut())
+        else {
+            panic!(
+                "Expected first element to be a Title, got: {:?}",
+                self.groups
+            );
+        };
+        title.id.get_or_insert(Id::default()).id = Some(id);
         self
     }
 
@@ -36,7 +43,15 @@ impl<'a> Message<'a> {
     ///
     /// </div>
     pub fn id_url(mut self, url: &'a str) -> Self {
-        self.id.get_or_insert(Id::default()).url = Some(url);
+        let Some(Element::Title(title)) =
+            self.groups.get_mut(0).and_then(|g| g.elements.first_mut())
+        else {
+            panic!(
+                "Expected first element to be a Title, got: {:?}",
+                self.groups
+            );
+        };
+        title.id.get_or_insert(Id::default()).url = Some(url);
         self
     }
 
@@ -174,10 +189,41 @@ pub struct Padding;
 #[derive(Clone, Debug)]
 pub struct Title<'a> {
     pub(crate) level: Level<'a>,
+    pub(crate) id: Option<Id<'a>>,
     pub(crate) title: &'a str,
     pub(crate) is_pre_styled: bool,
 }
 
+impl<'a> Title<'a> {
+    /// <div class="warning">
+    ///
+    /// This is only relevant if the title is the first element of a group.
+    ///
+    /// </div>
+    /// <div class="warning">
+    ///
+    /// Text passed to this function is considered "untrusted input", as such
+    /// all text is passed through a normalization function. Pre-styled text is
+    /// not allowed to be passed to this function.
+    ///
+    /// </div>
+    pub fn id(mut self, id: &'a str) -> Self {
+        self.id.get_or_insert(Id::default()).id = Some(id);
+        self
+    }
+
+    /// <div class="warning">
+    ///
+    /// This is only relevant if the title is the first element of a group and
+    /// `id` present
+    ///
+    /// </div>
+    pub fn id_url(mut self, url: &'a str) -> Self {
+        self.id.get_or_insert(Id::default()).url = Some(url);
+        self
+    }
+}
+
 /// A source view [`Element`] in a [`Group`]
 ///
 /// If you do not have [source][Snippet::source] available, see instead [`Origin`]

tests/formatter.rs

@@ -2642,8 +2642,9 @@ fn main() {
             Group::new()
                 .element(
                     Level::HELP
-                        .text(Some("suggestion[S0123]"))
-                        .title("use `break` on its own without a value inside this `while` loop"),
+                        .text(Some("suggestion"))
+                        .title("use `break` on its own without a value inside this `while` loop")
+                        .id("S0123"),
                 )
                 .element(
                     Snippet::source(source)