Bored of not having a good SQL linter that works with whichever dialiect you're working with? Fluff is an extensible and modular linter designed to help you write good SQL and catch errors and bad SQL before it hits your database.
Sqlfluff is still in an open alpha phase - expect the tool to change significantly over the coming months, and expect potentially non-backward compatable api changes to happen at any point.
To get started just install the package, make a sql file and then run sqlfluff and point it at the file.
$ pip install sqlfluff
$ echo " SELECT a + b FROM tbl; " > test.sql
$ sqlfluff lint test.sql
== [test.sql] FAIL
L: 1 | P: 1 | L003 | Single indentation uses a number of spaces not a multiple of 4
L: 1 | P: 14 | L006 | Operators should be surrounded by a single space unless at the start/end of a line
L: 1 | P: 27 | L001 | Unnecessary trailing whitespaceFor more details on usage see the docs on github here.
There's lots to do in this project, and we're just getting started.
- Command line interface
- Basic linting, both of paths and files
- Version information
- Nicely formatted readout of linting success or fail
- Exist codes which reflect linting success or fail
- Filtering to particular codes in the linting step
- Allow basic correction of some linting codes
- Basic ANSI linting
- Simple whitespace testing
- Whitespace around operators
- Indentation (size and mix of tabs and spaces)
- Indentation between lines and when to indent
- Number of blank lines
- Indentation of comments
- Configurable linting
- Command line options for config
- Ability to read from config files
- Ignore particular rules
- Specifying particlar dialects to use
- Preconfiguring verbosity
- Dialects
- MySQL
- Redshift
- Detecting dialect from a config file of some kind