kramdown-syntax_tree_sitter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ba9a8e090021116214ebf5938b8de67856e7aa0054aeb49de5a67041b0683a5
-  data.tar.gz: b9d7a9110a29f9abd175ea82c3f54eccb15ca334b69181299f291f43c8c6c35b
+  metadata.gz: '09858b648cc381cb603b21a3ed091b1d96a25b55264f4dd2c4e8fe7436d68288'
+  data.tar.gz: 9ceeb8b78ac8cea098cbb329abbdc9e650202e676b042b647b3f0ca55665c3ed
 SHA512:
-  metadata.gz: ff14f9dff79b8681771b4a0b078e8a1a820489cb2e338f91f5f2ca30d758495a19763f9449585429872c00943c38dca10e88a9465eb7a97cd1c64c298935d528
-  data.tar.gz: fc629b06c06b8df3614084dd40ccf8d38747ddc5ab9e096cb85f5976feb0a8f0729615e303a88f256b0bdd9be0c96309ec2cd461bedf472bf7e2f7aa5d4605a5
+  metadata.gz: a3a7cf735cab71d863433b3be34e8b1dd537cca412bfddb611b56d4ff8292b74f0f45283da701510d928d432ad4aa39224316a012eb07cbd524cc1977bfb3a2e
+  data.tar.gz: 23197c154c12ca2e97534829179dd2785c9907760f89205a7a7be3e80f3cca7f8f6dd2c6314897a887e1c45b55eaddbd05a2937321017378caa0d03e33e450a5

data/README.md

@@ -1,6 +1,6 @@
 # Kramdown Tree-sitter Highlighter
 
