Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/purcell/sqlint
Simple SQL linter supporting ANSI and PostgreSQL syntaxes
https://github.com/purcell/sqlint
Last synced: 1 day ago
JSON representation
Simple SQL linter supporting ANSI and PostgreSQL syntaxes
- Host: GitHub
- URL: https://github.com/purcell/sqlint
- Owner: purcell
- License: mit
- Created: 2015-07-15T22:56:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T07:07:10.000Z (about 1 month ago)
- Last Synced: 2024-11-27T21:09:24.278Z (15 days ago)
- Language: Ruby
- Homepage:
- Size: 75.2 KB
- Stars: 420
- Watchers: 10
- Forks: 27
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
- my-awesome-github-stars - purcell/sqlint - Simple SQL linter supporting ANSI and PostgreSQL syntaxes (Ruby)
README
[](https://github.com/purcell/sqlint/actions/workflows/ci.yml)
[ ](https://rubygems.org/gems/sqlint)
[ ](https://rubygems.org/gems/sqlint)
## SQLint - a simple SQL linter
### About
SQLint is a simple command-line linter which reads your SQL files and
reports any syntax errors or warnings it finds.
At this stage, SQLint checks SQL against the ANSI syntax, and uses the
PostgreSQL SQL parser to achieve this. SQLint does not have support
for non-standard SQL variants (e.g. MySQL), but contributions are welcome.
### Installation
SQLint is currently provided as a ruby gem: you can install it using the following command:
```
gem install sqlint
```
### Usage
To check the syntax of a file containing SQL, simply pass the filename to `sqlint` on the command line:
```
sqlint filename.sql
```
In the absence of a filename, `sqlint` reads from standard input.
### Editor plugins
Support for `sqlint` is provided for the following editors:
- Emacs, via [Flycheck](https://github.com/flycheck/flycheck)
- VIM, via [Syntastic](https://github.com/scrooloose/syntastic), [Neomake](https://github.com/neomake/neomake) or [ALE](https://github.com/w0rp/ale)
- SublimeText, via [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter3/)
### Using with pre-commit
Add this to your `.pre-commit-hooks.yaml`:
```yaml
- repo: https://github.com/purcell/sqlint
rev: master
hooks:
- id: sqlint
```
### Authors
This software was written by
[Steve Purcell](https://github.com/purcell) and
[Kieran Trezona-le Comte](https://github.com/trezona-lecomte).
### License and copyright
Copyright 2015-2018 Powershop NZ Ltd.
Copyright 2018-2021 Steve Purcell.
MIT license.
[💝 Support this project and my other Open Source work via Patreon](https://www.patreon.com/sanityinc)
[💼 LinkedIn profile](https://uk.linkedin.com/in/stevepurcell)
[✍ sanityinc.com](http://www.sanityinc.com/)