보통 현대 개발 프레임워크들은 init 시 최상단 루트에 하나의 package.json을 가지고 있다.

이렇듯 나에겐 '항상 최상단에 pacakge.json 하나'가 관습화되어있었는데, 최근 모노레포 프로젝트를 진행하면서 한 워크스페이스에 여러개의 패키지(각기 package.json을 가지고 있음)가 있는 구조를 체험하고 npm pacakge에 대해 더 알아봐야겠다고 생각하게 되었다.

모노레포에서 복수의 package.json이 있는 형태:

workspace/
├── package.json (루트)
├── packages/
│ ├── frontend/
│ │ └── package.json (독립적인 패키지)
│ └── backend/
│ └── package.json (독립적인 패키지)

위 예시에서의 패키지 관계 정리

frontend와 backend는 서로 같은 패키지가 아니다. 둘은 독립적인 별개의 패키지이다.

그러나 frontend와 backend는 workspace 패키지에 "포함된" 패키지라고 하면 맞다.

하지만 엄밀히 말하면 "workspace 패키지다"라고 표현하기보다는 "workspace의 멤버 패키지다" 또는 **"workspace에 속한 패키지다"**라고 표현하는 게 더 정확하다.

루트 workspace 패키지: 전체 프로젝트를 관리하는 상위 패키지

공통 의존성 관리

전체 스크립트 실행

workspace 설정

frontend 패키지: 독립적인 패키지

자체 의존성

자체 빌드 설정

workspace에 등록되어 있음

backend 패키지: 독립적인 패키지

자체 의존성

자체 빌드 설정

workspace에 등록되어 있음

모노레포에서 패키지 간 참조 가능

재미있는 건, workspace 설정 덕분에 frontend에서 backend를 쉽게 참조할 수 있다는 점이다.

// packages/frontend/package.json
{
"dependencies": {
"@my-workspace/backend": "workspace:*" // 로컬 패키지 참조
}
}

이렇게 보면 workspace는 여러 독립 패키지들을 묶어주는 컨테이너 역할을 한다고 볼 수 있어요!

turborepo의 최상단인 workspace도 하나의 npm 패키지라고 볼 수 있는걸까?

맞다! workspace의 루트도 엄연한 npm 패키지이다. 아래는 turporepo workspace의 package.json 예시이다. 이는 완전한 npm 패키지라고 볼 수 있다. 아래 조건을 충족하면 엄밀하게 패키지라고 부를 수 있는 것이다.

package.json이 있음

의존성 관리 가능

scripts 실행 가능

버전 관리 가능

// workspace/package.json (루트)
{
"name": "my-turborepo",
"version": "0.0.0",
"private": true, // 중요!
"workspaces": [
"apps/*",
"packages/*"
],
"scripts": {
"dev": "turbo run dev",
"build": "turbo run build"
},
"devDependencies": {
"turbo": "latest"
}
}

하지만 워크스페이스 패키지는

1. "private": true - 배포 불가 패키지

{
"private": true // npm publish 차단
}

루트 패키지는 보통 private: true로 설정한다.

npm 레지스트리에 배포되지 않음

순수하게 workspace 관리 목적

"공개용 패키지"가 아닌 "관리용 패키지"

2. 메타 패키지 역할

일반 패키지처럼 코드를 직접 제공하기보다는 아래와 같은 역할을 수행한다.

하위 패키지들을 조율

공통 의존성 관리

전역 스크립트 실행

문득 든 의문: package.json 파일이 생기면 내 PC환경 전역에 있는 글로벌 node.js가 패키지로 인식을 하는걸까?

아니다. package.json이 생긴다고 해서 글로벌 Node.js가 자동으로 인식하는 건 아니다.

package.json이 있어도 그냥 디렉토리에 있는 설정 파일일 뿐. PC 어디서나 자동으로 접근 가능한 게 아니다. pacakage.json 파일이 추가되는지 node.js 프로세스가 항상 감시한다거나 그러지 않는다. (글로벌하게 등록되지 않음)

패키지가 인식되는 시점:

1. 로컬에서 실행할 때

cd my-package
node index.js

현재 디렉토리나 상위 디렉토리의 package.json을 찾아서 적용

2. 다른 프로젝트에서 설치할 때

npm install ../my-package # 로컬 경로로 설치
npm install my-package # npm 레지스트리에서 설치

package.json이 인식되는 스코프

my-computer/
├── projects/
│ ├── project-a/
│ │ └── package.json // project-a에서만 인식
│ └── project-b/
│ └── package.json // project-b에서만 인식
└── random-folder/
└── some-script.js // 위 패키지들 모름

각 package.json은 자기 디렉토리 범위 안에서만 효력이 있다. 정리하면 package.json을 만든다 = 패키지 정의서를 작성한 것, 런타임으로 돌리기 위해 빌드 시에만 인식된다.

지금까지 하나의 앱, 하나의 레포를 사용하던 방식에서 모노레포로 여러 개의 앱을 package 개념으로 묶는 것을 보고 NPM에 대한 탐구를 진행해보았다. 다음에는 npm publish를 하면 npm 레지스트리에 어떻게 적용되고 cdn에 어떻게 캐싱되는지. 전세계 사람들이 어떻게 다운받을 수 있는지 등을 한 번 정리해보겠다.