[Feat] PNPM + Turborepo를 통한 모노레포 환경 구성

[seoko97]

관련 이슈 번호

close #2

작업 내용

• 모노레포 초기 설정
• 공통 eslint, prettier rule 설정
• 공통 tsconfig 설정

PR 포인트

• eslint rule
• husky
• turborepo: 현재 가장 기본적인 설정만 진행되었습니다. 추후 기술스택에 따라 설정을 진행할 에정입니다.

고민과 학습내용

Eslint

현재 설정되어 있는 eslint rule은 다음과 같습니다.

1. typescript 기본 설정
2. import 순서 설정
3. naming convention

import 순서에 경우 다음과 같은 순서로 설정되었습니다.

1. node 내장 모듈
2. 설치된 의존성 모듈
3. 워크스페이스 모듈
4. 현재 워크스페이스에서 설정된 절대 경로
5. 상대 경로
6. 타입

import path from 'path';

import zod from 'zod';
import test1 from '@repo/shards';

import test2 from '@/';

import test3 from './';

import type { Test } from './';

파일 저장시 자동으로 해당 경로로 변경되며 만약 순서가 잘못되었다면 오류가 발생합니다.

//`path` import should occur before import of `zod`
import zod from 'zod';
import path from 'path';

import test1 from '@repo/shards';

import test2 from '@/';

import test3 from './';

import type { Test } from './';

naming convention에 경우 다음과 같습니다.

1. 변수: camelCase, PascalCase, UPPER_CASE
2. 함수: camelCase, PascalCase
3. class, enum 등 (포괄 설정): PascalCase
4. interface: PascalCase, I prefix를 허용하지 않음
5. typeAlias: PascalCase, T prefix를 허용하지 않음
6. typeParameter: PascalCase, T prefix를 허용하지 않음

만약 컨벤션을 지키지 않았다면 오류가 발생합니다.

// Type Alias name `THi` must not match the RegExp: /^T[A-Z]/u
type THi = {
  hi: string;
};

Husky

Husky를 통해 다음과 같은 검증을 진행합니다.

1. pre-commit: 커밋전 스테이지 파일 검증
2. commit-msg: 커밋 후 커밋 메시지에 대한 검증을 진행

pre-commit시 lint 명령을 통해 검증을 진행한다면 모든 파일에 대해서 lining을 진행하기 때문에 lint-staged를 통해 현재 스테이지된 파일만 검증합니다.

{
  "name": "web21",
  "private": true,
  "scripts": {
    "lint": "turbo lint",
    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,md}\"",
    "prepare": "husky"
  },
  "devDependencies": {
    "husky": "^9.1.6",
    "lint-staged": "^15.2.10",
  },
  "lint-staged": {
    "**/*.{js,jsx,ts,tsx}": [
      "eslint --fix",
      "prettier --write"
    ],
    "**/*.{json,md}": [
      "prettier --write"
    ]
  }
}

commit-msg에 경우 다음과 같은 검증을 진행합니다.

1. {타입}: {메시지} 형식이 지켜지지 않았을 경우 오류 발생
2. feat|test|fix|docs|test|refactor|design|style|chore가 포함되지 않았다면 오류 발생

commit-msg을 진행하며 발생한 성공/실패 여부에 대해 사용자에게 메시지를 제공합니다.

자세한 실행 결과는 스크린샷을 통해 확인할 수 있습니다.

스크린샷

Turborepo

Husky

1. pre-commit 실패	2. commit-msg 실패	3. commit-msg 성공

[github-actions]

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

[Fixtar]

🚀

[simeunseo]

고생 많으셨습니다! 🚀🚀🚀