Node.js에서 타입스크립트를 사용하여 프로젝트를 개발할 때, 일관된 코드 스타일과 컨벤션을 지키는 것은 매우 중요합니다. 이를 통해 코드 유지보수성을 향상시키고 팀원 간의 협업을 원활하게 할 수 있습니다. 이 가이드는 타입스크립트로 작성된 Node.js 프로젝트를 위한 일반적인 컨벤션 및 스타일 가이드의 예시를 제공합니다.

목차

• 프로젝트 구조
• 타입 선언
• 모듈 임포트
• 코딩 스타일
• 에러 핸들링

프로젝트 구조

타입스크립트로 작성된 Node.js 프로젝트의 일반적인 구조는 다음과 같을 수 있습니다:

project-root/
├── src/
│   ├── controllers/
│   ├── services/
│   ├── models/
│   └── app.ts
├── dist/
├── node_modules/
├── package.json
└── tsconfig.json

• src/: 타입스크립트 소스코드를 포함하는 디렉토리
• dist/: 빌드된 JavaScript 파일을 포함하는 디렉토리
• node_modules/: 프로젝트의 의존성 모듈을 포함하는 디렉토리
• package.json: 프로젝트의 의존성 및 스크립트를 정의하는 파일
• tsconfig.json: 타입스크립트 컴파일러 옵션을 정의하는 파일

타입 선언

타입스크립트에서는 항상 변수의 타입을 명시적으로 선언해야 합니다. 예를 들어:

interface User {
  id: number;
  name: string;
  email: string;
}

function getUser(id: number): User {
  // ...
}

모듈 임포트

모듈을 임포트할 때에는 다음과 같이 명시적인 경로를 사용하여 상대 경로보다는 절대 경로로 임포트하는 것이 좋습니다:

import { UserService } from 'src/services/userService';
import { Logger } from 'src/utils/logger';

코딩 스타일

코드의 일관성을 유지하기 위해 ESLint 및 Prettier와 같은 도구를 사용하여 코드 포맷팅과 스타일을 검사하는 것이 좋습니다.

에러 핸들링

타입스크립트에서는 try/catch를 사용하여 에러를 핸들링하는 것이 일반적입니다:

try {
  // ...
} catch (error) {
  console.error('An error occurred:', error);
}

이는 타입스크립트로 작성된 Node.js 프로젝트의 기본적인 컨벤션과 스타일 가이드의 예시일 뿐이며, 프로젝트의 성격과 팀의 필요에 따라 추가적인 커스터마이징이 필요합니다.