Skip to content

설정 체계 설명

English

설정 출처와 우선순위

같은 이름의 설정 항목은 다음 우선순위를 따릅니다.

  1. Notion Config 테이블
  2. 환경 변수
  3. 로컬 설정 파일(blog.config.js / conf/*.config.js)

권장 방식

  • 큰 설정 블록은 conf/*.config.js로 분리합니다.
  • blog.config.js는 집계 역할만 하도록 유지해 파일이 끝없이 커지는 것을 피합니다.
  • 새 설정 항목을 추가할 때는 다음을 명확히 적습니다.
    • 기본값
    • 환경 변수 이름
    • Notion Config의 같은 이름 키

오픈소스 협업에서 위험한 지점(필수 준수)

1) 개인화된 설정을 커밋하지 않기

아래 내용은 보통 개인 환경에 속하므로 커밋하지 않아야 합니다.

  • .env.local
  • 개인 key/token이 포함된 설정
  • 개인 광고 ID, 통계 ID, 서드파티 트래킹 ID가 포함된 기본값
  • 개인 사이트에서만 쓰는 내비게이션/메뉴/테마 전용 설정

2) 작업과 무관한 설정 파일 수정 피하기

예를 들어 컴포넌트 버그 하나만 고치는 작업이라면, 많은 conf/*.config.js의 정렬이나 포맷을 함께 바꾸지 않아야 합니다.

3) 전역 설정을 추가할 때 문서화하기

최소한 다음을 갱신합니다.

  • conf/*.config.js 주석
  • 이 디렉터리 문서 또는 PR 설명의 사용 방법