node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


Build Status Build Status codecov

npm version npm Gitter chat


TSQLLint is a tool for describing, identifying, and reporting on undesirable patterns in TSQL scripts.


The recommended method of installing tsqllint is to install the tool globally using NPM.

This binary can be installed though the npm registry. First, install Node.js version 4 or higher, and then installation is done using the npm install command:

npm install tsqllint -g


# lint a single file
tsqllint test.sql
# lint all files in a directory
tsqllint c:\database_scripts
# lint a list of files and directories, paths with whitespace must be enclosed in quotes
tsqllint file_one.sql file_two.sql "c:\database scripts"
# lint using wild cards
tsqllint c:\database_scripts\file*.sql
# print path to .tsqllintrc config file
tsqllint --print-config
# display usage info
tsqllint --help
# list the plugins loaded
tsqllint --list-plugins

Integrating TSQLLint with other Tools

Visual Studio Code Extension

TSQLLint is built into a Visual Studio Code Extension. This extension can be installed from within the VS Code Extension Interface or from the VS Code Extension marketplace.

Usage Example

SQL Server Management Studio

TSQLLint uses a common message format that allows for integration into off the shelf tools. SQL Server Management Studio can use TSQLLint using SSMS's External Tools feature.

SSMS Integration Image


# generate a default .tsqllintrc file using the init flag (optional if just using a default configuration) 
tsqllint --init

Creating custom configurations

Configure tsqllint by editing its config file, .tsqllintrc you can find its location with the "--print-confg" or "-p" option.

TSQLLint will load its config file in the following order or prescidence:

  1. The value passed with the -c command line argument
  2. An Environment Variable named TSQLLINTRC
  3. A file named .tsqllintrc in the same local directory in which you are running TSQLLint
  4. A file named .tsqllintrc in the user's home directory

Rules may be set to "off", "warning", or "error".

    "rules": {
        "concat-strings": "error",
        "conditional-begin-end": "error",
        "cross-database-transaction": "error",
        "data-compression": "error",
        "data-type-length": "error",
        "disallow-cursors": "error",
        "full-text": "error",
        "information-schema": "error",
        "keyword-capitalization": "error",
        "linked-server": "error",
        "multi-table-alias": "error",
        "non-sargable": "error",
        "object-property": "error",
        "print-statement": "error",
        "schema-qualify": "error",
        "select-star": "error",
        "semicolon-termination": "error",
        "set-ansi": "error",
        "set-nocount": "error",
        "set-quoted-identifier": "error",
        "set-transaction-isolation-level": "error",
        "set-variable": "error",
        "upper-lower": "error"

Disabling Rules with Inline Comments

To temporarily disable rule warnings in a script, use comments in the following format:

/* tsqllint-disable */
/* tsqllint-enable */

You can also disable or enable warnings for specific rules:

/* tsqllint-disable select-star */
/* tsqllint-enable select-star */

To disable warnings for the entire script, place a /* tsqllint-disable */ comment at the top of the file:

/* tsqllint-disable */

To disable specific rule warnings for the entire script place a comment similar to the following at the top of the file:

/* tsqllint-disable select-star */


You can extend the base functionality of TSQLLint by creating a custom plugin. TSQLLint plugins are .Net assemblies that implement the IPlugin interface from TSQLLint.Common.

Once you complete your plugin, update your .tsqllintrc file to point to your assembly.

    "rules": {
        "upper-lower": "error"
    "plugins": {
        "my-first-plugin": "c:/users/someone/my-plugins/my-first-plugin.dll",
        "my-second-plugin": "c:/users/someone/my-plugins/my-second-plugin.dll/"

This sample plugin notifies users that spaces should be used rather than tabs.

using System;
using TSQLLint.Common;
namespace TSQLLint.Tests.UnitTests.PluginHandler
    public class SamplePlugin : IPlugin
        public void PerformAction(IPluginContext context, IReporter reporter)
            string line;
            var lineNumber = 0;
            while ((line = context.FileContents.ReadLine()) != null)
                var column = line.IndexOf("\t", StringComparison.Ordinal);
                reporter.ReportViolation(new SampleRuleViolation(
                    "Should use spaces rather than tabs",
    class SampleRuleViolation : IRuleViolation
        public int Column { get; private set; }
        public string FileName { get; private set; }
        public int Line { get; private set; }
        public string RuleName { get; private set; }
        public RuleViolationSeverity Severity { get; private set; }
        public string Text { get; private set; }
        public TestRuleViolation(string fileName, string ruleName, string text, int lineNumber, int column, RuleViolationSeverity ruleViolationSeverity)
            FileName = fileName;
            RuleName = ruleName;
            Text = text;
            Line = lineNumber;
            Column = column;
            Severity = ruleViolationSeverity;