SimpleFormatter 1.0.0

SimpleFormatter

Lightweight C-style language formatter that tokenizes code and renders HTML with CSS classes for styling.

Supported languages: C#, Java, C++, JavaScript, TypeScript.

Usage

var code = """
// hi
var msg = "Hello";
""";
var html = SimpleFormatter.SimpleCStyleLanguageFormatter.FormatCodeToHtml(code, new SimpleFormatter.CSharpFormatter());

Purpose

A simple formatter that supports C styles languages (C++, C#, Java, JS, TS) not requring external libs. The objective is to provide a good enough formatting for reading without the need for a real parser.

Implementation

The formatter is implemented in C# as a library and a command line tool. It targets .NET 10.0 and uses C# 14.0 features.

Files

• SimpleFormatter (library)

  • SimpleFormatter/ILanguageFormatter.cs � Language contract (identifier/operator helpers, Keywords, Theme) and CSS generator for themes.
  • SimpleFormatter/ICodeFormatter.cs � Base interface for code formatters (FormatCodeToHtml).
  • SimpleFormatter/SimpleCStyleLanguageFormatter.cs � Core tokenizer and HTML renderer (markers, guides, line numbers).
  • SimpleFormatter/Language.cs � BaseCStyleFormatter and concrete formatters: CSharpFormatter, JavaFormatter, CppFormatter, JavaScriptFormatter, TypeScriptFormatter.
  • SimpleFormatter/TokenType.cs � Token kind enumeration used by tokenization/formatting.
  • SimpleFormatter/SyntaxTheme.cs � Theme system, token-type?CSS-class mapping, default styles and colors.
  • SimpleFormatter/BaseDarkSyntaxTheme.cs � Base dark theme deriving from SyntaxTheme.
  • SimpleFormatter/CSharpSyntaxTheme.cs � C# theme tweaks.
  • SimpleFormatter/JavaSyntaxTheme.cs � Java theme tweaks.
  • SimpleFormatter/JavaScriptSyntaxTheme.cs � JavaScript theme tweaks.
  • SimpleFormatter/TypeScriptSyntaxTheme.cs � TypeScript theme tweaks.
  • SimpleFormatter/CppSyntaxTheme.cs � C++ theme tweaks.
  • SimpleFormatter/ThemeStyle.cs � Simple style holder used by SyntaxTheme.

• SimpleFormatter.Samples (console)

  • SimpleFormatter.Samples/Program.cs � Generates sample HTML pages for manual inspection.

• SimpleFormatter.Tests (MSTest)

  • SimpleFormatter.Tests/VisualOutputTests.cs � Produces HTML artifacts for multiple languages and real-world code; emits per-language CSS.

Class diagram

classDiagram
    class ICodeFormatter {
      +string FormatCodeToHtml(string)
      +ILanguageFormatter GetLanguage()
    }
    class ILanguageFormatter {
      +HashSet~string~ Keywords
      +SyntaxTheme Theme
      +string GetCss()
      +bool IsOperatorChar(char)
      +bool IsIdentStart(char)
      +bool IsIdentPart(char)
      +string LanguageName
    }
    class BaseCStyleFormatter
    class CSharpFormatter
    class JavaFormatter
    class CppFormatter
    class JavaScriptFormatter
    class TypeScriptFormatter

    class SimpleCStyleLanguageFormatter
    class SyntaxTheme {
      +int CharacterWidthPerTab
    }
    class BaseDarkSyntaxTheme
    class CSharpSyntaxTheme
    class JavaSyntaxTheme
    class JavaScriptSyntaxTheme
    class TypeScriptSyntaxTheme
    class CppSyntaxTheme

    class ThemeStyle {
      +string InlineStyle
    }
    class TokenType

    ILanguageFormatter <|.. BaseCStyleFormatter
    BaseCStyleFormatter <|-- CSharpFormatter
    BaseCStyleFormatter <|-- JavaFormatter
    BaseCStyleFormatter <|-- CppFormatter
    BaseCStyleFormatter <|-- JavaScriptFormatter
    BaseCStyleFormatter <|-- TypeScriptFormatter

    SyntaxTheme <|-- BaseDarkSyntaxTheme
    BaseDarkSyntaxTheme <|-- CSharpSyntaxTheme
    BaseDarkSyntaxTheme <|-- JavaSyntaxTheme
    BaseDarkSyntaxTheme <|-- JavaScriptSyntaxTheme
    BaseDarkSyntaxTheme <|-- TypeScriptSyntaxTheme
    BaseDarkSyntaxTheme <|-- CppSyntaxTheme

    SimpleCStyleLanguageFormatter ..> ILanguageFormatter : uses
    ILanguageFormatter --> SyntaxTheme : Theme
    SyntaxTheme o--> ThemeStyle : Data
    SimpleCStyleLanguageFormatter ..> TokenType : tokenizes