NestJS - 네이밍 규칙

NestJS는 일반적으로 아래와 같은 규칙을 따른다.

 

 

1. 파일명은 .으로 연결하고, 둘 이상의 단어로 구성되어 있을 시 -로 연결

hello.controller.ts
my-first.controller.ts

 

2. 클래스명은 카멜 케이스 사용

HelloController
MyFirstController

 

3. 같은 디렉터리에 있는 클래스의 경우 index.ts 사용

// index.ts 미사용
import { HelloController } from './contrllers/hello.controller'
import { MyFirstController } from './contrllers/my-first.controller'

// index.ts 사용
import { HelloController, MyFirstController } from './contrllers'

 

4. 인터페이스의 경우 이름 앞에 I를 붙이는 건 비추천

• Series라는 타입을 정의할 때 ISeries 보다는, Series 인터페이스를 만들고 그 하위 인터페이스나 클래스를 만드는 것을 추천

interface Series {}
interface BookSeries extends Series {}
class MovieSeries extends Series {}

 

---

참고

- Node.js 백엔드 개발자 되기