gitlab-glfm-markdown 0.0.16 → 0.0.18

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.23.0`_.
+_Currently using `comrak 0.27.0`_.
 
 This project is still in constant flux, so interfaces and functionality can change at any time.
 
@@ -32,31 +32,41 @@ 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  |
-| `footnotes`                  | Enable the `footnotes` extension                                                      |
-| `full_info_string`           | Enable full info strings for code blocks                                              |
-| `github_pre_lang`            | Use GitHub-style `<pre lang>` for code blocks                                         |
-| `hardbreaks`                 | Treat newlines as hard line breaks                                                    |
-| `header_ids <PREFIX>`        | Enable the `header-id` extension, with the given ID prefix                            |
-| `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                                         |
-| `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                                                                 |
-| `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                                                       |
-| `unsafe`                     | Allow raw HTML and dangerous URLs                                                     |
-| `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  |
+| `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                                         |
+| `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                                            |
+| `experimental_inline_sourcepos` | Include inline sourcepos in HTML output, which is known to have issues                |
+| `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                                                                |
 
 ## Dingus / Demo
 

data/ext/glfm_markdown/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "glfm_markdown"
-version = "0.0.16"
+version = "0.0.18"
 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.0", optional = true, features = ["derive", "string"] }
-comrak = { version = "0.23.0", default-features = false }
+comrak = { version = "0.27.0", default-features = false, features = ["shortcodes"] }
 magnus = "0.6.2"
 rb-sys = { version = "0.9.86", default-features = false, features = ["stable-api-compiled-fallback"] }
 

data/ext/glfm_markdown/src/glfm.rs

@@ -1,27 +1,40 @@
 #[derive(Debug)]
 pub struct RenderOptions {
     pub autolink: bool,
-    pub escape: bool,
+    // pub default_info_string: String,
     pub description_lists: bool,
+    pub escape: bool,
     pub escaped_char_spans: bool,
     pub footnotes: bool,
+    // pub front_matter_delimiter: String,
     pub full_info_string: bool,
+    pub gemojis: bool,
+    pub gfm_quirks: bool,
     pub github_pre_lang: bool,
+    pub greentext: bool,
     pub hardbreaks: bool,
     pub header_ids: Option<String>,
+    pub ignore_empty_links: bool,
+    pub ignore_setext: bool,
     pub math_code: bool,
     pub math_dollars: bool,
     pub multiline_block_quotes: bool,
     pub relaxed_autolinks: bool,
     pub relaxed_tasklist_character: bool,
     pub sourcepos: bool,
+    pub experimental_inline_sourcepos: bool,
     pub smart: bool,
+    pub spoiler: bool,
     pub strikethrough: bool,
     pub superscript: bool,
+    // pub syntax_highlighting: String,
     pub table: bool,
     pub tagfilter: bool,
     pub tasklist: bool,
+    pub underline: bool,
     pub unsafe_: bool,
+    pub wikilinks_title_after_pipe: bool,
+    pub wikilinks_title_before_pipe: bool,
 
     pub debug: bool,
 }
