GDShrapt.Formatter 5.0.0

GDShrapt.Formatter

Configurable code formatting for GDScript 2.0 (Godot 4.x) with auto type inference.

Features

• Rule-based formatting - 8 configurable formatting rules (GDF001-GDF008)
• Auto type hints - Automatically add inferred type hints to untyped variables
• Style extraction - Learn formatting style from sample code
• LSP compatible - Options map directly to LSP textDocument/formatting
• Presets - Default, GDScriptStyleGuide, Minimal

Quick Start

using GDShrapt.Reader;

var code = @"func test():
	var x=10+5
	print(x)
";

var formatter = new GDFormatter();
var formatted = formatter.FormatCode(code);
// Result: properly spaced "var x = 10 + 5"

Format Rules

Formatter Options

var options = new GDFormatterOptions
{
    IndentStyle = IndentStyle.Tabs,
    IndentSize = 4,
    SpaceAroundOperators = true,
    SpaceAfterComma = true,
    MaxLineLength = 100,
    WrapLongLines = true,
    RemoveTrailingWhitespace = true,
    EnsureTrailingNewline = true
};

var formatter = new GDFormatter(options);

Auto Type Inference (GDF007)

Automatically add type hints using type inference:

var options = new GDFormatterOptions
{
    AutoAddTypeHints = true,
    AutoAddTypeHintsToClassVariables = true,
    AutoAddTypeHintsToLocals = true,
    UnknownTypeFallback = "Variant"
};

var formatter = new GDFormatter(options);
var code = "var x = 10\nvar name = \"hello\"";
var result = formatter.FormatCode(code);
// Result: var x: int = 10
//         var name: String = "hello"

Format by Example

Extract style from sample code and apply to other code:

var formatter = new GDFormatter();

// Sample with 2-space indentation
var sampleCode = @"func sample():
  var x = 10
";

var codeToFormat = @"func test():
	var y = 20
";

// Will format using 2-space indentation
var result = formatter.FormatCodeWithStyle(codeToFormat, sampleCode);

Presets

var formatter = new GDFormatter(GDFormatterOptions.Default);
var formatter = new GDFormatter(GDFormatterOptions.GDScriptStyleGuide);
var formatter = new GDFormatter(GDFormatterOptions.Minimal);

Related Packages

Documentation

Full documentation and examples: GitHub Repository

License

MIT License - see LICENSE for details.