{"repo":"sbdchd/squawk","free":true,"listed":false,"github":"https://github.com/sbdchd/squawk","clone":"git clone https://github.com/sbdchd/squawk.git","description":"🐘 Linter for Postgres migrations & SQL","language":"PLpgSQL","stars":1154,"topics":["rust","postgres","sql","linter","postgresql"],"license":"Apache-2.0","category":"databases-storage","readme_excerpt":"squawk Linter for Postgres migrations & SQL Quick Start Playground Rules Documentation GitHub Action DIY GitHub Integration Why? Prevent unexpected downtime caused by database migrations and encourage best practices around Postgres schemas and SQL. Install Or via Docker You can also run Squawk using Docker. The official image is available on GitHub Container Registry. Or via the Playground Use the WASM powered playground to check your SQL locally in the browser! Or via VSCode Usage squawk --help Rules Individual rules can be disabled via the --exclude flag Disabling rules via comments Rule violations can be ignored via the squawk-ignore comment: You can also ignore multiple rules by making a comma seperated list: To ignore a rule for the entire file, use squawk-ignore-file : Or leave off the rule names to ignore all rules for the file Configuration file Rules can also be disabled with a configuration file. By default, Squawk will traverse up from the current directory to find a .squawk.toml configuration file. You may specify a custom path with the -c or --config flag. The --exclude flag will always be prioritized over the configuration file. Example .squawk.toml See the Squawk website for documentation on each rule with examples and reasoning. Bot Setup Squawk works as a CLI tool but can also create comments on GitHub Pull Requests using the upload-to-github subcommand. Here's an example comment created by squawk using the example.sql in the repo: See the \"GitHub Integration","default_branch":null,"files":null,"tree":[],"storefront":"/r/sbdchd","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/sbdchd/squawk/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}