TSLint는 TypeScript 코드베이스의 일관성을 유지하고 품질을 향상시키는 데 도움이 되는 유용한 도구입니다. 이 블로그 포스트에서는 TSLint를 사용하여 코드베이스의 일관성을 유지하는 몇 가지 방법을 살펴보겠습니다.

1. TSLint 설정

TSLint는 프로젝트에 적용할 수 있는 다양한 규칙을 제공합니다. 우선적으로, TSLint 구성 파일을 프로젝트 루트 디렉터리에 생성해야 합니다. 일반적으로 tslint.json이라는 파일 이름을 사용합니다. 이 파일에는 적용할 규칙, 제외할 파일 등을 설정할 수 있습니다.

아래는 예시 tslint.json 파일의 내용입니다.

{
  "extends": "tslint:recommended",
  "rules": {
    "indent": [true, "spaces", 2],
    "semicolon": false,
    "variable-name": [true, "ban-keywords"],
    // 추가적인 규칙 설정
  },
  "exclude": [
    "node_modules/**",
    "**/*.spec.ts"
  ]
}

위 설정은 TSLint의 기본 규칙을 사용하면서 들여쓰기를 스페이스 2칸으로 설정하고 세미콜론은 사용하지 않도록 합니다. 또한, 변수명에 예약어 사용을 금지하도록 설정하였습니다. 필요에 따라 추가적인 규칙을 설정할 수 있습니다. 또한, exclude 배열을 사용하여 특정 파일이나 디렉터리를 무시하도록 설정할 수 있습니다.

2. 자동화된 TSLint 실행

TSLint를 사용하여 코드베이스의 일관성을 유지하는 가장 효과적인 방법은 자동화된 실행입니다. 이를 위해 여러 방법을 사용할 수 있습니다. 예를 들어, package.json 파일의 scripts 섹션에 TSLint를 실행하는 명령어를 추가할 수 있습니다.

아래는 package.json 파일의 일부분입니다.

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "lint": "tslint -c tslint.json '**/*.ts'"
    // TSLint 실행 명령어
  },
  "devDependencies": {
    "tslint": "^5.20.1"
    // TSLint 의존성 추가
  }
}

위 예시에서는 lint라는 스크립트를 정의하여 TSLint를 실행하는 명령어를 설정하였습니다. 이제 npm run lint 명령을 실행하면 프로젝트의 모든 .ts 파일에 대해 TSLint가 실행됩니다.

3. 에디터 플러그인 사용

TSLint를 사용하여 코드베이스의 일관성을 유지하는 또 다른 방법은 에디터 플러그인을 사용하는 것입니다. 대부분의 인기있는 텍스트 편집기와 IDE에는 TSLint 플러그인이 제공됩니다. 이 플러그인을 설치하면 코드를 작성하는 동안 실시간으로 TSLint 오류와 경고를 표시할 수 있습니다.

예를 들어, Visual Studio Code를 사용하는 경우 “TSLint”라는 플러그인을 설치할 수 있습니다. 이 플러그인을 설치하면 편집기 창에 TSLint의 오류 및 경고가 표시되어 코드 작성 중에 이를 알 수 있습니다.

마치며

위에서 언급한 방법을 사용하여 TSLint를 사용하여 코드베이스의 일관성을 유지할 수 있습니다. TSLint를 적절하게 구성하고 자동화 실행 및 에디터 플러그인을 활용하여 프로젝트의 품질을 향상시키세요.

#TypeScript #TSLint