gitlab-glfm-markdown 0.0.33-x86_64-darwin → 0.0.34-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20eaa14c53a9970e4870679286f3addfb10676d39033f17eedff422597fc8f0
-  data.tar.gz: efd173250835350cac332e213990fbf6f023c038825035393f7bf3ad3215f2e7
+  metadata.gz: d44ed632f02ab1f68d423c7484cee9b6f15c1d925f90494b8eb0593da3ec83d5
+  data.tar.gz: dd7b68dd0b730c552f56d3ad39d2926aef3261c9093e212ab6fdf76c449e04b4
 SHA512:
-  metadata.gz: 6921ae0da0d6a4d61c14f3f624cee83268f5543665f755ce44126fc292a4c94ba48dacc2dc776b6195c64b377f615f0826faa8aebfd094fcd95d32e4e0dd94aa
-  data.tar.gz: 1c02eeeb45ef6e51c573dca28949a7f2a96b26d1ac0944a9769e6db0a6d27b50425f195113f9737d5d857bf8f72f69b3faaa9cf801f78a8d73f91ffa357934c2
+  metadata.gz: ad511a2859c548337bdc2e88f3159bec6eccbbe254e53901d99a64bb828a497e8db333c19f1ef3a5d6d2319bd502d13eadcb6af72fce7ab17729df69a939e775
+  data.tar.gz: ee007658a9f16ab00968a10101a6ad4bf5487c2c4f64e22f4a19836c3808e820c0c4705e4f17348a74350515cfef2d508015cf7f6a35feebcca65d7f9d663700

data/Cargo.lock

@@ -227,9 +227,9 @@ checksum = "b05b61dc5112cbb17e4b6cd61790d9845d13888356391624cbe7e41efeac1e75"
 
 [[package]]
 name = "comrak"
