tsqllint

안티패턴 탐지 및 보고

TSQLLint은 TSQL 스크립트 내에서 다양한 코드 안티패턴을 식별합니다. 예를 들어, 대소문자 구분 변수, 조건부 BEGIN-END, COUNT(*), 크로스 데이터베이스 트랜잭션 등과 같은 패턴을 검사하여 오류 또는 경고로 보고합니다.

자동 수정 기능

–fix 또는 -x 플래그를 사용하여 자동으로 수정 가능한 문제를 해결할 수 있습니다.これにより、開発者は手動での修正作業を減らすことができます。

구성 가능한 규칙 엔진

사용자는 .tsqllintrc 구성 파일을 통해 각 규칙을 “off”, “warning”, 또는 “error”로 설정할 수 있습니다. 규칙이 “error”로 설정되어 위반되면 도구는 비-zero 종료 코드를 반환합니다.

플러그인 지원

TSQLLint은 Dotnet 어셈블리로 구현된 커스텀 플러그인을 통해 기능을 확장할 수 있습니다. 플러그인은 IPlugin 인터페이스를 구현해야 하며, .tsqllintrc 파일에 DLL 경로를 지정하여 로드할 수 있습니다.

SQL 호환성 레벨 구성

도구는 SQL Server의 호환성 레벨과 호환되는 구성 가능한 “compatibility-level”을 제공합니다. 기본값은 120이며, 80부터 150까지의 값을 .tsqllintrc 파일 또는 인라인 코멘트를 통해 설정할 수 있습니다.

다운로드·설치 방법

TSQLLint은 여러 패키지 관리자를 통해 설치할 수 있습니다. Windows 사용자는 dotnet 전역 도구로 설치하는 것이 권장됩니다.

dotnet tool 설치

.NET SDK가 설치된 환경에서 다음 명령을 실행하여 전역 도구로 설치할 수 있습니다:

$ dotnet tool install –global TSQLLint

Homebrew 설치 (macOS/Linux)

macOS 및 Linux에서는 Homebrew를 사용하여 설치할 수 있습니다:

$ brew tap tsqllint/homebrew-tsqllint $ brew install tsqllint

NPM 설치

Node.js 4 이상이 설치된 환경에서 NPM을 통해 설치할 수 있습니다:

npm install tsqllint -g

기본 사용법/명령어

설치 후 tsqllint 명령을 통해 TSQL 파일을 린트할 수 있습니다. 기본 사용법은 다음과 같습니다:

단일 파일 린트

tsqllint test.sql

자동 수정 실행

tsqllint –fix test.sql

디렉터리 내 모든 파일 린트

tsqllint c:database_scripts

공백이 포함된 경로 처리

tsqllint file_one.sql file_two.sql “c:database scripts”

와일드카드 사용

tsqllint c:database_scriptssp_*.sql

설정 파일 경로 출력

tsqllint –print-config

도움말 보기

tsqllint –help

로드된 플러그인 목록 보기

tsqllint –list-plugins

기본 사용법/명령어

설치 후 tsqllint 명령을 통해 TSQL 파일을 린트할 수 있습니다. 기본 사용법은 다음과 같습니다:

단일 파일 린트

tsqllint test.sql

자동 수정 실행

tsqllint –fix test.sql

디렉터리 내 모든 파일 린트

tsqllint c:database_scripts

공백이 포함된 경로 처리

tsqllint file_one.sql file_two.sql “c:database scripts”

와일드카드 사용

tsqllint c:database_scriptssp_*.sql

설정 파일 경로 출력

tsqllint –print-config

도움말 보기

tsqllint –help

로드된 플러그인 목록 보기

tsqllint –list-plugins

이런 경우에 유용합니다

TSQLLint은 데이터베이스 개발자나 관리자가 TSQL 스크립트의 품질을 일관되게 유지해야 하는 상황에서 유용합니다. 특히 여러 개발자가 협업하는 환경에서 코드 스타일과 안티패턴을 자동으로 검사함으로써 리뷰 부담을 줄이고 배포 전 오류를 예방할 수 있습니다.

지원 환경·시스템 요구사항

TSQLLint은 .NET 기반 도구로, Windows, macOS, Linux에서 실행할 수 있습니다. 설치를 위해서는 해당 플랫폼에 맞는 런타임(.NET SDK, Homebrew, Node.js 등)이 필요합니다.

최신 버전·업데이트

현재 버전은 1.16.0이며, GitHub 저장소에서 지속적인 업데이트가 이루어지고 있습니다. 최신 변경 사항은 저장소의 커밋 히스토리를 통해 확인할 수 있습니다.

제한 사항·확인 사항

TSQLLint은 TSQL 스크립트에 특화된 도구로, 다른 SQL 방언(예: MySQL, PostgreSQL)에서는 의도대로 동작하지 않을 수 있습니다. 또한, 일부 고급 구현체(예: 커스텀 플러그인)를 사용하려면 .NET 개발 지식이 필요할 수 있습니다.

화면으로 보는 주요 기능

SQL 코드 편집 및 오류 로그 보기

SQL 코드 편집기 창에서 SQL 쿼리가 작성되어 있으며, 여러 주석과 SQL 문이 포함되어 있다. 하단에는 'Output' 탭이 열려 있고, 여기에는 tsqllint 도구가 실행된 결과로, 여러 SQL 오류 메시지가 나열되어 있다. 각 오류 메시지에는 파일 경로, 줄 번호, 오류 코드 및 설명이 포함되어 있다. 오류 목록의 하단에는 'Linted 1 files in 0.1899985 seconds'와 '17 Errors'라는 요약 정보가 표시되어 있다.