sleek
A CLI tool and VS Code extension for formatting SQL to maintain consistent style and improve readability.
What is sleek?
Sleek is a SQL formatting tool that automatically formats SQL code to ensure consistent style and improve readability. It helps developers maintain clean, standardized SQL across projects by offering customizable formatting options and batch processing capabilities.
Database developers, data engineers, and backend developers who write and maintain SQL queries and want to enforce consistent formatting standards.
Developers choose Sleek for its simplicity, configurability, and seamless integration into workflows via CLI and VS Code extension, eliminating manual SQL formatting efforts.
Overview
Sleek is a CLI tool for formatting SQL. It helps you maintain a consistent style across your SQL code, enhancing readability and productivity.
Use Cases
Best For
- Enforcing consistent SQL style across team projects
- Formatting large batches of SQL files using glob patterns
- Checking if SQL files are already formatted without altering them
- Integrating SQL formatting into VS Code for real-time formatting
- Automating SQL formatting in CI/CD pipelines
- Improving readability of complex nested SQL queries
Not Ideal For
- Teams working with database-specific SQL dialects like T-SQL or PL/SQL that require specialized formatting rules
- Developers using IDEs other than VS Code who need built-in SQL formatting extensions
- Projects requiring advanced formatting features such as line width limits, comment preservation, or complex style guides
Pros & Cons
Pros
Sleek allows precise control over indentation spaces and keyword casing, with defaults like 4-space indents and uppercase keywords, making it easy to adapt to team preferences.
Supports glob patterns to format multiple SQL files at once, enhancing productivity for large codebases, as shown in the examples with 'queries/*.sql'.
The --check flag enables verification of formatting without altering files, ideal for CI/CD pipelines or pre-commit hooks to enforce style consistency.
Available as a VS Code extension for seamless in-editor formatting, improving developer workflow with real-time SQL cleanup.
Cons
Sleek focuses on basic formatting like indentation and keyword case, lacking support for line wrapping, comment alignment, or database-specific syntax, which might not meet all styling needs.
While binaries are available, installing via Cargo requires Rust, which could be a barrier for teams not using Rust in their stack, as noted in the installation section.
The VS Code extension is the only IDE integration mentioned, limiting usability for developers on other platforms like IntelliJ or Sublime Text without community plugins.
Frequently Asked Questions
Related Projects
PHP ParserA PHP parser written in PHP
TypeScript ESLint:sparkles: Monorepo for all the tooling which enables ESLint to support TypeScript
pyrightStatic Type Checker for Python
Reviewdog🐶 Automated code review tool integrated with any code analysis tools regardless of programming language
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.