-[![Build status](https://img.shields.io/github/workflow/status/andrewtbiehl/kramdown-syntax_tree_sitter/Quality%20Control?style=flat-square&logo=github)](https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/actions/workflows/quality-control.yml)
+[![Build status](https://img.shields.io/github/actions/workflow/status/andrewtbiehl/kramdown-syntax_tree_sitter/quality-control.yml?branch=main&style=flat-square&logo=github)](https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/actions/workflows/quality-control.yml)
 [![RubyGems page](https://img.shields.io/gem/v/kramdown-syntax_tree_sitter?style=flat-square&color=blue&logo=rubygems&logoColor=white)](https://rubygems.org/gems/kramdown-syntax_tree_sitter)
 
 ***Syntax highlight code with [Tree-sitter](https://tree-sitter.github.io/tree-sitter)
@@ -22,8 +22,8 @@ essentially an adapter for the
 hence also requires a compatible [Rust](https://www.rust-lang.org) installation to
 function. It is officially compatible with the following environments:
 
-- **Ruby**: 2.7, 3.0, 3.1
-- **Rust**: 1.61, 1.62, 1.63, 1.64, 1.65
+- **Ruby**: 2.7, 3.0, 3.1, 3.2
+- **Rust**: 1.62, 1.63, 1.64, 1.65, 1.66
 - **Platforms**: MacOS, Linux
 
 ### Installation
@@ -56,7 +56,7 @@ require 'kramdown'
 require 'kramdown/syntax_tree_sitter'
 
 text = <<~MARKDOWN
-  ~~~source.python
+  ~~~python
   print('Hello, World!')
   ~~~
 MARKDOWN
@@ -64,6 +64,13 @@ MARKDOWN
 Kramdown::Document.new(text, syntax_highlighter: :'tree-sitter').to_html
 ```
 
+### General usage
+
+To successfully highlight input text via Kramdown with this plugin enabled, make sure
+that every language referenced has a corresponding Tree-sitter parser library installed.
+See the subsequent ['Language identifiers'](#language-identifiers) and
+['Tree-sitter parsers'](#tree-sitter-parsers) sections for more information.
+
 ### Usage with Jekyll
 
 This plugin can be used with the popular static site generator
@@ -82,11 +89,9 @@ kramdown:
   # Other Kramdown options...
 ```
 
-To highlight every code block in a Jekyll project via the plugin, make sure that every
-language identifier is expressed with the correct Tree-sitter scope and that every
-language referenced has a corresponding Tree-sitter parser library installed. See the
-subsequent ['Language identifiers'](#language-identifiers) and
-['Tree-sitter parsers'](#tree-sitter-parsers) sections for more information.
+Note that this plugin's general usage prerequisites (described in the previous
+['General usage'](#general-usage) section) still apply when using this plugin with
+Jekyll.
 
 Also, there are multiple ways to render highlighted code blocks with Jekyll, as
 illustrated in the following table:
@@ -103,13 +108,13 @@ illustrated in the following table:
 
 ---
 ````
-```source.python
+```python
 print('Hello, World!')
 ```
 
 or
 
-~~~source.python
+~~~python
 print('Hello, World!')
 ~~~
 ````
@@ -125,7 +130,7 @@ print('Hello, World!')
 ---
 ```
     print('Hello, World!')
-{: class="language-source.python" }
+{: class="language-python" }
 ```
 ---
 
@@ -138,7 +143,7 @@ print('Hello, World!')
 
 ---
 ```
-{% highlight source.python %}
+{% highlight python %}
 print('Hello, World!')
 {% endhighlight %}
 ```
@@ -171,12 +176,18 @@ can be found on
 
 ### Language identifiers
 
-Tree-sitter uses a string-based identifier called a 'scope' to identify each language.
-For example, the scope string for Python is 'source.python', whereas for HTML it is
-'text.html.basic'. Currently, this plugin follows this same convention, so a given code
-block will only be correctly highlighted if the language identifier provided for that
-code block is its language's corresponding Tree-sitter scope string. This is illustrated
-by the code block used in the [Quickstart](#quickstart) example.
+For most popular languages, this plugin recognizes the same language identifiers as used
+by the popular highlighter [Rouge](https://github.com/rouge-ruby/rouge). For example,
+both 'python' and 'py' may be used to identify a code block written in Python. For the
+complete list of Rouge language identifiers recognized by this plugin, see
+[`lib/kramdown/syntax_tree_sitter/languages.rb`](https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/blob/main/lib/kramdown/syntax_tree_sitter/languages.rb).
+
+This plugin also automatically supports the language identifier format used by
+Tree-sitter, known as as the 'scope' name. For example, the scope name for Python is
+'source.python', whereas for HTML it is 'text.html.basic'.
+
+For any identifiers currently supported by Rouge but not by this plugin, feel free to
+open an issue or pull request on GitHub to have them included.
 
 ### CSS styling
 

data/ext/tree_sitter_adapter/Cargo.lock

@@ -31,9 +31,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.66"
+version = "1.0.68"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "216261ddc8289130e551ddcd5ce8a064710c0d064a4d2895c67151c92b5443f6"
+checksum = "2cb2f989d18dd141ab8ae82f64d1a8cdd37e0840f73a406896cf5e99502fab61"
 
 [[package]]
 name = "ascii"

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

@@ -3,6 +3,8 @@
 require 'kramdown'
 require 'tree_sitter_adapter'
 
+require_relative '../../syntax_tree_sitter/languages'
+
 module Kramdown
   module Converter # rubocop:disable Style/Documentation
     module SyntaxHighlighter
@@ -13,13 +15,14 @@ module Kramdown
       module TreeSitter
         DEFAULT_PARSERS_DIR = '~/tree_sitter_parsers'
 
-        def self.call(converter, raw_text, language, type, _)
-          return nil unless language
+        def self.call(converter, raw_text, language_alias, type, _)
+          return nil unless language_alias
 
+          language_scope = LANGUAGE_SCOPES.fetch(language_alias, language_alias)
           rendered_text = TreeSitterAdapter.highlight(
             raw_text,
             get_parsers_dir(converter),
-            language,
+            language_scope,
             get_use_css_classes(converter)
           )
           # Code blocks are additionally wrapped in HTML code tags

data/lib/kramdown/syntax_tree_sitter/languages.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Kramdown
+  module Converter
+    module SyntaxHighlighter
+      module TreeSitter
+        # Maps each recognized language alias to its corresponding Tree-sitter scope
+        LANGUAGE_SCOPES =
+          {
+            'source.R' => %w[R S r s],
+            'source.bash' => %w[bash ksh sh shell zsh],
+            'source.c' => %w[c],
+            'source.cpp' => %w[c++ cpp],
+            'source.cs' => %w[c# cs csharp],
+            'source.css' => %w[css],
+            'source.d' => %w[d dlang],
+            'source.dot' => %w[dot],
+            'source.elixir' => %w[elixir exs],
+            'source.elm' => %w[elm],
+            'source.emacs.lisp' => %w[elisp emacs-lisp],
+            'source.go' => %w[go golang],
+            'source.hack' => %w[hack hh],
+            'source.haskell' => %w[haskell hs],
+            'source.hcl' => %w[hcl],
+            'source.java' => %w[java],
+            'source.js' => %w[javascript js],
+            'source.json' => %w[json],
+            'source.julia' => %w[jl julia],
+            'source.lua' => %w[lua],
+            'source.mk' => %w[bsdmake gnumake make makefile mf],
+            'source.nix' => %w[nix nixos],
+            'source.objc' => %w[obj-c obj_c objc objective_c objectivec],
+            'source.ocaml' => %w[ocaml],
+            'source.perl' => %w[perl pl],
+            'source.php' => %w[php php3 php4 php5],
+            'source.proto' => %w[proto protobuf],
+            'source.python' => %w[py python],
+            'source.racket' => %w[racket],
+            'source.ruby' => %w[rb ruby],
+            'source.rust' => %w[rs rust],
+            'source.scala' => %w[scala],
+            'source.sparql' => %w[sparql],
+            'source.sql' => %w[sql],
+            'source.swift' => %w[swift],
+            'source.toml' => %w[toml],
+            'source.ts' => %w[ts typescript],
+            'source.vhd' => %w[vhdl],
+            'text.html.basic' => %w[html],
+            'text.html.erb' => %w[erb eruby rhtml]
+          }
+          .map { |scope, aliases| aliases.map { |alias_| [alias_, scope] } }
+          .flatten(1)
+          .to_h
+          .freeze
+      end
+    end
+  end
+end

data/lib/kramdown/syntax_tree_sitter/version.rb

@@ -5,7 +5,7 @@ module Kramdown
     module SyntaxHighlighter
       module TreeSitter
         # Version of kramdown-syntax_tree_sitter gem
-        VERSION = '0.2.0'
+        VERSION = '0.3.0'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-syntax_tree_sitter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew T. Biehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -139,6 +139,7 @@ files:
 - 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/languages.rb
 - lib/kramdown/syntax_tree_sitter/version.rb
 - lib/tree_sitter_adapter.rb
 homepage: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter
@@ -161,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Syntax highlight code with Tree-sitter via Kramdown.