gitlab-glfm-markdown 0.0.32 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8783e3abd91c5a60248453cd6adfd4fe025a6be5fcd4288708117cb91fe57628
-  data.tar.gz: cb1a1880c09f4aeae9849682f5452c4aa01cf7d751ab880372b13ebd92efc8f0
+  metadata.gz: fb8448f904c8d824f877414066a5958e72eda7bd405af187c8093ffb88c1763c
+  data.tar.gz: 26244206863034e94f575db9678c4a97bae736ce8010fc49c849142d8648fdfc
 SHA512:
-  metadata.gz: f2378222831599e70ef3e4b4357ff5b95bb088218de7a0ce7a59ba899a3056f75fa10b13b3e66473ce7e0bcd8df3d8d31dee21074cc43b1574c58a478890f3d4
-  data.tar.gz: 3a196f9875eae6c768eb0a6d9f90ea46399c2d53aa3b0f468784e1564228828b1c48e48d5ed5630b199ba03b0713ec98c546e6267ab9760548512bdcdf8128f0
+  metadata.gz: bf82fe75c037f4a8e22015f4bcddb1fd45d9ebdb08640322a0770b16a1d4cedae41008c318213e2ed2292dfbf240102fcf09484f0b20abf34c48685f6cd6bbd5
+  data.tar.gz: 7dcee4806c5acecf184bad92b2cdfc980a114cc84ab05bb31a22db34c51b3f059cd6268fc65f13a9f73a15eec7c95c537870054d420bb9ba77751ab9eb95ff6e

data/Cargo.lock

@@ -227,9 +227,9 @@ checksum = "b05b61dc5112cbb17e4b6cd61790d9845d13888356391624cbe7e41efeac1e75"
 
 [[package]]
 name = "comrak"
