kramdown-syntax_tree_sitter 0.1.0

data/ext/tree_sitter_adapter/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "tree_sitter_adapter"
+version = "0.0.0"
+edition = "2021"
+
+[lib]
+name = "tree_sitter_adapter"
+crate-type = ["cdylib"]
+
+[dependencies]
+anyhow = "*"
+tree-sitter = "*"
+tree-sitter-cli = "*"
+tree-sitter-highlight = "*"
+tree-sitter-loader = "*"
+rutie = "*"

data/ext/tree_sitter_adapter/src/lib.rs

@@ -0,0 +1,62 @@
+#[macro_use]
+extern crate rutie;
+
+use rutie::{AnyException, Class, Exception, Object, RString, VM};
+
+mod tree_sitter_adapter;
+
+class!(TreeSitterAdapter);
+
+methods!(
+    TreeSitterAdapter,
+    _rtself,
+    fn pub_highlight(raw_code: RString, raw_parsers_dir: RString, raw_scope: RString) -> RString {
+        VM::unwrap_or_raise_ex(
+            tree_sitter_adapter::highlight(
+                &raw_code.unwrap().to_string(),
+                &raw_parsers_dir.unwrap().to_string(),
+                &raw_scope.unwrap().to_string(),
+            )
+            .as_ref()
+            .map(String::as_str)
+            .map(RString::new_utf8)
+            .map_err(String::as_str)
+            .map_err(AnyException::new_runtime_error),
+        )
+    }
+);
+
+#[no_mangle]
+pub extern "C" fn Init_tree_sitter_adapter() {
+    Class::new("TreeSitterAdapter", None).define(|class_| {
+        class_.def_self("highlight", pub_highlight);
+    });
+}
+
+pub trait VMExt {
+    fn unwrap_or_raise_ex<T, E>(x: Result<T, E>) -> T
+    where
+        E: Into<AnyException>;
+}
+
+impl VMExt for VM {
+    fn unwrap_or_raise_ex<T, E>(result: Result<T, E>) -> T
+    where
+        E: Into<AnyException>,
+    {
+        result.unwrap_or_else(|e| {
+            VM::raise_ex(e);
+            unreachable!();
+        })
+    }
+}
+
+pub trait AnyExceptionExt {
+    fn new_runtime_error(message: &str) -> Self;
+}
+
+impl AnyExceptionExt for AnyException {
+    fn new_runtime_error(message: &str) -> Self {
+        AnyException::new("RuntimeError", Some(message))
+    }
+}

data/ext/tree_sitter_adapter/src/tree_sitter_adapter.rs

@@ -0,0 +1,171 @@
+use anyhow::{Context, Error, Result};
+use std::convert;
+use std::path::PathBuf;
+use tree_sitter::Language;
+use tree_sitter_cli::highlight::Theme;
+use tree_sitter_highlight::{Error as TSError, HighlightEvent};
+use tree_sitter_highlight::{Highlight, HighlightConfiguration, Highlighter, HtmlRenderer};
+use tree_sitter_loader::{Config, LanguageConfiguration, Loader};
+
+const LOADER_ERROR_MSG: &str = "Error loading Tree-sitter parsers from directory";
+const NO_LANGUAGE_ERROR_MSG: &str = "Error retrieving language configuration for scope";
+
+pub fn highlight(code: &str, parsers_dir: &str, scope: &str) -> Result<String, String> {
+    let parsers_dir = PathBuf::from(parsers_dir);
+    let theme = Theme::default();
+    let mut loader = Loader::new_from_dir(parsers_dir).map_err(Error::to_formatted_string)?;
+    loader.configure_highlights(&theme.highlight_names);
+    loader
+        .language_configuration_from_scope(scope)
+        .and_then(LanguageConfigurationAdapter::highlight_config)
+        .and_then(|config| {
+            let default_css_style = String::new();
+            let css_attribute_callback = get_css_styles(&theme, &default_css_style);
+            HighlighterAdapter::new(&loader, config)
+                .highlight(code)
+                .and_then(|highlights| render_html(highlights, &css_attribute_callback))
+        })
+        .map_err(Error::to_formatted_string)
+}
+
+trait LoaderExt {
+    fn new_from_dir(parser_directory: PathBuf) -> Result<Loader>;
+
+    fn language_configuration_from_scope<'a>(
+        &'a self,
+        scope: &'a str,
+    ) -> Result<LanguageConfigurationAdapter<'a>>;
+}
+
+impl LoaderExt for Loader {
+    fn new_from_dir(parser_directory: PathBuf) -> Result<Loader> {
+        Loader::new()
+            .and_then(|mut loader| {
+                let config = {
+                    let parser_directory = parser_directory.clone();
+                    let parser_directories = vec![parser_directory];
+                    Config { parser_directories }
+                };
+                loader.find_all_languages(&config)?;
+                Ok(loader)
+            })
+            .with_context(|| {
+                let parser_directory_string = parser_directory.display();
+                format!("{LOADER_ERROR_MSG} '{parser_directory_string}'")
+            })
+    }
+
+    fn language_configuration_from_scope<'a>(
+        &'a self,
+        scope: &'a str,
+    ) -> Result<LanguageConfigurationAdapter<'a>> {
+        self.language_configuration_for_scope(scope)
+            .transpose()
+            .context("Language not found")
+            .flatten_()
+            .map(|(language, config)| LanguageConfigurationAdapter { language, config })
+            .with_context(|| format!("{NO_LANGUAGE_ERROR_MSG} '{scope}'"))
+    }
+}
+
+struct LanguageConfigurationAdapter<'a> {
+    language: Language,
+    config: &'a LanguageConfiguration<'a>,
+}
+
+impl<'a> LanguageConfigurationAdapter<'a> {
+    fn highlight_config(self) -> Result<&'a HighlightConfiguration> {
+        self.config
+            .highlight_config(self.language)
+            .transpose()
+            .context("Another issue")
+            .flatten_()
+    }
+}
+
+struct HighlightsAdapter<'a, T: Iterator<Item = Result<HighlightEvent, TSError>>> {
+    code: &'a str,
+    highlights: T,
+}
+
+struct HighlighterAdapter<'a> {
+    loader: &'a Loader,
+    config: &'a HighlightConfiguration,
+    highlighter: Highlighter,
+}
+
+impl<'a> HighlighterAdapter<'a> {
+    fn new(loader: &'a Loader, config: &'a HighlightConfiguration) -> Self {
+        Self {
+            loader,
+            config,
+            highlighter: Highlighter::new(),
+        }
+    }
+
+    fn highlight(
+        &'a mut self,
+        code: &'a str,
+    ) -> Result<HighlightsAdapter<'a, impl Iterator<Item = Result<HighlightEvent, TSError>> + 'a>>
+    {
+        let Self {
+            loader,
+            config,
+            highlighter,
+        } = self;
+        highlighter
+            .highlight(config, code.as_bytes(), None, |s| {
+                loader.highlight_config_for_injection_string(s)
+            })
+            .map(|highlights| HighlightsAdapter { code, highlights })
+            .map_err(Into::into)
+    }
+}
+
+fn render_html<'a, F: Fn(Highlight) -> &'a [u8]>(
+    highlights: HighlightsAdapter<'a, impl Iterator<Item = Result<HighlightEvent, TSError>> + 'a>,
+    css_attribute_callback: &F,
+) -> Result<String> {
+    let HighlightsAdapter { code, highlights } = highlights;
+    let mut renderer = HtmlRenderer::new();
+    renderer.render(highlights, code.as_bytes(), css_attribute_callback)?;
+    // Remove erroneously appended newline
+    if renderer.html.ends_with(&[b'\n']) && !code.ends_with('\n') {
+        renderer.html.pop();
+    }
+    Ok(renderer.lines().collect())
+}
+
+fn get_css_styles<'a>(
+    theme: &'a Theme,
+    default_css_style: &'a String,
+) -> impl Fn(Highlight) -> &'a [u8] {
+    |highlight| {
+        theme
+            .styles
+            .get(highlight.0)
+            .and_then(|style| style.css.as_ref())
+            .unwrap_or(default_css_style)
+            .as_bytes()
+    }
+}
+
+trait ResultExt<T, E> {
+    fn flatten_(self) -> Result<T, E>;
+}
+
+impl<T, E> ResultExt<T, E> for Result<Result<T, E>, E> {
+    fn flatten_(self) -> Result<T, E> {
+        self.and_then(convert::identity)
+    }
+}
+
+trait ErrorExt {
+    fn to_formatted_string(self) -> String;
+}
+
+impl ErrorExt for Error {
+    fn to_formatted_string(self) -> String {
+        format!("{self:#}")
+    }
+}

data/lib/kramdown/converter/syntax_highlighter/tree_sitter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'tree_sitter_adapter'
+
+module Kramdown
+  module Converter # rubocop:disable Style/Documentation
+    module SyntaxHighlighter
+      # This highlighter is not yet fully configured to highlight code.
+      #
+      # Currently it merely escapes the code so that it can be safely inserted into HTML
+      # text.
+      module TreeSitter
+        DEFAULT_PARSERS_DIR = '~/tree_sitter_parsers'
+
+        def self.call(converter, raw_text, language, type, _)
+          return nil unless language
+
+          parsers_dir = get_option(converter, :tree_sitter_parsers_dir)
+                        .then { _1 || DEFAULT_PARSERS_DIR }
+                        .then { File.expand_path _1 }
+          rendered_text = TreeSitterAdapter.highlight raw_text, parsers_dir, language
+          # Code blocks are additionally wrapped in HTML code tags
+          type == :block ? "<pre><code>#{rendered_text}</code></pre>" : rendered_text
+        end
+
+        def self.get_option(converter, name)
+          converter.options[:syntax_highlighter_opts][name]
+        end
+      end
+    end
+
+    add_syntax_highlighter(:'tree-sitter', SyntaxHighlighter::TreeSitter)
+  end
+end

data/lib/kramdown/syntax_tree_sitter/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Kramdown
+  module Converter
+    module SyntaxHighlighter
+      module TreeSitter
+        # Version of kramdown-syntax_tree_sitter gem
+        VERSION = '0.1.0'
+      end
+    end
+  end
+end

data/lib/kramdown/syntax_tree_sitter.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'converter/syntax_highlighter/tree_sitter'
+require_relative 'syntax_tree_sitter/version'

data/lib/tree_sitter_adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rutie'
+
+Rutie.new(:tree_sitter_adapter).init(
+  'Init_tree_sitter_adapter',
+  File.expand_path(File.join(__dir__, '..', 'ext', 'tree_sitter_adapter', 'target'))
+)

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-syntax_tree_sitter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew T. Biehl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rutie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: 
+email: 
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- ext/Rakefile
+- ext/tasks.rake
+- ext/tree_sitter_adapter/Cargo.lock
+- ext/tree_sitter_adapter/Cargo.toml
+- ext/tree_sitter_adapter/src/lib.rs
+- ext/tree_sitter_adapter/src/tree_sitter_adapter.rs
+- lib/kramdown/converter/syntax_highlighter/tree_sitter.rb
+- lib/kramdown/syntax_tree_sitter.rb
+- lib/kramdown/syntax_tree_sitter/version.rb
+- lib/tree_sitter_adapter.rb
+homepage: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Syntax highlight code with Tree-sitter via Kramdown.
+test_files: []