-version = "0.40.0"
+version = "0.41.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32c3278f396e5707769a68bc0943e9b8f84a172836b173827810918279621747"
+checksum = "9a45df55bc7f91b899160098a7c9b35d6e575dfb4fe22100f014b41a171af2c6"
 dependencies = [
  "caseless",
  "emojis",
@@ -320,7 +320,7 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
 [[package]]
 name = "glfm_markdown"
-version = "0.0.33"
+version = "0.0.34"
 dependencies = [
  "clap",
  "comrak",

data/README.md

@@ -5,7 +5,7 @@
 
 Implements GLFM (as used by GitLab) using the Rust-based markdown parser [comrak](https://github.com/kivikakk/comrak)
 and providing a Ruby interface.\
-_Currently using `comrak 0.40.0`_.
+_Currently using `comrak 0.41.1`_.
 
 This project is still in constant flux, so interfaces and functionality can change at any time.
 
@@ -95,7 +95,7 @@ of Ruby for the project and the gem. Otherwise you can see unexplained errors wh
 calling into the gem.
 
 NOTE: This project generates a changelog automatically that gets attached to the release entry.
-The normal [GitLab changelog entry process](https://docs.gitlab.com/ee/development/changelog.html)
+The normal [GitLab changelog entry process](https://docs.gitlab.com/development/changelog.html)
 should be followed.
 
 ### Releasing a new version

data/ext/glfm_markdown/Cargo.lock

@@ -227,9 +227,9 @@ checksum = "b05b61dc5112cbb17e4b6cd61790d9845d13888356391624cbe7e41efeac1e75"
 
 [[package]]
 name = "comrak"
-version = "0.40.0"
+version = "0.41.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32c3278f396e5707769a68bc0943e9b8f84a172836b173827810918279621747"
+checksum = "9a45df55bc7f91b899160098a7c9b35d6e575dfb4fe22100f014b41a171af2c6"
 dependencies = [
  "caseless",
  "emojis",
@@ -320,7 +320,7 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
 [[package]]
 name = "glfm_markdown"
-version = "0.0.33"
+version = "0.0.34"
 dependencies = [
  "clap",
  "comrak",

data/ext/glfm_markdown/Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "glfm_markdown"
-version = "0.0.33"
+version = "0.0.34"
 edition = "2021"
-authors = ["digitalmoksha <bwalker@gitlab.com>"]
+authors = ["digitalmoksha <bwalker@gitlab.com>", "Asherah Connor <aconnor@gitlab.com>"]
 description = "GitLab Flavored Markdown parser and formatter. 100% CommonMark-compatible. Experimental."
 publish = false
 
@@ -15,7 +15,7 @@ required-features = ["cli"]
 
 [dependencies]
 clap = { version = "=4.4.18", optional = true, features = ["derive", "string"] }
-comrak = { version = "0.40.0", default-features = false, features = ["shortcodes"] }
+comrak = { version = "0.41.1", default-features = false, features = ["shortcodes"] }
 magnus = "0.6.2"
 rb-sys = { version = "0.9.86", default-features = false, features = ["stable-api-compiled-fallback"] }
 regex = "1.11.1"

data/ext/glfm_markdown/src/glfm.rs

@@ -1,16 +1,16 @@
-use comrak::html::{ChildRendering, Context};
+use std::io::{self, Write};
+
+use comrak::html::{collect_text, format_node_default, render_sourcepos, ChildRendering, Context};
 use comrak::nodes::{AstNode, ListType, NodeValue};
 use comrak::{create_formatter, html, parse_document, Arena, Plugins};
 use lazy_static::lazy_static;
 use regex::Regex;
-use std::io;
-use std::io::{BufWriter, Write};
 
 lazy_static! {
     static ref PLACEHOLDER_REGEX: Regex = Regex::new(r"%(\{|%7B)(\w{1,30})(}|%7D)").unwrap();
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug)]
 pub struct RenderOptions {
     pub alerts: bool,
     pub autolink: bool,
@@ -148,11 +148,11 @@ fn render_with_plugins(text: String, render_options: RenderOptions, plugins: &Pl
 
     let arena = Arena::new();
     let root = parse_document(&arena, &text, &options);
-    let mut bw = BufWriter::new(Vec::new());
 
+    let mut bw = Vec::new();
     CustomFormatter::format_document_with_plugins(root, &options, &mut bw, plugins, user_data)
         .unwrap();
-    String::from_utf8(bw.into_inner().unwrap()).unwrap()
+    String::from_utf8(bw).unwrap()
 }
 
 // The important thing to remember is that this overrides the default behavior of the
@@ -177,7 +177,10 @@ create_formatter!(CustomFormatter<RenderUserData>, {
     },
     NodeValue::TaskItem(_) => |context, node, entering| {
         return render_task_item(context, node, entering);
-    }
+    },
+    NodeValue::Heading(_) => |context, node, entering| {
+        return render_heading(context, node, entering);
+    },
 });
 
 fn render_image<'a>(
@@ -186,7 +189,7 @@ fn render_image<'a>(
     entering: bool,
 ) -> io::Result<ChildRendering> {
     let NodeValue::Image(ref nl) = node.data.borrow().value else {
-        panic!("Attempt to render invalid node as image")
+        unreachable!()
     };
 
     if !(context.user.placeholder_detection && PLACEHOLDER_REGEX.is_match(nl.url.as_str())) {
@@ -243,7 +246,7 @@ fn render_link<'a>(
     entering: bool,
 ) -> io::Result<ChildRendering> {
     let NodeValue::Link(ref nl) = node.data.borrow().value else {
-        panic!("Attempt to render invalid node as link")
+        unreachable!()
     };
 
     if !(context.user.placeholder_detection && PLACEHOLDER_REGEX.is_match(nl.url.as_str())) {
@@ -303,7 +306,7 @@ fn render_list<'a>(
     }
 
     let NodeValue::List(ref nl) = node.data.borrow().value else {
-        panic!("Attempt to render invalid node as list")
+        unreachable!()
     };
 
     context.cr()?;
@@ -344,7 +347,7 @@ fn render_task_item<'a>(
     }
 
     let NodeValue::TaskItem(symbol) = node.data.borrow().value else {
-        panic!("Attempt to render invalid node as task item")
+        unreachable!()
     };
 
     if symbol.is_none() || matches!(symbol, Some('x' | 'X')) {
@@ -393,13 +396,14 @@ fn render_task_item<'a>(
 
     Ok(ChildRendering::HTML)
 }
+
 fn render_text<'a>(
     context: &mut Context<RenderUserData>,
     node: &'a AstNode<'a>,
     entering: bool,
 ) -> io::Result<ChildRendering> {
     let NodeValue::Text(ref literal) = node.data.borrow().value else {
-        panic!("Attempt to render invalid node as text")
+        unreachable!()
     };
 
     if !(context.user.placeholder_detection && PLACEHOLDER_REGEX.is_match(literal)) {
@@ -441,3 +445,45 @@ fn render_text<'a>(
 
     Ok(ChildRendering::HTML)
 }
+
+fn render_heading<'a>(
+    context: &mut Context<RenderUserData>,
+    node: &'a AstNode<'a>,
+    entering: bool,
+) -> io::Result<ChildRendering> {
+    let NodeValue::Heading(ref nh) = node.data.borrow().value else {
+        unreachable!()
+    };
+
+    match context.plugins.render.heading_adapter {
+        None => {
+            // Overrides the default handling in order to render the heading text
+            // inside the anchor tag to better support screen readers
+            if entering {
+                context.cr()?;
+                write!(context, "<h{}", nh.level)?;
+                render_sourcepos(context, node)?;
+                context.write_all(b">")?;
+
+                if let Some(ref prefix) = context.options.extension.header_ids {
+                    let mut text_content = Vec::with_capacity(20);
+                    collect_text(node, &mut text_content);
+
+                    let mut id = String::from_utf8(text_content).unwrap();
+                    id = context.anchorizer.anchorize(id);
+                    write!(
+                        context,
+                        r##"<a href="#{id}" class="anchor" id="{prefix}{id}">"##
+                    )?;
+                }
+            } else {
+                if context.options.extension.header_ids.is_some() {
+                    write!(context, "</a>")?;
+                }
+                writeln!(context, "</h{}>", nh.level)?;
+            }
+            Ok(ChildRendering::HTML)
+        }
+        Some(_adapter) => format_node_default(context, node, entering),
+    }
+}

data/lib/glfm_markdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GLFMMarkdown
-  VERSION = '0.0.33'
+  VERSION = '0.0.34'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-glfm-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.33
+  version: 0.0.34
 platform: x86_64-darwin
 authors:
 - Brett Walker
+- Asherah Connor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -55,6 +56,7 @@ dependencies:
 description: Markdown processing for GitLab Flavored Markdown
 email:
 - bwalker@gitlab.com
+- aconnor@gitlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []