gitlab-glfm-markdown 0.0.12-x86_64-darwin → 0.0.14-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 006efb85e12aba2c54396197c1ada6ac0dba717aefb122de9b727be1e0a920fa
-  data.tar.gz: 96c07fa51dfe0a591416be56e8f0f2c5997106dc6d2622a4e851d187b766222d
+  metadata.gz: b08d9728c8b99b0fcc3d3fb9f97a64ed8553ef900ca863cd41aafbc0c6928aa9
+  data.tar.gz: 4019b749a148ddfa6a47da8fca803c3991434e06fe69b3a153b16f39b6b7910a
 SHA512:
-  metadata.gz: e0510dc264ba9964666c44d51eaa2190b899a51da30688ace31c44ee1f631470143187c6e14f548a845f4b9d0b1168feca098c9ea60c08f77c4daac4ea9cdb29
-  data.tar.gz: 34b905c2514793f599bfd4d5359989e2c8f41ca9bc831cdda057c09725f32e6ddf44d1cc1da85a7fca2214c47c39925ceb73fdc2229d04f9982f1149e1aee02a
+  metadata.gz: 40736781765aeaa20e667927cf51e1f4e1fdbc861cbf753a44c257a8ba8c30c225a038d4ec901b9a73c70e292e14bb71c2a9e861f3f051e7079e26a27b0cd17d
+  data.tar.gz: 0522bd70008a3a65313c8e8fa4bdb85b801ff369ddd7ce3fb2ce83a026286d5ed8bca517578bc414c2631c2674acf1c8f713a8bd38c7df6c478e2e40564e345c

data/Cargo.lock

@@ -216,9 +216,9 @@ checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
 
 [[package]]
 name = "comrak"
-version = "0.21.0"
+version = "0.22.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6751998a48e2327773c95f6f8e03c6e77c0156ce539d74c17d2199ff3d05e197"
+checksum = "d0436149c9f6a1935b13306206c739b1ba84fa81f551b5eb87fc2ca7a13700af"
 dependencies = [
  "derive_builder",
  "entities",
@@ -361,7 +361,7 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
 [[package]]
 name = "glfm_markdown"
-version = "0.0.12"
+version = "0.0.14"
 dependencies = [
  "clap",
  "comrak",

data/README.md

@@ -3,9 +3,11 @@
 [![Pipeline status](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/badges/main/pipeline.svg)](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/commits/main)
 [![Latest Release](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/badges/release.svg)](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/releases)
 
-Implements GLFM (as used by GitLab) using a Rust-based markdown parser.
+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.22.0`_.
 
-This project is currently EXPLORATORY, so anything and everything will change.
+This project is still in constant flux, so interfaces and functionality can change at any time.
 
 ## Installation
 
@@ -25,9 +27,37 @@ Try on command line:
 rake compile
 bin/console
 
-GLFMMarkdown.to_html('# header', options: { glfm: true })
+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                                                                |
+
 ## Dingus / Demo
 
 A demo is running via GitLab Pages, and can be accessed at:
@@ -50,18 +80,16 @@ directly to the gem's source directory, make sure that you're using the same ver
 of Ruby for the project and the gem. Otherwise you can see unexplained errors when
 calling into the gem.
 
-### Releasing a new version
+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)
+should be followed.
 
-To release a new version:
+### Releasing a new version
 
-1. Update `lib/glfm_markdown/version.rb` with the version number.
-1. Update `CHANGELOG.md` with the changes in the release.
-1. Create a merge request and merge it to `master`.
-1. Push a new tag to the repository.
+To release a new version, create a merge request and use the `Release` template, following it's instructions.
 
-The new version with precompiled, native gems will automatically be
-published to [RubyGems](https://rubygems.org/gems/gitlab-glfm-markdown) when the
-pipeline for the tag completes.
+Once merged, the new version with precompiled, native gems will automatically be
+published to [RubyGems](https://rubygems.org/gems/gitlab-glfm-markdown).
 
 ## Contributing
 

data/ext/glfm_markdown/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "glfm_markdown"
-version = "0.0.12"
+version = "0.0.14"
 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.21.0", default-features = false }
+comrak = { version = "0.22.0", default-features = false }
 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

@@ -3,10 +3,14 @@ pub struct RenderOptions {
     pub autolink: bool,
     pub escape: bool,
     pub description_lists: bool,
+    pub escaped_char_spans: bool,
     pub footnotes: bool,
     pub full_info_string: bool,
     pub github_pre_lang: bool,
     pub hardbreaks: bool,
+    pub header_ids: Option<String>,
+    pub math_code: bool,
+    pub math_dollars: bool,
     pub multiline_block_quotes: bool,
     pub relaxed_autolinks: bool,
     pub relaxed_tasklist_character: bool,
@@ -32,6 +36,9 @@ 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.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.strikethrough = options.strikethrough;
     comrak_options.extension.superscript = options.superscript;
@@ -40,6 +47,7 @@ fn render_comrak(text: String, options: RenderOptions) -> String {
     comrak_options.extension.tasklist = options.tasklist;
 
     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.github_pre_lang = options.github_pre_lang;
     comrak_options.render.hardbreaks = options.hardbreaks;

data/ext/glfm_markdown/src/lib.rs

@@ -5,31 +5,39 @@ use glfm::{render, RenderOptions};
 
 /// Lookup symbol in provided `RHash`. Returns `false` if the key is not present
 /// or value cannot be converted to a boolean.
-fn get_opt(arg: &str, options: RHash) -> bool {
+fn get_bool_opt(arg: &str, options: RHash) -> bool {
     options.lookup(Symbol::new(arg)).unwrap_or_default()
 }
 
+fn get_string_opt(arg: &str, options: RHash) -> Option<String> {
+    options.lookup(Symbol::new(arg)).ok()
+}
+
 pub fn render_to_html_rs(text: String, options: RHash) -> String {
     let render_options = RenderOptions {
-        autolink: get_opt("autolink", options),
-        description_lists: get_opt("description_lists", options),
-        escape: get_opt("escape", options),
-        footnotes: get_opt("footnotes", options),
-        full_info_string: get_opt("full_info_string", options),
-        github_pre_lang: get_opt("github_pre_lang", options),
-        hardbreaks: get_opt("hardbreaks", options),
-        multiline_block_quotes: get_opt("multiline_block_quotes", options),
-        relaxed_autolinks: get_opt("relaxed_autolinks", options),
-        relaxed_tasklist_character: get_opt("relaxed_tasklist_character", options),
-        sourcepos: get_opt("sourcepos", options),
-        smart: get_opt("smart", options),
-        strikethrough: get_opt("strikethrough", options),
-        superscript: get_opt("superscript", options),
-        table: get_opt("table", options),
-        tagfilter: get_opt("tagfilter", options),
-        tasklist: get_opt("tasklist", options),
-        unsafe_: get_opt("unsafe", options),
-        debug: get_opt("debug", options),
+        autolink: get_bool_opt("autolink", 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),
+        full_info_string: get_bool_opt("full_info_string", options),
+        github_pre_lang: get_bool_opt("github_pre_lang", options),
+        hardbreaks: get_bool_opt("hardbreaks", options),
+        header_ids: get_string_opt("header_ids", 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),
+        smart: get_bool_opt("smart", options),
+        strikethrough: get_bool_opt("strikethrough", options),
+        superscript: get_bool_opt("superscript", options),
+        table: get_bool_opt("table", options),
+        tagfilter: get_bool_opt("tagfilter", options),
+        tasklist: get_bool_opt("tasklist", options),
+        unsafe_: get_bool_opt("unsafe", options),
+        debug: get_bool_opt("debug", options),
     };
 
     render(text, render_options)

data/ext/glfm_markdown/src/main.rs

@@ -24,6 +24,10 @@ struct Args {
     #[arg(long)]
     escape: bool,
 
+    /// Wrap escaped characters in a `<span>` to allow any post-processing to recognize them
+    #[arg(long)]
+    escaped_char_spans: bool,
+
     /// Enable 'footnotes' extension
     #[arg(long)]
     footnotes: bool,
@@ -40,6 +44,22 @@ struct Args {
     #[arg(long)]
     hardbreaks: bool,
 
+    /// Enable the 'header IDs` extension, with the given ID prefix
+    #[arg(long, value_name = "PREFIX")]
+    header_ids: Option<String>,
+
+    /// Enables `math code` extension, using math code syntax
+    #[arg(long)]
+    math_code: bool,
+
+    /// Enables `math dollar` extension, using math dollar syntax
+    #[arg(long)]
+    math_dollars: bool,
+
+    /// Enable 'multiline block quotes' extension
+    #[arg(long)]
+    multiline_block_quotes: bool,
+
     /// Write output to FILE instead of stdout
     #[arg(short, long, value_name = "FILE")]
     output: Option<String>,
@@ -107,10 +127,15 @@ fn main() {
         autolink: cli.autolink,
         description_lists: cli.description_lists,
         escape: cli.escape,
+        escaped_char_spans: cli.escaped_char_spans,
         footnotes: cli.footnotes,
         full_info_string: cli.full_info_string,
         github_pre_lang: cli.github_pre_lang,
         hardbreaks: cli.hardbreaks,
+        header_ids: cli.header_ids,
+        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,

data/lib/glfm_markdown/version.rb

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

data/lib/glfm_markdown.rb

@@ -8,10 +8,13 @@ load_rust_extension
 module GLFMMarkdown
   GLFM_DEFAULT_OPTIONS = {
     autolink: true,
+    escaped_char_spans: false,
     footnotes: true,
     full_info_string: true,
     github_pre_lang: false,
     hardbreaks: false,
+    math_code: false,
+    math_dollars: false,
     multiline_block_quotes: true,
     relaxed_autolinks: false,
     sourcepos: true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-glfm-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: x86_64-darwin
 authors:
 - Brett Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys