sql-lint

sql-lint documentation

Version in MegaLinter: 1.0.0
Visit Official Web Site
See How to configure sql-lint rules
- If custom .sql-config.json config file isn't found, .sql-config.json will be used
See Index of problems detected by sql-lint

Configuration in MegaLinter

Enable sql-lint by adding SQL_SQL_LINT in ENABLE_LINTERS variable
Disable sql-lint by adding SQL_SQL_LINT in DISABLE_LINTERS variable

Variable	Description	Default value
SQL_SQL_LINT_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS	User custom arguments to remove from command line before calling the linter Ex: `-s --foo "bar"`
SQL_SQL_LINT_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
SQL_SQL_LINT_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
SQL_SQL_LINT_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `project`: Call the linter from the root of the project	`file`
SQL_SQL_LINT_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".sql"]`
SQL_SQL_LINT_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
SQL_SQL_LINT_PRE_COMMANDS	List of bash commands to run before the linter	None
SQL_SQL_LINT_POST_COMMANDS	List of bash commands to run after the linter	None
SQL_SQL_LINT_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling SQL_SQL_LINT and its pre/post commands	None
SQL_SQL_LINT_CONFIG_FILE	sql-lint configuration file nameUse `LINTER_DEFAULT` to let the linter find it	`.sql-config.json`
SQL_SQL_LINT_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
SQL_SQL_LINT_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`
SQL_SQL_LINT_CLI_EXECUTABLE	Override CLI executable	`['sql-lint']`

IDE Integration

Use sql-lint in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	vim	ale	Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	121
c_cpp	Optimized for pure C/C++ projects	54
cupcake	MegaLinter for the most commonly used languages	83
documentation	MegaLinter for documentation projects	50
dotnet	Optimized for C, C++, C# or VB based projects	63
dotnetweb	Optimized for C, C++, C# or VB based projects with JS/TS	72
go	Optimized for GO based projects	52
java	Optimized for JAVA based projects	53
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	59
php	Optimized for PHP based projects	53
python	Optimized for PYTHON based projects	61
ruby	Optimized for RUBY based projects	50
rust	Optimized for RUST based projects	50
salesforce	Optimized for Salesforce based projects	54
swift	Optimized for SWIFT based projects	50
terraform	Optimized for TERRAFORM based projects	54

Behind the scenes

How are identified applicable files

File extensions: .sql

How the linting is performed

sql-lint is called one time by identified file (file CLI lint mode)

Example calls

sql-lint myfile.sql

sql-lint --config .sql-config.json myfile.sql

Help content

Usage: sql-lint [options]

Lint sql files and stdin for errors, oddities, and bad practices.

Options:
  -V, --version                output the version number
  --fix [string]               The .sql string to fix (experimental and alpha)
  -d, --driver <string>        The driver to use, must be one of ['mysql',
                               'postgres']
  -v, --verbose                Brings back information on the what it's linting
                               and the tokens generated
  --format <string>            The format of the output, can be one of
                               ['simple', 'json'] (default: "simple")
  --host <string>              The host for the database connection
  --user <string>              The user for the database connection
  --password <string>          The password for the database connection
  --port <string>              The port for the database connection
  --config <string>            The path to the configuration file
  --ignore-errors <string...>  The errors to ignore (comma separated)
  -h, --help                   display help for command

Installation on mega-linter Docker image

NPM packages (node.js):
- sql-lint