Static Analysis Rule-sets for SQL Projects

Overview

A library of SQL best practices implemented as more than 130 database code analysis rules checked at build time.

The rules can be added as NuGet packages to modern SQL Database projects based on either MSBuild.Sdk.SqlProj or Microsoft.Build.Sql.

You can also download and manually use the rules with Visual Studio and "classic" SQL Database projects, as described in my blog post here.

For a complete list of the current rules we have implemented see here.

Usage

The latest version is available on NuGet

dotnet add package ErikEJ.DacFX.SqlServer.Rules

You can read more about using and customizing the rules in the readme here

Command line tool - T-SQL Analyzer CLI

This repository also contains a .NET command line tool, that uses the rule sets.

You can use it to analyze SQL scripts, or SQL Database projects, and output the results in a variety of formats, including XML, and JSON.

You can also use the tool as a MCP Server with GitHub Copilot with VS Code and Visual Studio, allowing you to get feedback on your SQL code using GitHub Copilot Chat.

The T-SQL Analyzer MCP Server supports quick installation across multiple development environments. Choose your preferred client below for streamlined setup:

Read more in the dedicated readme file

Visual Studio extension - T-SQL Analyzer

This repository also contains a Visual Studio extension, that uses the rule sets.

You can run live analysis of your SQL Database projects in Visual Studio, and get the results in the Error List window.

Download the extension from the Visual Studio Marketplace or get the CI build

Read more in the dedicated readme file

Solution Organization

.github - GitHub actions

docs - markdown files generated from rule inspection with the DocsGenerator unit test

Solution Items - files relating to build etc.

src

• SqlServer.Rules - This holds the rules derived from SqlCodeAnalysisRule

test

• SqlServer.Rules.Tests - a few test to demonstrate unit testing of rules
• TestHelpers - shared test base classes

tools

• SqlAnalyzerCli - a command line tool to run rules against a SQL Project
• SqlAnalyzerVsix - a Visual Studio extension to run rules against a SQL Project
• ErikEJ.DacFX.TSQLAnalyzer - library and NuGet package for running rules against SQL scripts and reporting results. Used by SqlAnalyzerCli
• SqlServer.Rules.Generator - a quick console app to report on all rules in a SQL Project.
• SqlServer.Rules.Report - Library for evaluating a rule and serializing the result.

sqlprojects

• AW - AdventureWorks schema SQL Project for rules validation
• TestDatabase - a small SQL Database Project with some rule violations
• TSQLSmellsTest - a SQL Database Project with some rule violations