keywordcase

README

yze-sql-keywordcase

A yze-sql family analyzer that reports PostgreSQL keywords not written in lowercase (uppercase is the error), per the gomatic SQL standard. It tokenizes each .sql file with the shared gomatic/go-sql library — a thin wrapper over libpg_query, PostgreSQL's own lexer — and flags any keyword token whose text is not already lowercase.

• Rule: yze-sql/keywordcase · Tool: yze-sql
• Library: Diagnostics(path, source) and Report(read, files) emit go-yze Diagnostics (the stickler-json contract); a lexical scan error comes back wrapped in go-sql's ErrScan.
• Binary: cmd/yze-sql-keywordcase <paths...> walks directories for *.sql, analyzes, and prints the stickler-json report — so stickler runs it as a declarative runner (a .stickler.yaml define: entry, format: stickler-json).

Because go-sql wraps full PostgreSQL, the recognized keyword set is complete (not a DDL subset).

Documentation

Overview

Package keywordcase reports PostgreSQL keywords that are not written in lowercase, per the gomatic SQL standard (keywords are lowercase; uppercase and title-case are the error). It tokenizes SQL with the shared gomatic/go-sql library — a thin wrapper over libpg_query, PostgreSQL's own lexer — and flags any keyword token whose text is not already its lowercase form. Quoted identifiers and keyword text inside string literals are not keyword tokens, so they are never flagged.

Index

• Constants
• func Diagnostics(path, source string) ([]goyze.Diagnostic, error)
• func Report(read FileReader, files []string) (goyze.Report, error)
• type FileReader

Constants

const ErrReadFile errs.Const = "cannot read SQL file"

ErrReadFile reports that a SQL source file could not be read.

const Rule = "yze-sql/keywordcase"

Rule is the stable rule id every diagnostic carries.

const Tool = "yze-sql"

Tool is the runner name stamped on every diagnostic, matching the yze-sql family.

Functions

func Diagnostics

func Diagnostics(path, source string) ([]goyze.Diagnostic, error)

Diagnostics reports every keyword token in source whose text is not its canonical lowercase spelling. A lexical error scanning source is returned (wrapped in sql.ErrScan) so the caller can surface it as a tool failure rather than a clean pass. path is stamped on each diagnostic's location. Positions are computed in a single forward pass over source, so a file of any size costs O(n).

func Report

func Report(read FileReader, files []string) (goyze.Report, error)

Report runs the keyword-case check over each file and aggregates the diagnostics into the lean stickler-json report. A read failure aborts with ErrReadFile; a lexical scan failure aborts with the wrapped sql.ErrScan.

Types

type FileReader

type FileReader func(path string) ([]byte, error)

FileReader reads a file's bytes; injected so aggregation is testable without the filesystem.