Skip to content

Update Readme.md #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danipen merged 2 commits into from
Dec 16, 2025
Merged

Update Readme.md #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5045579
Update sample code to be compilant to the latest API
danipen Dec 16, 2025
e1f5c72
Update README.md
danipen Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 88 additions & 99 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,71 @@
![GitHub license](https://img.shields.io/github/license/danipen/TextMateSharp)
[![Current stable version](https://img.shields.io/nuget/v/TextMateSharp.svg)](https://www.nuget.org/packages/TextMateSharp)
[![Downloads](https://img.shields.io/nuget/dt/TextMateSharp)](https://www.nuget.org/packages/TextMateSharp)
![Size](https://img.shields.io/github/repo-size/danipen/textmatesharp.svg)
![Size](https://img.shields.io/github/repo-size/danipen/textmatesharp.svg)
![GitHub language count](https://img.shields.io/github/languages/count/danipen/TextMateSharp)
![GitHub top language](https://img.shields.io/github/languages/top/danipen/TextMateSharp)

# TextMateSharp
An interpreter for grammar files as defined by TextMate. TextMate grammars use the oniguruma dialect (https://github.com/kkos/oniguruma). Supports loading grammar files only from JSON format. Cross - grammar injections are currently not supported.

TextMateSharp is a port of [microsoft/vscode-textmate](https://github.com/microsoft/vscode-textmate) that brings TextMate grammars to dotnet ecosystem. The implementation is based the Java port [eclipse/tm4e](https://github.com/eclipse/tm4e).
An interpreter for grammar files as defined by TextMate. TextMate grammars use the oniguruma dialect (https://github.com/kkos/oniguruma). Supports loading grammar files only from JSON format. Cross-grammar injections are currently not supported.

TextMateSharp uses a [wrapper](https://github.com/aikawayataro/Onigwrap) via [nuget packges](https://www.nuget.org/packages/Onigwrap) around [Oniguruma](https://github.com/kkos/oniguruma) regex engine. Thanks [@aikawayataro](https://github.com/aikawayataro) for your contribution.
TextMateSharp is a port of [microsoft/vscode-textmate](https://github.com/microsoft/vscode-textmate) that brings TextMate grammars to the .NET ecosystem. The implementation is based on the Java port [eclipse/tm4e](https://github.com/eclipse/tm4e).

TextMateSharp uses a [wrapper](https://github.com/aikawayataro/Onigwrap) via [NuGet packages](https://www.nuget.org/packages/Onigwrap) around the [Oniguruma](https://github.com/kkos/oniguruma) regex engine. Thanks [@aikawayataro](https://github.com/aikawayataro) for your contribution.

TextMateSharp is used by [AvaloniaEdit](https://github.com/AvaloniaUI/AvaloniaEdit).

## Installation

TextMateSharp is available as NuGet packages:

- [TextMateSharp](https://www.nuget.org/packages/TextMateSharp) - Core library
- [TextMateSharp.Grammars](https://www.nuget.org/packages/TextMateSharp.Grammars) - Bundled grammars and themes

```bash
dotnet add package TextMateSharp
dotnet add package TextMateSharp.Grammars
```

## Supported Languages

TextMateSharp.Grammars includes syntax highlighting for 50+ languages including:

C#, C/C++, Java, JavaScript, TypeScript, Python, Ruby, Rust, Go, Swift, Dart, PHP, SQL, HTML, CSS, SCSS, Less, JSON, XML, YAML, Markdown, LaTeX, Lua, PowerShell, Bash, F#, VB.NET, and many more.

## Available Themes

The following themes are included:

Abyss, Dark, Dark+, Dimmed Monokai, Kimbie Dark, Light, Light+, One Dark, Monokai, Quiet Light, Red, Solarized Dark, Solarized Light, Tomorrow Night Blue, High Contrast Light, High Contrast Dark, Dracula, Atom One Light, Atom One Dark, Visual Studio Light, Visual Studio Dark.

## Building
Just execute `dotnet build` under the folder [TextMateSharp](https://github.com/danipen/TextMateSharp/tree/master/src/TextMateSharp)

## Using
Execute `dotnet build` under the [TextMateSharp](https://github.com/danipen/TextMateSharp/tree/master/src/TextMateSharp) folder:

```bash
cd src/TextMateSharp
dotnet build
```

## Usage

```csharp
using System;
using System.Collections.Generic;
using TextMateSharp.Grammars;
using TextMateSharp.Themes;

namespace TextMateSharp;

class Program
{
static void Main(string[] args)
{
try
{
IRegistryOptions options = new LocalRegistryOptions();
Registry.Registry registry = new Registry.Registry(options);
Registry.Registry registry = new Registry.Registry(
new RegistryOptions(ThemeName.DarkPlus));

List<string> textLines = new List<string>();
textLines.Add("using static System; /* comment here */");
Expand All @@ -37,45 +76,38 @@ class Program

IGrammar grammar = registry.LoadGrammar("source.cs");

StackElement ruleStack = null;
IStateStack? ruleStack = null;

foreach (string line in textLines)
foreach (var line in textLines)
{
Console.WriteLine(string.Format("Tokenizing line: {0}", line));
Console.WriteLine($"Tokenizing line: {line}");

ITokenizeLineResult result = grammar.TokenizeLine(line, ruleStack);
ITokenizeLineResult result = grammar.TokenizeLine(line, ruleStack, TimeSpan.MaxValue);

ruleStack = result.RuleStack;

foreach (IToken token in result.GetTokens())
foreach (var token in result.Tokens)
{
int startIndex = (token.StartIndex > line.Length) ?
line.Length : token.StartIndex;
int endIndex = (token.EndIndex > line.Length) ?
line.Length : token.EndIndex;
int startIndex = (token.StartIndex > line.Length) ? line.Length : token.StartIndex;
int endIndex = (token.EndIndex > line.Length) ? line.Length : token.EndIndex;

Console.WriteLine(string.Format(
Console.WriteLine(
" - token from {0} to {1} -->{2}<-- with scopes {3}",
startIndex,
endIndex,
line.SubstringAtIndexes(startIndex, endIndex),
string.Join(",", token.Scopes)));
line.Substring(startIndex, endIndex - startIndex),
string.Join(",", token.Scopes));

foreach (string scopeName in token.Scopes)
Theme theme = registry.GetTheme();

foreach (var themeRule in theme.Match(token.Scopes))
{
Theme theme = registry.GetTheme();
List<ThemeTrieElementRule> themeRules =
theme.Match(scopeName);

foreach (ThemeTrieElementRule themeRule in themeRules)
{
Console.WriteLine(
" - Matched theme rule: " +
"[bg: {0}, fg:{1}, fontStyle: {2}]",
theme.GetColor(themeRule.background),
theme.GetColor(themeRule.foreground),
themeRule.fontStyle);
}
Console.WriteLine(
" - Matched theme rule: " +
"[bg: {0}, fg:{1}, fontStyle: {2}]",
theme.GetColor(themeRule.background),
theme.GetColor(themeRule.foreground),
themeRule.fontStyle);
}
}
}
Expand All @@ -85,98 +117,55 @@ class Program
Console.WriteLine("ERROR: " + ex.Message);
}
}

class LocalRegistryOptions : IRegistryOptions
{
public ICollection<string> GetInjections(string scopeName)
{
return null;
}

public IRawGrammar GetGrammar(string scopeName)
{
return null;
}

public IRawTheme GetTheme(string scopeName)
{
return null;
}

public IRawTheme GetDefaultTheme()
{
string themePath = Path.GetFullPath(
@"../../../../test/themes/dark_vs.json");

using (StreamReader reader = new StreamReader(themePath))
{
return ThemeReader.ReadThemeSync(reader);
}
}
}
}
```

OUTPUT:
**Output:**

```
Tokenizing line: using static System; /* comment here */
- token from 0 to 5 -->using<-- with scopes source.cs,keyword.other.using.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: -1]
- token from 0 to 5 -->using<-- with scopes source.cs,keyword.other.directive.using.cs
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: NotSet]
- token from 5 to 6 --> <-- with scopes source.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 6 to 12 -->static<-- with scopes source.cs,keyword.other.static.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: -1]
- token from 6 to 12 -->static<-- with scopes source.cs,keyword.other.directive.static.cs
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: NotSet]
- token from 12 to 13 --> <-- with scopes source.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 13 to 19 -->System<-- with scopes source.cs,storage.type.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: -1]
- token from 13 to 19 -->System<-- with scopes source.cs,entity.name.type.cs
- Matched theme rule: [bg: , fg:#4EC9B0, fontStyle: NotSet]
- token from 19 to 20 -->;<-- with scopes source.cs,punctuation.terminator.statement.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 20 to 21 --> <-- with scopes source.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 21 to 23 -->/*<-- with scopes source.cs,comment.block.cs,punctuation.definition.comment.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: -1]
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: NotSet]
- token from 23 to 37 --> comment here <-- with scopes source.cs,comment.block.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: NotSet]
- token from 37 to 39 -->*/<-- with scopes source.cs,comment.block.cs,punctuation.definition.comment.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: -1]
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#6A9955, fontStyle: NotSet]
Tokenizing line: namespace Example
- token from 0 to 9 -->namespace<-- with scopes source.cs,keyword.other.namespace.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: -1]
- token from 0 to 9 -->namespace<-- with scopes source.cs,storage.type.namespace.cs
- Matched theme rule: [bg: , fg:#569CD6, fontStyle: NotSet]
- token from 9 to 10 --> <-- with scopes source.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 10 to 17 -->Example<-- with scopes source.cs,entity.name.type.namespace.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:#4EC9B0, fontStyle: NotSet]
Tokenizing line: {
- token from 0 to 1 -->{<-- with scopes source.cs,punctuation.curlybrace.open.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- Matched theme rule: [bg: , fg:, fontStyle: -1]
Tokenizing line: }
- token from 0 to 1 -->}<-- with scopes source.cs
- Matched theme rule: [bg: , fg:, fontStyle: -1]
- token from 0 to 1 -->}<-- with scopes source.cs,punctuation.curlybrace.close.cs
```

## Demo

There is a demo project in [TextMateSharp.Demo](https://github.com/danipen/TextMateSharp/tree/master/src/TextMateSharp.Demo) folder.
There is a demo project in the [TextMateSharp.Demo](https://github.com/danipen/TextMateSharp/tree/master/src/TextMateSharp.Demo) folder.

![image](https://user-images.githubusercontent.com/501613/154065980-44b416ab-3b01-45f7-a8b3-7185413e769c.png)

Build and run:

```
cd src/TestMateSharp.Demo
```bash
cd src/TextMateSharp.Demo
dotnet build
dotnet run -- ./testdata/samplefiles/sample.cs
```

## License

TextMateSharp is licensed under the [MIT License](LICENSE.md).
Loading