@@ -36,24 +49,38 @@ fn render_comrak(text: String, options: RenderOptions) -> String {
     comrak_options.extension.autolink = options.autolink;
     comrak_options.extension.description_lists = options.description_lists;
     comrak_options.extension.footnotes = options.footnotes;
+    // comrak_options.extension.front_matter_delimiter = options.front_matter_delimiter;
+    comrak_options.extension.greentext = options.greentext;
     comrak_options.extension.header_ids = options.header_ids;
     comrak_options.extension.math_code = options.math_code;
     comrak_options.extension.math_dollars = options.math_dollars;
     comrak_options.extension.multiline_block_quotes = options.multiline_block_quotes;
+    comrak_options.extension.shortcodes = options.gemojis;
+    comrak_options.extension.spoiler = options.spoiler;
     comrak_options.extension.strikethrough = options.strikethrough;
     comrak_options.extension.superscript = options.superscript;
     comrak_options.extension.table = options.table;
     comrak_options.extension.tagfilter = options.tagfilter;
     comrak_options.extension.tasklist = options.tasklist;
+    comrak_options.extension.underline = options.underline;
+    comrak_options.extension.wikilinks_title_after_pipe = options.wikilinks_title_after_pipe;
+    comrak_options.extension.wikilinks_title_before_pipe = options.wikilinks_title_before_pipe;
 
     comrak_options.render.escape = options.escape;
     comrak_options.render.escaped_char_spans = options.escaped_char_spans;
     comrak_options.render.full_info_string = options.full_info_string;
+    comrak_options.render.gfm_quirks = options.gfm_quirks;
     comrak_options.render.github_pre_lang = options.github_pre_lang;
     comrak_options.render.hardbreaks = options.hardbreaks;
+    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.experimental_inline_sourcepos = options.experimental_inline_sourcepos;
+    // comrak_options.render.syntax_highlighting = options.syntax_highlighting;
+
     comrak_options.render.unsafe_ = options.unsafe_;
 
+    // comrak_options.parse.default_info_string = options.default_info_string;
     comrak_options.parse.relaxed_autolinks = options.relaxed_autolinks;
     comrak_options.parse.relaxed_tasklist_matching = options.relaxed_tasklist_character;
     comrak_options.parse.smart = options.smart;

data/ext/glfm_markdown/src/lib.rs

@@ -16,27 +16,41 @@ fn get_string_opt(arg: &str, options: RHash) -> Option<String> {
 pub fn render_to_html_rs(text: String, options: RHash) -> String {
     let render_options = RenderOptions {
         autolink: get_bool_opt("autolink", options),
+        // default_info_string: get_string_opt("default_info_string", options),
         description_lists: get_bool_opt("description_lists", options),
         escape: get_bool_opt("escape", options),
         escaped_char_spans: get_bool_opt("escaped_char_spans", options),
         footnotes: get_bool_opt("footnotes", options),
+        // front_matter_delimiter: get_string_opt("front_matter_delimiter", options),
         full_info_string: get_bool_opt("full_info_string", options),
+        gemojis: get_bool_opt("gemojis", options),
+        gfm_quirks: get_bool_opt("gfm_quirks", options),
         github_pre_lang: get_bool_opt("github_pre_lang", options),
+        greentext: get_bool_opt("greentext", options),
         hardbreaks: get_bool_opt("hardbreaks", options),
         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),
         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),
         relaxed_autolinks: get_bool_opt("relaxed_autolinks", options),
         relaxed_tasklist_character: get_bool_opt("relaxed_tasklist_character", options),
         sourcepos: get_bool_opt("sourcepos", options),
+        experimental_inline_sourcepos: get_bool_opt("experimental_inline_sourcepos", options),
         smart: get_bool_opt("smart", options),
+        spoiler: get_bool_opt("spoiler", options),
         strikethrough: get_bool_opt("strikethrough", options),
         superscript: get_bool_opt("superscript", options),
+        // syntax_highlighting: get_string_opt("syntax_highlighting", options),
         table: get_bool_opt("table", options),
         tagfilter: get_bool_opt("tagfilter", options),
         tasklist: get_bool_opt("tasklist", 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),
+        wikilinks_title_before_pipe: get_bool_opt("wikilinks_title_before_pipe", options),
+
         debug: get_bool_opt("debug", options),
     };
 

data/ext/glfm_markdown/src/main.rs

@@ -32,14 +32,32 @@ struct Args {
     #[arg(long)]
     footnotes: bool,
 
+    /// Ignore front-matter that starts and ends with the given string
+    // #[arg(long, value_name = "DELIMITER", allow_hyphen_values = true)]
+    // front_matter_delimiter: Option<String>,
+
     /// Enable full info strings for code blocks
     #[arg(long)]
     full_info_string: bool,
 
+    /// Translate gemojis into UTF-8 characters
+    #[arg(long)]
+    gemojis: bool,
+
+    /// Enables GFM-style quirks in output HTML, such as not nesting <strong>
+    /// tags, which otherwise breaks CommonMark compatibility.
+    #[arg(long)]
+    gfm_quirks: bool,
+
     /// Use GitHub-style <pre lang> for code blocks
     #[arg(long)]
     github_pre_lang: bool,
 
+    /// Requires at least one space after a `>` character to generate a blockquote,
+    /// and restarts blockquote nesting across unique lines of input
+    #[arg(long)]
+    greentext: bool,
+
     /// Treat newlines as hard line breaks
     #[arg(long)]
     hardbreaks: bool,
@@ -48,6 +66,14 @@ struct Args {
     #[arg(long, value_name = "PREFIX")]
     header_ids: Option<String>,
 
+    /// Ignore empty links in input.
+    #[arg(long)]
+    ignore_empty_links: bool,
+
+    /// Ignore setext headings in input.
+    #[arg(long)]
+    ignore_setext: bool,
+
     /// Enables `math code` extension, using math code syntax
     #[arg(long)]
     math_code: bool,
@@ -76,10 +102,18 @@ struct Args {
     #[arg(long)]
     sourcepos: bool,
 
+    /// Include inline sourcepos in HTML output, which is known to have issues.
+    #[arg(long)]
+    experimental_inline_sourcepos: bool,
+
     /// Use smart punctuation
     #[arg(long)]
     smart: bool,
 
+    /// Enables spoilers using double vertical bars
+    #[arg(long)]
+    spoiler: bool,
+
     /// Enable 'strikethrough' extension
     #[arg(long)]
     strikethrough: bool,
@@ -88,6 +122,10 @@ struct Args {
     #[arg(long)]
     superscript: bool,
 
+    /// Syntax highlighting for codefence blocks. Choose a theme or 'none' for disabling.
+    // #[arg(long, value_name = "THEME", default_value = "base16-ocean.dark")]
+    // syntax_highlighting: String,
+
     /// Enable 'table' extension
     #[arg(long)]
     table: bool,
@@ -100,10 +138,22 @@ struct Args {
     #[arg(long)]
     tasklist: bool,
 
+    /// Enables underlines using double underscores
+    #[arg(long)]
+    underline: bool,
+
     /// Allow raw HTML and dangerous URLs
     #[arg(long = "unsafe")]
     unsafe_: bool,
 
+    /// Enable 'wikilink_title_after_pipe' extension
+    #[arg(long)]
+    wikilinks_title_after_pipe: bool,
+
+    /// Enable 'wikilink_title_before_pipe' extension
+    #[arg(long)]
+    wikilinks_title_before_pipe: bool,
+
     /// Show debug information
     #[arg(long)]
     debug: bool,
@@ -125,27 +175,40 @@ fn main() {
     let source = String::from_utf8_lossy(&s);
     let options = RenderOptions {
         autolink: cli.autolink,
+        // default_info_string:
         description_lists: cli.description_lists,
         escape: cli.escape,
         escaped_char_spans: cli.escaped_char_spans,
         footnotes: cli.footnotes,
+        // front_matter_delimiter:
         full_info_string: cli.full_info_string,
+        gemojis: cli.gemojis,
+        gfm_quirks: cli.gfm_quirks,
         github_pre_lang: cli.github_pre_lang,
+        greentext: cli.greentext,
         hardbreaks: cli.hardbreaks,
         header_ids: cli.header_ids,
+        ignore_empty_links: cli.ignore_empty_links,
+        ignore_setext: cli.ignore_setext,
         math_code: cli.math_code,
         math_dollars: cli.math_dollars,
         multiline_block_quotes: cli.multiline_block_quotes,
         relaxed_autolinks: cli.relaxed_autolinks,
         relaxed_tasklist_character: cli.relaxed_tasklist_character,
         sourcepos: cli.sourcepos,
+        experimental_inline_sourcepos: cli.experimental_inline_sourcepos,
         smart: cli.smart,
+        spoiler: cli.spoiler,
         strikethrough: cli.strikethrough,
         superscript: cli.superscript,
+        // syntax_highlighting:
         table: cli.table,
         tagfilter: cli.tagfilter,
         tasklist: cli.tasklist,
+        underline: cli.underline,
         unsafe_: cli.unsafe_,
+        wikilinks_title_after_pipe: cli.wikilinks_title_after_pipe,
+        wikilinks_title_before_pipe: cli.wikilinks_title_before_pipe,
         debug: cli.debug,
     };
 

data/lib/glfm_markdown/version.rb

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

data/lib/glfm_markdown.rb

@@ -11,6 +11,7 @@ module GLFMMarkdown
     escaped_char_spans: false,
     footnotes: true,
     full_info_string: true,
+    gfm_quirks: true,
     github_pre_lang: false,
     hardbreaks: false,
     math_code: false,
@@ -18,6 +19,7 @@ module GLFMMarkdown
     multiline_block_quotes: true,
     relaxed_autolinks: false,
     sourcepos: true,
+    experimental_inline_sourcepos: true,
     smart: false,
     strikethrough: true,
     table: true,
@@ -36,6 +38,7 @@ module GLFMMarkdown
 
       default_options = options[:glfm] ? GLFM_DEFAULT_OPTIONS : {}
       options = options.merge(unsafe: true) if options[:tagfilter]
+      options[:experimental_inline_sourcepos] = options[:sourcepos] if options[:sourcepos]
 
       render_to_html_rs(markdown, default_options.merge(options))
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-glfm-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Brett Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys