Method Format

pkg/formatter/formatter.go:124–172

Format parses and re-formats a SQL string.

(sql string)

// Format parses and re-formats a SQL string.
func (f *Formatter) Format(sql string) (string, error) {
	if strings.TrimSpace(sql) == "" {
		return "", nil
	}

	tkz := tokenizer.GetTokenizer()
	defer tokenizer.PutTokenizer(tkz)

	tokens, err := tkz.Tokenize([]byte(sql))
	if err != nil {
		return "", fmt.Errorf("tokenization failed: %w", err)
	}

	if len(tokens) == 0 {
		return "", nil
	}

	// Capture comments from tokenizer before parsing
	comments := tkz.Comments

	p := parser.GetParser()
	defer parser.PutParser(p)
	parsedAST, err := p.ParseFromModelTokens(tokens)
	if err != nil {
		return "", fmt.Errorf("parsing failed: %w", err)
	}
	defer ast.ReleaseAST(parsedAST)

	// Attach captured comments to AST
	if len(comments) > 0 {
		parsedAST.Comments = make([]models.Comment, len(comments))
		copy(parsedAST.Comments, comments)
	}

	// Build format options and delegate to the visitor-based renderer.
	style := ast.ReadableStyle()
	if f.opts.Compact {
		style = ast.CompactStyle()
	}
	if f.opts.IndentSize > 0 {
		style.IndentWidth = f.opts.IndentSize
	}
	if f.opts.Uppercase {
		style.KeywordCase = ast.KeywordUpper
	}
	style.Dialect = f.opts.Dialect

	return FormatAST(parsedAST, style), nil
}

// FormatString is a convenience function that formats SQL with default options.
func FormatString(sql string) (string, error) {