공유/ESLint

[eslint] interface, type Pascal Case로 강제하기

구하천포 2024. 11. 14. 12:50

TypeScript로 개발할 때, interfacetype을 이용하여 타입을 선언하는 경우가 많습니다.
이때 일반적으로 Pascal Case를 사용하여 타입 이름을 작성하는데, ESLint를 이용해 이를 강제하는 방법을 알아보겠습니다.

{
  rules: {
    '@typescript-eslint/naming-convention': [
      'error',
      {
        selector: ['interface', 'typeAlias'], 
        format: ['PascalCase'],
        custom: {
          regex: '^[A-Z][a-zA-Z0-9]*$',
          match: true,
        },
      },
    ],
  },
} 

@typescript-eslint/naming-convention

@typescript-eslint/naming-convention은 TypeScript 코드에서 이름 규칙을 설정하는 규칙입니다.
위 설정에서는 selector를 통해 interfacetypeAlias를 선택합니다.
format 옵션을 PascalCase로 설정하여 Pascal Case로 작성되도록 강제합니다.

이 규칙을 적용하면, Pascal Case를 따르지 않는 타입이나 인터페이스에 대해 에러가 발생하여 코드 스타일을 일관되게 유지할 수 있습니다.

반응형