Merge branch 'main' of github.com:ralsina/tartrazine

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.6.0
+      hooks:
+          - id: trailing-whitespace
+          - id: end-of-file-fixer
+          - id: check-yaml
+          - id: check-added-large-files
+          - id: check-merge-conflict
+    - repo: https://github.com/jumanjihouse/pre-commit-hooks
+      rev: 3.0.0
+      hooks:
+          - id: shellcheck
+          - id: markdownlint
+            exclude: '^content'
+    - repo: https://github.com/mrtazz/checkmake
+      rev: 0.2.2
+      hooks:
+          - id: checkmake
+            exclude: lexers/makefile.xml
+    - repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.29.2
+      hooks:
+          - id: check-github-workflows
+    - repo: https://github.com/commitizen-tools/commitizen
+      rev: v3.29.0 # automatically updated by Commitizen
+      hooks:
+        - id: commitizen
+        - id: commitizen-branch
+          stages:
+            - post-commit
+            - push

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### ⚙️ Miscellaneous Tasks
+
+- Pre-commit hooks
+- Git-cliff config
+
+## [0.6.1] - 2024-08-25
+
+### 📚 Documentation
+
+- Improve readme and help message
+
+<!-- generated by git-cliff -->

Makefile

@@ -1,3 +1,5 @@
+all: build
+
 build: $(wildcard src/**/*.cr) $(wildcard lexers/*xml) $(wildcard styles/*xml) shard.yml
 	shards build -Dstrict_multi_assign -Dno_number_autocast -d --error-trace
 release: $(wildcard src/**/*.cr) $(wildcard lexers/*xml) $(wildcard styles/*xml) shard.yml
@@ -5,3 +7,15 @@ release: $(wildcard src/**/*.cr) $(wildcard lexers/*xml) $(wildcard styles/*xml)
 static: $(wildcard src/**/*.cr) $(wildcard lexers/*xml) $(wildcard styles/*xml) shard.yml
 	shards build --release --static
 	strip bin/tartrazine
+
+
+clean:
+        rm -rf bin lib shard.lock
+
+test:
+        crystal spec
+
+lint:
+        ameba --fix src spec
+
+.PHONY: clean all test bin lint

README.md

@@ -6,15 +6,18 @@ a port of [Pygments](https://pygments.org/) to
 
 It also provides a CLI tool which can be used to highlight many things in many styles.
 
-Currently Tartrazine supports 247 languages. and it has 331 themes (63 from Chroma, the rest are base16 themes via 
+Currently Tartrazine supports 247 languages and has 331 themes (63 from Chroma,
-[Sixteen](https://github.com/ralsina/sixteen)
+the rest are base16 themes via [Sixteen](https://github.com/ralsina/sixteen)
 
 ## Installation
 
+If you are using Arch: Use yay or your favourite AUR helper, package name is `tartrazine`.
+
 From prebuilt binaries:
 
 Each release provides statically-linked binaries that should
-work on any Linux. Get them from the [releases page](https://github.com/ralsina/tartrazine/releases) and put them in your PATH.
+work on any Linux. Get them from the [releases page](https://github.com/ralsina/tartrazine/releases)
+and put them in your PATH.
 
 To build from source:
 
@@ -27,14 +30,14 @@ To build from source:
 Show a syntax highlighted version of a C source file in your terminal:
 
 ```shell
-$ tartrazine whatever.c -l c -t catppuccin-macchiato --line-numbers -f terminal
+tartrazine whatever.c -l c -t catppuccin-macchiato --line-numbers -f terminal
 ```
 
 Generate a standalone HTML file from a C source file with the syntax highlighted:
 
 ```shell
 $ tartrazine whatever.c -t catppuccin-macchiato --line-numbers \
-  --standalone -f html -o whatever.html 
+  --standalone -f html -o whatever.html
 ```
 
 ## Usage as a Library
@@ -63,7 +66,7 @@ puts formatter.format(File.read(ARGV[0]), lexer)
 
 - [Roberto Alsina](https://github.com/ralsina) - creator and maintainer
 
-## A port of what? Why "kind of"?
+## A port of what, and why "kind of"
 
 Pygments is a staple of the Python ecosystem, and it's great.
 It lets you highlight code in many languages, and it has many
@@ -86,5 +89,6 @@ This only covers the RegexLexers, which are the most common ones,
 but it means the supported languages are a subset of Chroma's, which
 is a subset of Pygments' and DelegatingLexers (useful for things like template languages)
 
-Then performance was bad, so I hacked and hacked and made it
+Then performance was bad, so I hacked and hacked and made it significantly
-significantly [faster than chroma](https://ralsina.me/weblog/posts/a-tale-of-optimization.html) which is fun.
+[faster than chroma](https://ralsina.me/weblog/posts/a-tale-of-optimization.html)
+which is fun.

cliff.toml

@@ -0,0 +1,79 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

lexers/LiquidLexer.xml

@@ -127,4 +127,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/VelocityLexer.xml

@@ -52,4 +52,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/abap.xml

@@ -151,4 +151,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/abnf.xml

@@ -63,4 +63,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/actionscript.xml

@@ -65,4 +65,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/actionscript_3.xml

@@ -160,4 +160,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/ada.xml

@@ -318,4 +318,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/agda.xml

@@ -63,4 +63,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/al.xml

@@ -72,4 +72,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/alloy.xml

@@ -55,4 +55,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/angular2.xml

@@ -105,4 +105,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/antlr.xml

@@ -314,4 +314,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/apacheconf.xml

@@ -71,4 +71,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/apl.xml

@@ -56,4 +56,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/applescript.xml

@@ -127,4 +127,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/arangodb_aql.xml

@@ -171,4 +171,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/arduino.xml

@@ -306,4 +306,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/armasm.xml

@@ -123,4 +123,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/autohotkey.xml

@@ -75,4 +75,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/autoit.xml

@@ -67,4 +67,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/awk.xml

@@ -92,4 +92,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/ballerina.xml

@@ -94,4 +94,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bash.xml

@@ -217,4 +217,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bash_session.xml

@@ -22,4 +22,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/batchfile.xml

@@ -657,4 +657,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bbcode.xml

@@ -19,4 +19,3 @@
     </state>
   </rules>
 </lexer>
-

lexers/bibtex.xml

@@ -149,4 +149,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bicep.xml

@@ -81,4 +81,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/blitzbasic.xml

@@ -138,4 +138,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bnf.xml

@@ -25,4 +25,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/bqn.xml

@@ -80,4 +80,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/brainfuck.xml

@@ -48,4 +48,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/c#.xml

@@ -118,4 +118,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/c++.xml

@@ -328,4 +328,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cap_n_proto.xml

@@ -119,4 +119,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cassandra_cql.xml

@@ -134,4 +134,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/ceylon.xml

@@ -148,4 +148,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cfstatement.xml

@@ -89,4 +89,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/chaiscript.xml

@@ -131,4 +131,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/chapel.xml

@@ -140,4 +140,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cheetah.xml

@@ -52,4 +52,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cmake.xml

@@ -87,4 +87,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cobol.xml

@@ -87,4 +87,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/coffeescript.xml

@@ -207,4 +207,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/common_lisp.xml

@@ -181,4 +181,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/coq.xml

@@ -133,4 +133,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/crystal.xml

@@ -759,4 +759,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/css.xml

@@ -320,4 +320,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/cython.xml

@@ -369,4 +369,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/d.xml

@@ -130,4 +130,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/dart.xml

@@ -210,4 +210,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/desktop_entry.xml

@@ -14,4 +14,4 @@
       <rule pattern="([-A-Za-z0-9]+)(\[[^\] \t=]+\])?([ \t]*)(=)([ \t]*)([^\n]*)([ \t\n]*\n)"><bygroups><token type="NameAttribute"/><token type="NameNamespace"/><token type="TextWhitespace"/><token type="Operator"/><token type="TextWhitespace"/><token type="LiteralString"/><token type="TextWhitespace"/></bygroups></rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/diff.xml

@@ -49,4 +49,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/django_jinja.xml

@@ -150,4 +150,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/docker.xml

@@ -54,4 +54,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/dtd.xml

@@ -165,4 +165,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/dylan.xml

@@ -173,4 +173,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/ebnf.xml

@@ -87,4 +87,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/elixir.xml

@@ -741,4 +741,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/elm.xml

@@ -116,4 +116,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/emacslisp.xml

@@ -129,4 +129,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/erlang.xml

@@ -163,4 +163,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/factor.xml

@@ -409,4 +409,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/fennel.xml

@@ -65,4 +65,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/fish.xml

@@ -156,4 +156,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/forth.xml

@@ -75,4 +75,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/fortranfixed.xml

@@ -68,4 +68,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/gherkin.xml

@@ -260,4 +260,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/glsl.xml

@@ -62,4 +62,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/gnuplot.xml

@@ -286,4 +286,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/go_template.xml

@@ -111,4 +111,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/graphql.xml

@@ -85,4 +85,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/handlebars.xml

@@ -144,4 +144,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/haskell.xml

@@ -269,4 +269,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/hcl.xml

@@ -140,4 +140,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/hexdump.xml

@@ -186,4 +186,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/hlb.xml

@@ -146,4 +146,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/html.xml

@@ -156,4 +156,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/hy.xml

@@ -101,4 +101,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/idris.xml

@@ -213,4 +213,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/igor.xml

@@ -44,4 +44,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/ini.xml

@@ -42,4 +42,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/io.xml

@@ -68,4 +68,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/j.xml

@@ -154,4 +154,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/javascript.xml

@@ -157,4 +157,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/json.xml

@@ -108,4 +108,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/jsonata.xml

@@ -15,7 +15,7 @@
       </rule>
        <rule pattern="\.\."> // Spread operator
         <token type="Operator"/>
-      </rule> 
+      </rule>
       <rule pattern="\^(?=\()"> // Sort operator
         <token type="Operator"/>
       </rule>
@@ -54,7 +54,7 @@
       </rule>
       <rule pattern="(\+|-)?(0|[1-9]\d*)(\.\d+[eE](\+|-)?\d+|[eE](\+|-)?\d+|\.\d+)">
         <token type="LiteralNumberFloat"/>
-      </rule> 
+      </rule>
       <rule pattern="(\+|-)?(0|[1-9]\d*)">
         <token type="LiteralNumberInteger"/>
       </rule>
@@ -75,9 +75,9 @@
       </rule>
       <!-- NOTE: This expression matches everything remaining, which should be only JSONata names.
       Therefore, it has been left as last intentionally -->
-      <rule pattern="[a-zA-Z0-9_]*"> 
+      <rule pattern="[a-zA-Z0-9_]*">
         <token type="Name"/>
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/julia.xml

@@ -397,4 +397,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/jungle.xml

@@ -95,4 +95,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/kotlin.xml

@@ -220,4 +220,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/lighttpd_configuration_file.xml

@@ -39,4 +39,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/llvm.xml

@@ -70,4 +70,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/lua.xml

@@ -155,4 +155,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/makefile.xml

@@ -128,4 +128,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>

lexers/mako.xml

@@ -117,4 +117,4 @@
       </rule>
     </state>
   </rules>
-</lexer>
+</lexer>