tsirysndr / sqruff

A compact, high-speed SQL linter, engineered with Rust efficiency.

sqruff

SQRUFF is an innovative SQL linter and formatter for modern development environments, written in Rust. Key features include:

• Linting: Advanced, customizable SQL linting capabilities to ensure query quality.
• Formatting: Automated, configurable formatting for SQL code consistency.
• Portability: Designed to be easily integrated into various development workflows.

Getting Started

Installation

macOS

You can use brew to install sqruff easily on macOS.

brew install quarylabs/quary/sqruff

Linux

Using Bash:

curl -fsSL https://raw.githubusercontent.com/quarylabs/sqruff/main/install.sh | bash

For other platforms

For other platforms, compilie sqruff with cargo with the following commands.

rustup override set nightly
cargo install sqruff
sqruff --help

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines on how to contribute.

Releasing

1. Bump the versions in sqruff-lib/Cargo.toml and sqruff/Cargo.toml.
2. Commit the changes.
3. Push the changes.
4. Tag the commit with the new version
5. Release sqruff-lib crate

cargo publish -p sqruff-lib

5. Release sqruff crate

cargo publish -p sqruff

Community

Join the sqruff community on GitHub Discussions to ask questions, suggest features, or share your projects.