Skip to content

OPTIONS.md

Latest commit

 

History

History
147 lines (119 loc) · 4.15 KB

OPTIONS.md

File metadata and controls

147 lines (119 loc) · 4.15 KB
Raw

SQL Formatter Options Guide

The SQL Formatter now supports comprehensive formatting options!

Configuration Methods

1. Config File (.sqlformat.json)

Create a .sqlformat.json file in your project root:

{
  "indentSize": 2,
  "useSpaces": true,
  "maxLineLength": 120,
  "keywordCasing": "Lower",
  "bracketSpacing": "NoSpaces",
  "blankLinesBetweenClauses": 1,
  "maxInlineSelectColumns": 1,
  "maxInlineInsertColumns": 4
}

The formatter searches for config files in this order:

  1. Current directory
  2. Parent directories (up to root)
  3. User home directory

2. Console App Command-Line Arguments

# Lowercase keywords with 2-space indent
sqlformat -File input.sql -KeywordCasing Lower -IndentSize 2

# Use tabs and 120-char line length
sqlformat -Sql "SELECT * FROM Users" -UseTabs -MaxLineLength 120

# Specify config file explicitly
sqlformat -File input.sql -ConfigFile custom-format.json

# Pipe input with options
cat query.sql | sqlformat -KeywordCasing Pascal -IndentSize 4

Available command-line options:

  • -IndentSize <number> - Spaces/tabs per indent level (default: 4)
  • -UseSpaces - Use spaces for indentation (default: true)
  • -UseTabs - Use tabs for indentation
  • -MaxLineLength <number> - Max line length before wrapping (default: 80)
  • -KeywordCasing <style> - Upper, Lower, or Pascal (default: Upper)
  • -BracketSpacing <style> - NoSpaces or WithSpaces (default: NoSpaces)
  • -ConfigFile <path> - Path to .sqlformat.json config file

3. Blazor Web UI

The web interface includes a collapsible Formatting Options panel with:

  • Indent Size - Numeric input (0-16)
  • Use Spaces - Toggle switch
  • Max Line Length - Numeric input (20-1000)
  • Keyword Casing - Dropdown: UPPERCASE, lowercase, PascalCase
  • Bracket Spacing - Dropdown: (value) or ( value )
  • Blank Lines Between Clauses - Numeric input (0-5)
  • Max Inline SELECT Columns - Numeric input
  • Max Inline INSERT Columns - Numeric input

Options are saved to browser LocalStorage automatically when you click "Save Options" and persist across sessions.

4. Programmatic API

using Laan.Sql.Formatter;

// Using default options
var engine = new FormattingEngine();
var formatted = engine.Execute(sql);

// Using custom options
var options = new FormattingOptions
{
    IndentSize = 2,
    UseSpaces = true,
    MaxLineLength = 120,
    KeywordCasing = KeywordCasing.Lower,
    BracketSpacing = BracketSpacing.NoSpaces,
    BlankLinesBetweenClauses = 1,
    MaxInlineSelectColumns = 1,
    MaxInlineInsertColumns = 4
};
var engine = new FormattingEngine(options);
var formatted = engine.Execute(sql);

// Load from config file
var engine = FormattingEngine.CreateWithConfigFile(".sqlformat.json");
var formatted = engine.Execute(sql);

// Auto-discover config in directory hierarchy
var options = FormattingOptionsLoader.TryLoadFromHierarchy();
var engine = new FormattingEngine(options);

Available Options

Option Type Default Description
indentSize int 4 Number of spaces or tabs per indent level
useSpaces bool true Use spaces (true) or tabs (false) for indentation
maxLineLength int 80 Maximum line length before wrapping
keywordCasing enum Upper SQL keyword casing: Upper, Lower, or Pascal
bracketSpacing enum NoSpaces Bracket spacing: NoSpaces (value) or WithSpaces ( value )
blankLinesBetweenClauses int 1 Number of blank lines between major SQL clauses
maxInlineSelectColumns int 1 Maximum SELECT columns to display inline before wrapping
maxInlineInsertColumns int 4 Maximum INSERT columns to display inline before wrapping

Examples

Compact Style

{
  "indentSize": 2,
  "maxLineLength": 120,
  "keywordCasing": "Lower",
  "maxInlineSelectColumns": 3
}

Traditional Style

{
  "indentSize": 4,
  "maxLineLength": 80,
  "keywordCasing": "Upper",
  "bracketSpacing": "NoSpaces",
  "blankLinesBetweenClauses": 2
}

Modern Style

{
  "indentSize": 2,
  "useSpaces": true,
  "maxLineLength": 120,
  "keywordCasing": "Pascal",
  "blankLinesBetweenClauses": 1
}