CodePunk.Highlight 0.1.0

CodePunk.Highlight

A powerful and extensible syntax highlighting library built on top of Spectre.Console, designed for beautiful terminal output with rich color support.

Features

• Rich Syntax Highlighting - Beautiful, colorized syntax highlighting for multiple programming languages
• Built on Spectre.Console - Leverages the power and elegance of Spectre.Console
• Extensible Architecture - Easy to add support for new languages
• Zero Configuration - Works out of the box with sensible defaults
• Language Detection - Automatic language detection from file extensions
• Multiple Renderers - Direct console output or markup string generation

Supported Languages

• C# (.cs, .csx, .razor)
• JavaScript (.js, .jsx, .mjs, .cjs)
• TypeScript (.ts, .tsx, .cts, .mts)
• Python (.py, .pyw)
• SQL (.sql)
• Go (.go)
• Java (.java)

Installation

Install via NuGet:

dotnet add package CodePunk.Highlight

Or via Package Manager Console:

Install-Package CodePunk.Highlight

Quick Start

Basic Usage

using CodePunk.Highlight.SyntaxHighlighting;
using CodePunk.Highlight.SyntaxHighlighting.Languages;
using CodePunk.Highlight.Rendering;
using Spectre.Console;

// Set up the highlighter with supported languages
var languages = new ILanguageDefinition[]
{
    new CSharpLanguageDefinition(),
    new JavaScriptLanguageDefinition(),
    new TypeScriptLanguageDefinition(),
    new PythonLanguageDefinition(),
    new SqlLanguageDefinition(),
    new GoLanguageDefinition(),
    new JavaLanguageDefinition()
};

var highlighter = new SyntaxHighlighter(languages);

// Highlight C# code
string code = """
    public class HelloWorld
    {
        public static void Main(string[] args)
        {
            Console.WriteLine("Hello, World!");
        }
    }
    """;

var renderer = new SpectreTokenRenderer(AnsiConsole.Console);
highlighter.Highlight(code, "csharp", renderer);

Language Detection from File Path

using CodePunk.Highlight.SyntaxHighlighting;

// Automatically detect language from file extension
string filePath = "MyClass.cs";
string? languageId = LanguageDetector.FromPath(filePath);

if (languageId != null)
{
    var renderer = new SpectreTokenRenderer(AnsiConsole.Console);
    highlighter.Highlight(code, languageId, renderer);
}

Generate Markup Strings

If you want to generate Spectre markup strings instead of directly writing to the console:

using System.Text;
using CodePunk.Highlight.Rendering;

var builder = new StringBuilder();
var renderer = new MarkupTokenRenderer(builder);

highlighter.Highlight(code, "csharp", renderer);

string markup = builder.ToString();
AnsiConsole.MarkupLine(markup);

Advanced Usage

Custom Token Renderer

Implement your own renderer by implementing the ITokenRenderer interface:

using CodePunk.Highlight.SyntaxHighlighting.Abstractions;
using CodePunk.Highlight.SyntaxHighlighting.Tokenization;

public class CustomRenderer : ITokenRenderer
{
    public void BeginRender()
    {
        // Called before rendering starts
    }

    public void RenderToken(Token token)
    {
        // Render each token
        // token.Type: TokenType (Keyword, String, Comment, etc.)
        // token.Value: string content
    }

    public void EndRender()
    {
        // Called after rendering completes
    }
}

List Available Languages

var availableLanguages = highlighter.GetLanguages();

foreach (var language in availableLanguages)
{
    AnsiConsole.MarkupLine($"[cyan]{language.Name}[/] (aliases: {string.Join(", ", language.Aliases)})");
}

Token Types

The library recognizes the following token types:

• Keyword - Language keywords (if, for, class, etc.)
• Type - Built-in types (int, string, bool, etc.)
• String - String literals
• Comment - Comments (single-line and multi-line)
• Number - Numeric literals
• Operator - Operators (+, -, *, etc.)
• Punctuation - Punctuation marks (;, {, }, etc.)
• Preprocessor - Preprocessor directives (#if, #define, etc.)
• Identifier - Variable and function names
• Text - Plain text

Color Scheme

The default color palette:

Architecture

CodePunk.Highlight
├── SyntaxHighlighting
│   ├── SyntaxHighlighter        - Main highlighter orchestrator
│   ├── LanguageDetector         - File extension to language mapping
│   ├── Abstractions
│   │   ├── ILanguageDefinition  - Language tokenizer interface
│   │   ├── ISyntaxHighlighter   - Main highlighter interface
│   │   └── ITokenRenderer       - Token rendering interface
│   ├── Languages
│   │   ├── CSharpLanguageDefinition
│   │   ├── JavaScriptLanguageDefinition
│   │   ├── TypeScriptLanguageDefinition
│   │   ├── PythonLanguageDefinition
│   │   ├── SqlLanguageDefinition
│   │   ├── GoLanguageDefinition
│   │   └── JavaLanguageDefinition
│   └── Tokenization
│       ├── Token               - Token data structure
│       └── TokenType           - Token type enumeration
└── Rendering
    ├── SpectreTokenRenderer    - Direct console output
    ├── MarkupTokenRenderer     - Generate markup strings
    └── TokenColorPalette       - Default color scheme

Contributing

Contributions are welcome! To add support for a new language:

1. Create a new class implementing ILanguageDefinition
2. Implement the Tokenize method with your language's syntax rules
3. Add the language to the LanguageDetector.FromPath method
4. Add unit tests in the test project

Requirements

• .NET 9.0 or higher
• Spectre.Console 0.49.1 or higher

Examples

Complete Console Application

using CodePunk.Highlight.SyntaxHighlighting;
using CodePunk.Highlight.SyntaxHighlighting.Languages;
using CodePunk.Highlight.Rendering;
using Spectre.Console;

var languages = new ILanguageDefinition[]
{
    new CSharpLanguageDefinition(),
    new PythonLanguageDefinition(),
    new JavaScriptLanguageDefinition()
};

var highlighter = new SyntaxHighlighter(languages);

// Python example
var pythonCode = """
    def fibonacci(n):
        if n <= 1:
            return n
        return fibonacci(n-1) + fibonacci(n-2)
    
    # Print first 10 fibonacci numbers
    for i in range(10):
        print(f"F({i}) = {fibonacci(i)}")
    """;

AnsiConsole.MarkupLine("[bold yellow]Python Code:[/]");
AnsiConsole.WriteLine();

var renderer = new SpectreTokenRenderer(AnsiConsole.Console);
highlighter.Highlight(pythonCode, "python", renderer);