-version = "0.39.1"
+version = "0.40.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2fefab951771fc3beeed0773ce66a4f7b706273fc6c4c95b08dd1615744abcf5"
+checksum = "32c3278f396e5707769a68bc0943e9b8f84a172836b173827810918279621747"
 dependencies = [
  "caseless",
  "emojis",
@@ -320,7 +320,7 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
 [[package]]
 name = "glfm_markdown"
-version = "0.0.32"
+version = "0.0.33"
 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.39.1`_.
+_Currently using `comrak 0.40.0`_.
 
 This project is still in constant flux, so interfaces and functionality can change at any time.
 
@@ -32,43 +32,45 @@ GLFMMarkdown.to_html('# header', options: { sourcepos: true })
 
 ### Options
 
-| Option name                    | Description                                                                                                                                                                 |
-|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `autolink`                     | Enable the `autolink` extension                                                                                                                                             |
-| `description_lists`            | Enable the `description-lists` extension                                                                                                                                    |
-| `escape`                       | Escape raw HTML instead of clobbering it                                                                                                                                    |
-| `escape_char_spans`            | Wrap escaped characters in a `<span>` to allow any post-processing to recognize them                                                                                        |
-| `figure_with_caption`          | Render the image as a figure element with the title as its caption                                                                                                          |
-| `footnotes`                    | Enable the `footnotes` extension                                                                                                                                            |
-| `full_info_string`             | Enable full info strings for code blocks                                                                                                                                    |
-| `gemojis`                      | Enable the `gemojis` extensions - translate gemojis into UTF-8 characters                                                                                                   |
-| `gfm_quirks`                   | Enables GFM-style quirks in output HTML, such as not nesting <strong> tags                                                                                                  |
-| `github_pre_lang`              | Use GitHub-style `<pre lang>` for code blocks                                                                                                                               |
-| `greentext`                    | Enable the `greentext` extension - requires at least one space after a `>` character to generate a blockquote, and restarts blockquote nesting across unique lines of input |
-| `hardbreaks`                   | Treat newlines as hard line breaks                                                                                                                                          |
-| `header_ids <PREFIX>`          | Enable the `header-id` extension, with the given ID prefix                                                                                                                  |
-| `ignore_empty_links`           | Ignore empty links in input                                                                                                                                                 |
-| `ignore_setext`                | Ignore setext headings in input                                                                                                                                             |
-| `math_code`                    | Enables `math code` extension, using math code syntax                                                                                                                       |
-| `math_dollars`                 | Enables `math dollars` extension, using math dollar syntax                                                                                                                  |
-| `multiline_block_quotes`       | Enable the `multiline-block-quotes` extension                                                                                                                               |
-| `default_html`                 | Disables any custom HTML, and returns default HTML from `comrak`                                                                                                             |
-| `placeholder_detection`        | Detect placeholder variables in the format `%{placeholder}`                                                                                                                 |
-| `relaxed_autolinks`            | Enable relaxing of autolink parsing, allowing links to be recognized when in brackets                                                                                       |
-| `relaxed_tasklist_character`   | Enable relaxing which character is allowed in tasklists                                                                                                                     |
-| `sourcepos`                    | Include source mappings in HTML attributes                                                                                                                                  |
-| `smart`                        | Use smart punctuation                                                                                                                                                       |
-| `spoiler`                      | Enable the `spoiler` extension - use double vertical bars                                                                                                                   |
-| `strikethrough`                | Enable the `strikethrough` extension                                                                                                                                        |
-| `superscript`                  | Enable the `superscript` extension                                                                                                                                          |
-| `table`                        | Enable the `table` extension                                                                                                                                                |
-| `tagfilter`                    | Enable the `tagfilter` extension                                                                                                                                            |
-| `tasklist`                     | Enable the `tasklist` extension                                                                                                                                             |
-| `underline`                    | Enables the `underline` extension - use double underscores                                                                                                                  |
-| `unsafe`                       | Allow raw HTML and dangerous URLs                                                                                                                                           |
-| `wikilinks_title_after_pipe`   | Enable the `wikilinks_title_after_pipe` extension                                                                                                                           |
-| `wikilinks_title_before_pipe`  | Enable the `wikilinks_title_before_pipe` extension                                                                                                                          |
-| `debug`                        | Show debug information                                                                                                                                                      |
+| Option name                   | Description                                                                                                                                                                 |
+|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `autolink`                    | Enable the `autolink` extension                                                                                                                                             |
+| `description_lists`           | Enable the `description-lists` extension                                                                                                                                    |
+| `escape`                      | Escape raw HTML instead of clobbering it                                                                                                                                    |
+| `escape_char_spans`           | Wrap escaped characters in a `<span>` to allow any post-processing to recognize them                                                                                        |
+| `figure_with_caption`         | Render the image as a figure element with the title as its caption                                                                                                          |
+| `footnotes`                   | Enable the `footnotes` extension                                                                                                                                            |
+| `full_info_string`            | Enable full info strings for code blocks                                                                                                                                    |
+| `gemojis`                     | Enable the `gemojis` extensions - translate gemojis into UTF-8 characters                                                                                                   |
+| `gfm_quirks`                  | Enables GFM-style quirks in output HTML, such as not nesting <strong> tags                                                                                                  |
+| `github_pre_lang`             | Use GitHub-style `<pre lang>` for code blocks                                                                                                                               |
+| `greentext`                   | Enable the `greentext` extension - requires at least one space after a `>` character to generate a blockquote, and restarts blockquote nesting across unique lines of input |
+| `hardbreaks`                  | Treat newlines as hard line breaks                                                                                                                                          |
+| `header_ids <PREFIX>`         | Enable the `header-id` extension, with the given ID prefix                                                                                                                  |
+| `ignore_empty_links`          | Ignore empty links in input                                                                                                                                                 |
+| `ignore_setext`               | Ignore setext headings in input                                                                                                                                             |
+| `inapplicable_tasks`          | Allow inapplicable tasks items. Must also set the `relaxed_tasklist_character` option.                                                                                      |
+| `math_code`                   | Enables `math code` extension, using math code syntax                                                                                                                       |
+| `math_dollars`                | Enables `math dollars` extension, using math dollar syntax                                                                                                                  |
+| `multiline_block_quotes`      | Enable the `multiline-block-quotes` extension                                                                                                                               |
+| `default_html`                | Disables any custom HTML, and returns default HTML from `comrak`                                                                                                            |
+| `placeholder_detection`       | Detect placeholder variables in the format `%{placeholder}`                                                                                                                 |
+| `relaxed_autolinks`           | Enable relaxing of autolink parsing, allowing links to be recognized when in brackets                                                                                       |
+| `relaxed_tasklist_character`  | Enable relaxing which character is allowed in tasklists                                                                                                                     |
+| `sourcepos`                   | Include source mappings in HTML attributes                                                                                                                                  |
+| `smart`                       | Use smart punctuation                                                                                                                                                       |
+| `spoiler`                     | Enable the `spoiler` extension - use double vertical bars                                                                                                                   |
+| `strikethrough`               | Enable the `strikethrough` extension                                                                                                                                        |
+| `superscript`                 | Enable the `superscript` extension                                                                                                                                          |
+| `table`                       | Enable the `table` extension                                                                                                                                                |
+| `tagfilter`                   | Enable the `tagfilter` extension                                                                                                                                            |
+| `tasklist`                    | Enable the `tasklist` extension                                                                                                                                             |
+| `tasklist_classes`            | Output classes on tasklist elements so that they can be styled with CSS                                                                                                     |
+| `underline`                   | Enables the `underline` extension - use double underscores                                                                                                                  |
+| `unsafe`                      | Allow raw HTML and dangerous URLs                                                                                                                                           |
+| `wikilinks_title_after_pipe`  | Enable the `wikilinks_title_after_pipe` extension                                                                                                                           |
+| `wikilinks_title_before_pipe` | Enable the `wikilinks_title_before_pipe` extension                                                                                                                          |
+| `debug`                       | Show debug information                                                                                                                                                      |
 
 ## Dingus / Demo
 

data/ext/glfm_markdown/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "glfm_markdown"
-version = "0.0.32"
+version = "0.0.33"
 edition = "2021"
 authors = ["digitalmoksha <bwalker@gitlab.com>"]
 description = "GitLab Flavored Markdown parser and formatter. 100% CommonMark-compatible. Experimental."
@@ -15,7 +15,7 @@ required-features = ["cli"]
 
 [dependencies]
 clap = { version = "=4.4.18", optional = true, features = ["derive", "string"] }
-comrak = { version = "0.39.1", default-features = false, features = ["shortcodes"] }
+comrak = { version = "0.40.0", 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,5 +1,5 @@
 use comrak::html::{ChildRendering, Context};
-use comrak::nodes::{AstNode, NodeValue};
+use comrak::nodes::{AstNode, ListType, NodeValue};
 use comrak::{create_formatter, html, parse_document, Arena, Plugins};
 use lazy_static::lazy_static;
 use regex::Regex;
@@ -45,14 +45,20 @@ pub struct RenderOptions {
     pub table: bool,
     pub tagfilter: bool,
     pub tasklist: bool,
+    pub tasklist_classes: bool,
     pub underline: bool,
     pub unsafe_: bool,
     pub wikilinks_title_after_pipe: bool,
     pub wikilinks_title_before_pipe: bool,
 
+    /// GLFM specific options
+
     /// Only use default comrak HTML formatting
     pub default_html: bool,
 
+    /// Detect inapplicable tasks (`- [~]`)
+    pub inapplicable_tasks: bool,
+
     /// Detect and mark potential placeholder variables, which
     /// have the format `%{PLACEHOLDER}`
     pub placeholder_detection: bool,
@@ -62,6 +68,7 @@ pub struct RenderOptions {
 
 pub struct RenderUserData {
     pub default_html: bool,
+    pub inapplicable_tasks: bool,
     pub placeholder_detection: bool,
     pub debug: bool,
 }
@@ -70,6 +77,7 @@ impl From<&RenderOptions> for RenderUserData {
     fn from(options: &RenderOptions) -> Self {
         RenderUserData {
             default_html: options.default_html,
+            inapplicable_tasks: options.inapplicable_tasks,
             placeholder_detection: options.placeholder_detection,
             debug: options.debug,
         }
@@ -112,6 +120,7 @@ impl From<&RenderOptions> for comrak::Options<'_> {
         comrak_options.render.ignore_empty_links = options.ignore_empty_links;
         comrak_options.render.ignore_setext = options.ignore_setext;
         comrak_options.render.sourcepos = options.sourcepos;
+        comrak_options.render.tasklist_classes = options.tasklist_classes;
         // comrak_options.render.syntax_highlighting = options.syntax_highlighting;
 
         comrak_options.render.unsafe_ = options.unsafe_;
@@ -162,6 +171,12 @@ create_formatter!(CustomFormatter<RenderUserData>, {
     },
     NodeValue::Image(_) => |context, node, entering| {
         return render_image(context, node, entering);
+    },
+    NodeValue::List(_) => |context, node, entering| {
+        return render_list(context, node, entering);
+    },
+    NodeValue::TaskItem(_) => |context, node, entering| {
+        return render_task_item(context, node, entering);
     }
 });
 
@@ -276,6 +291,108 @@ fn render_link<'a>(
     Ok(ChildRendering::HTML)
 }
 
+// Overridden to use class `task-list` instead of `contains-task-list`
+// to align with GitLab class usage
+fn render_list<'a>(
+    context: &mut Context<RenderUserData>,
+    node: &'a AstNode<'a>,
+    entering: bool,
+) -> io::Result<ChildRendering> {
+    if !entering || !context.options.render.tasklist_classes {
+        return html::format_node_default(context, node, entering);
+    }
+
+    let NodeValue::List(ref nl) = node.data.borrow().value else {
+        panic!("Attempt to render invalid node as list")
+    };
+
+    context.cr()?;
+    match nl.list_type {
+        ListType::Bullet => {
+            context.write_all(b"<ul")?;
+            if nl.is_task_list {
+                context.write_all(b" class=\"task-list\"")?;
+            }
+            html::render_sourcepos(context, node)?;
+            context.write_all(b">\n")?;
+        }
+        ListType::Ordered => {
+            context.write_all(b"<ol")?;
+            if nl.is_task_list {
+                context.write_all(b" class=\"task-list\"")?;
+            }
+            html::render_sourcepos(context, node)?;
+            if nl.start == 1 {
+                context.write_all(b">\n")?;
+            } else {
+                writeln!(context, " start=\"{}\">", nl.start)?;
+            }
+        }
+    }
+
+    Ok(ChildRendering::HTML)
+}
+
+// Overridden to detect inapplicable task list items
+fn render_task_item<'a>(
+    context: &mut Context<RenderUserData>,
+    node: &'a AstNode<'a>,
+    entering: bool,
+) -> io::Result<ChildRendering> {
+    if !context.user.inapplicable_tasks {
+        return html::format_node_default(context, node, entering);
+    }
+
+    let NodeValue::TaskItem(symbol) = node.data.borrow().value else {
+        panic!("Attempt to render invalid node as task item")
+    };
+
+    if symbol.is_none() || matches!(symbol, Some('x' | 'X')) {
+        return html::format_node_default(context, node, entering);
+    }
+
+    if entering {
+        // Handle an inapplicable task symbol.
+        if matches!(symbol, Some('~')) {
+            context.cr()?;
+            context.write_all(b"<li")?;
+            context.write_all(b" class=\"inapplicable")?;
+
+            if context.options.render.tasklist_classes {
+                context.write_all(b" task-list-item")?;
+            }
+            context.write_all(b"\"")?;
+
+            html::render_sourcepos(context, node)?;
+            context.write_all(b">")?;
+            context.write_all(b"<input type=\"checkbox\"")?;
+
+            if context.options.render.tasklist_classes {
+                context.write_all(b" class=\"task-list-item-checkbox\"")?;
+            }
+
+            context.write_all(b" data-inapplicable disabled=\"\"> ")?;
+        } else {
+            // Don't allow unsupported symbols to render a checkbox
+            context.cr()?;
+            context.write_all(b"<li")?;
+
+            if context.options.render.tasklist_classes {
+                context.write_all(b" class=\"task-list-item\"")?;
+            }
+
+            html::render_sourcepos(context, node)?;
+            context.write_all(b">")?;
+            context.write_all(b"[")?;
+            context.escape(symbol.unwrap().to_string().as_bytes())?;
+            context.write_all(b"] ")?;
+        }
+    } else {
+        context.write_all(b"</li>\n")?;
+    }
+
+    Ok(ChildRendering::HTML)
+}
 fn render_text<'a>(
     context: &mut Context<RenderUserData>,
     node: &'a AstNode<'a>,

data/ext/glfm_markdown/src/lib.rs

@@ -33,6 +33,7 @@ pub fn render_to_html_rs(text: String, options: RHash) -> String {
         header_ids: get_string_opt("header_ids", options),
         ignore_empty_links: get_bool_opt("ignore_empty_links", options),
         ignore_setext: get_bool_opt("ignore_setext", options),
+        inapplicable_tasks: get_bool_opt("inapplicable_tasks", options),
         math_code: get_bool_opt("math_code", options),
         math_dollars: get_bool_opt("math_dollars", options),
         multiline_block_quotes: get_bool_opt("multiline_block_quotes", options),
@@ -48,6 +49,7 @@ pub fn render_to_html_rs(text: String, options: RHash) -> String {
         table: get_bool_opt("table", options),
         tagfilter: get_bool_opt("tagfilter", options),
         tasklist: get_bool_opt("tasklist", options),
+        tasklist_classes: get_bool_opt("tasklist_classes", options),
         underline: get_bool_opt("underline", options),
         unsafe_: get_bool_opt("unsafe", options),
         wikilinks_title_after_pipe: get_bool_opt("wikilinks_title_after_pipe", options),

data/ext/glfm_markdown/src/main.rs

@@ -146,6 +146,10 @@ struct Args {
     #[arg(long)]
     tasklist: bool,
 
+    /// Output classes on tasklist elements so that they can be styled with CSS
+    #[arg(long)]
+    tasklist_clases: bool,
+
     /// Enables underlines using double underscores
     #[arg(long)]
     underline: bool,
@@ -166,6 +170,12 @@ struct Args {
     #[arg(long)]
     default_html: bool,
 
+    /// GLFM specific options
+
+    /// Detect inapplicable tasks (`- [~]`)
+    #[arg(long)]
+    inapplicable_tasks: bool,
+
     /// Detect and marks potential placeholder variables, which
     /// have the format `%{PLACEHOLDER}`
     #[arg(long)]
@@ -209,6 +219,7 @@ fn main() {
         header_ids: cli.header_ids,
         ignore_empty_links: cli.ignore_empty_links,
         ignore_setext: cli.ignore_setext,
+        inapplicable_tasks: cli.inapplicable_tasks,
         math_code: cli.math_code,
         math_dollars: cli.math_dollars,
         multiline_block_quotes: cli.multiline_block_quotes,
@@ -224,6 +235,7 @@ fn main() {
         table: cli.table,
         tagfilter: cli.tagfilter,
         tasklist: cli.tasklist,
+        tasklist_classes: cli.tasklist_classes,
         underline: cli.underline,
         unsafe_: cli.unsafe_,
         wikilinks_title_after_pipe: cli.wikilinks_title_after_pipe,

data/lib/glfm_markdown/version.rb

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

data/lib/glfm_markdown.rb

@@ -14,6 +14,7 @@ module GLFMMarkdown
     gfm_quirks: true,
     github_pre_lang: false,
     hardbreaks: false,
+    inapplicable_tasks: false,
     math_code: false,
     math_dollars: false,
     multiline_block_quotes: true,
@@ -24,6 +25,7 @@ module GLFMMarkdown
     table: true,
     tagfilter: false,
     tasklist: true,
+    tasklist_classes: true,
     unsafe: true,
 
     debug: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-glfm-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.33
 platform: ruby
 authors:
 - Brett Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys