Merge pull request #624 from kivikakk/push-soqvoyqsyzlr

syntect optional in cli; disable syntax highlighting in bench.

Author: kivikakk

.gitignore

@@ -10,3 +10,6 @@ benches/pulldown-cmark
 benches/markdown-it
 /result
 /bench-output.md
+
+benches/samply-bench-input.md
+/profile-*.json.gz

Cargo.toml

@@ -31,7 +31,7 @@ lto = true
 
 [[bin]]
 name = "comrak"
-required-features = ["cli", "syntect"]
+required-features = ["cli"]
 doc = false
 
 [dependencies]
@@ -55,7 +55,7 @@ toml = "0.7.3"
 
 [features]
 default = ["cli", "syntect", "bon"]
-cli = ["clap", "shell-words", "xdg", "fmt2io"]
+cli = ["clap", "bon", "shell-words", "xdg", "fmt2io"]
 shortcodes = ["emojis"]
 bon = ["dep:bon"]
 

Makefile

@@ -13,13 +13,13 @@ bench:
 binaries: build-comrak-branch build-comrak-main build-cmark-gfm build-pulldown-cmark build-markdown-it
 
 build-comrak-branch:
-	cargo build --release
+	cargo build --release --bin comrak --no-default-features --features cli
 	cp ${ROOT}/target/release/comrak ${ROOT}/benches/comrak-${COMMIT}
 
 build-comrak-main:
 	git clone https://github.com/kivikakk/comrak.git --depth 1 --single-branch ${ROOT}/vendor/comrak || true
 	cd ${ROOT}/vendor/comrak && \
-	cargo build --release && \
+	cargo build --release --bin comrak --no-default-features --features cli && \
 	cp ./target/release/comrak ${ROOT}/benches/comrak-main
 
 build-cmark-gfm:
@@ -54,3 +54,16 @@ bench-all: binaries
 	hyperfine --warmup 10 --min-runs ${MIN_RUNS} -L binary comrak-${COMMIT},comrak-main,pulldown-cmark,cmark-gfm,markdown-it './bench.sh ./{binary}' --export-markdown ${ROOT}/bench-output.md &&\
 	echo "\n\nRun on" `date -u` >> ${ROOT}/bench-output.md
 
+benches/samply-bench-input.md:
+	cat ${ROOT}/vendor/progit/*/*/*.markdown > $@
+
+SAMPLY_OPTIONS:=-r 10000 --iteration-count 20 --reuse-threads
+SAMPLY_COMRAK_ARGS:=--syntax-highlighting none benches/samply-bench-input.md -o /dev/null
+
+samply-comrak-branch: benches/samply-bench-input.md build-comrak-branch
+	cat ${ROOT}/vendor/progit/*/*/*.markdown > benches/samply-bench-input.md
+	samply record -o profile-branch.json.gz ${SAMPLY_OPTIONS}         ${ROOT}/benches/comrak-${COMMIT} ${SAMPLY_COMRAK_ARGS}
+
+samply-comrak-main: benches/samply-bench-input.md build-comrak-main
+	cat ${ROOT}/vendor/progit/*/*/*.markdown > benches/samply-bench-input.md
+	samply record -o profile-main.json.gz   ${SAMPLY_OPTIONS} -P 3001 ${ROOT}/benches/comrak-main      ${SAMPLY_COMRAK_ARGS}

benches/bench.sh

@@ -1,8 +1,6 @@
 #! /bin/bash
 
-PROG=$1
+PROG="$1"
 ROOTDIR=$(git rev-parse --show-toplevel)
 
-for lang in ar az be ca cs de en eo es es-ni fa fi fr hi hu id it ja ko mk nl no-nb pl pt-br ro ru sr th tr uk vi zh zh-tw; do \
-    cat $ROOTDIR/vendor/progit/$lang/*/*.markdown | $PROG > /dev/null
-done
+cat $ROOTDIR/vendor/progit/*/*/*.markdown | "$PROG" > /dev/null

flake.nix

@@ -100,6 +100,8 @@
             clippy
             cargo-fuzz
             cargo-nextest
+            cargo-flamegraph
+            samply
             python3
             re2c
             hyperfine

src/main.rs

@@ -10,10 +10,9 @@ use std::{boxed::Box, io::BufWriter};
 
 use clap::{Parser, ValueEnum};
 
-use comrak::{
-    adapters::SyntaxHighlighterAdapter, plugins::syntect::SyntectAdapter, Arena, ListStyleType,
-    Options, Plugins,
-};
+#[cfg(feature = "syntect")]
+use comrak::{adapters::SyntaxHighlighterAdapter, plugins::syntect::SyntectAdapter};
+use comrak::{Arena, ListStyleType, Options, Plugins};
 use comrak::{ExtensionOptions, ParseOptions, RenderOptions};
 
 const EXIT_SUCCESS: i32 = 0;
@@ -136,6 +135,7 @@ struct Cli {
 
     /// Syntax highlighting for codefence blocks. Choose a theme or 'none' for disabling.
     #[arg(long, value_name = "THEME", default_value = "base16-ocean.dark")]
+    #[cfg(feature = "syntect")]
     syntax_highlighting: String,
 
     /// Specify bullet character for lists (-, +, *) in CommonMark output
@@ -315,16 +315,23 @@ fn main() -> Result<(), Box<dyn Error>> {
         render,
     };
 
+    #[cfg(feature = "syntect")]
     let syntax_highlighter: Option<&dyn SyntaxHighlighterAdapter>;
-    let mut plugins: Plugins = Plugins::default();
+    #[cfg(feature = "syntect")]
     let adapter: SyntectAdapter;
 
-    let theme = cli.syntax_highlighting;
-    if theme.is_empty() || theme == "none" {
-        syntax_highlighter = None;
-    } else {
-        adapter = SyntectAdapter::new(Some(&theme));
-        syntax_highlighter = Some(&adapter);
+    #[cfg_attr(not(feature = "syntect"), allow(unused_mut))]
+    let mut plugins: Plugins = Plugins::default();
+
+    #[cfg(feature = "syntect")]
+    {
+        let theme = cli.syntax_highlighting;
+        if theme.is_empty() || theme == "none" {
+            syntax_highlighter = None;
+        } else {
+            adapter = SyntectAdapter::new(Some(&theme));
+            syntax_highlighter = Some(&adapter);
+        }
     }
 
     let mut s: Vec<u8> = Vec::with_capacity(2048);
@@ -356,7 +363,10 @@ fn main() -> Result<(), Box<dyn Error>> {
     } else {
         match cli.format {
             Format::Html => {
-                plugins.render.codefence_syntax_highlighter = syntax_highlighter;
+                #[cfg(feature = "syntect")]
+                {
+                    plugins.render.codefence_syntax_highlighter = syntax_highlighter;
+                }
                 comrak::format_html_with_plugins
             }
             Format::Xml => comrak::format_xml_with_plugins,