소개

소프트웨어 개발 과정에서 일관성은 매우 중요합니다. 변수명과 상수명은 코드의 가독성과 유지보수성에 큰 영향을 미치므로 일관되게 작성하는 것이 좋습니다. 이를 위해 TSLint는 TypeScript 프로젝트에서 변수명과 상수명을 검사하고 일관성을 유지하는 데 도움을 줄 수 있습니다.

설정

1. TSLint를 프로젝트에 추가합니다. npm install tslint --save-dev
2. tslint.json 파일을 프로젝트 루트 디렉토리에 생성하고 다음과 같이 설정합니다:

{
  "rules": {
    "variable-name": [
      true,
      "allow-pascal-case",
      "allow-leading-underscore"
    ]
  }
}

• allow-pascal-case: 파스칼 케이스 규칙을 허용합니다. 예를 들어, firstName과 같은 변수명은 허용됩니다.
• allow-leading-underscore: 언더스코어로 시작하는 변수명을 허용합니다. 예를 들어, _privateVar와 같은 변수명은 허용됩니다.

사용법

TSLint를 활용하여 변수 및 상수명을 일관되게 유지하는 것은 간단합니다. TypeScript 파일을 작성할 때 다음 규칙에 따라 변수명을 작성하면 됩니다:

1. 파스칼 케이스 (Pascal Case)로 작성합니다: firstName, lastName
2. 언더스코어 (_)로 시작하는 변수명을 사용해야 하는 경우 언더스코어를 사용합니다: _privateVar, _constantValue

예시

다음은 TSLint 규칙을 준수하는 변수명 및 상수명의 예입니다:

// 변수
let firstName: string;
let lastName: string;
let _privateVar: number;

// 상수
const MAX_COUNT: number = 10;
const _DEFAULT_COLOR: string = "red";

결론

TSLint를 사용하여 변수와 상수의 일관된 명명 규칙을 적용하면 코드의 가독성과 유지보수성이 향상됩니다. 잘 명명된 변수와 상수는 다른 개발자와의 협업을 더욱 용이하게 만들며, 오류를 줄이고 코드 품질을 향상시키는 데 도움이 됩니다.

#TSLint #코드일관성