작업 공간
pnpm은 기본적으로 ('multi-package repositories', 'multi-project repositories', 'monolithic repositories'로도 알려진) 모노레포를 지원합니다. 하나의 레포지토리에 다수의 프로젝트가 존재하는 워크스페이스를 생성할 수 있습니다.
Workspace는 루트 디렉토리에 반드시 pnpm-workspace.yaml 파일이 있어야 합니다.
팁
모노레포 관리에 대해 알아보고 있다면, Bit도 함께 살펴보는 것이 좋습니다. 내부적으로 pnpm을 사용하는 Bit은 기존에 pnpm/npm/Yarn으로 관리되는 workspace에서 수동으로 이루어지는 많은 일을 자동으로 처리합니다. bit install에 대해 Painless Monorepo Dependency Management with Bit를 참고하실 수 있습니다.
Workspace 프로토콜 (workspace:)#
linkWorkspacePackages가 true로 설정되어 있으면, 사용 가능한 패키지가 선언된 범위와 일치하는 경우 pnpm은 워크스페이스의 패키지를 링크합니다. 예를 들어, bar가 "foo": "^1.0.0"를 의존성으로 가지고 workspace에 foo@1.0.0가 존재하면 bar는 foo@1.0.0을 참조합니다 그러나 bar가 "foo": "2.0.0"를 의존성으로 포함하면서 workspace에 foo@2.0.0가 없다면 레지스트리에서 foo@2.0.0가 설치될 것입니다. 이 동작은 다소 불확실합니다.
다행히도 pnpm은 workspace: 프로토콜을 지원합니다. 이 프로토콜을 사용한다면, pnpm은 로컬 workspace 바깥의 패키지에서는 작업을 수행하지 않습니다. 만약 "foo": "workspace:2.0.0"로 설정되어 있다면 workspace에 "foo@2.0.0" 가 없기 때문에 설치에 실패할 것입니다.
이 프로토콜은 linkWorkspacePackages 옵션이 false로 설정된 경우에 특히 유용합니다. 이 경우, workspace: 프로토콜을 사용한다면 pnpm은 workspace에 있는 패키지만을 가져올 것입니다.
별칭으로 workspace 패키지를 참조하기#
foo workspace를 포함한 패키지가 있다고 예를 들어봅시다. 보통 "foo": "workspace:*"로 참조하게 됩니다.
별칭을 사용하는 경우, "bar": "workspace:foo@*" 또한 동작합니다.
이 별칭들은 게시되기 전에 별칭이 가리키는 의존성으로 변환됩니다. 위 예시는 "bar": "npm:foo@1.0.0"로 변환됩니다.
상대 경로로 workspace 패키지를 참조하기#
2개의 패키지가 포함된 workspace에서
+ packages
+ foo
+ bar
bar 는 foo를 "foo": "workspace:../foo"로 선언하여 의존성으로 포함합니다. 패키지를 게시하기 전에 이 설명들은 모든 패키지 관리자가 지원하는 일반 버전 설명으로 변환됩니다.
Workspace 패키지를 게시하기#
Workspace 패키지가 (pnpm pack 혹은 pnpm publish에 의해) 아카이브에 패키징된 경우, workspace: 의존성을 아래 다음과 같이 동적으로 바꿉니다.
- 대상 워크스페이스의 해당 버전 (
workspace:,workspace:*,workspace:~또는workspace:^를 사용하는 경우) - 연관된 시맨틱 범위 (기타 범위 유형의 경우)
버전 범위가 없는 단순한 workspace:는 workspace:*로 취급됩니다.
예를 들어 workspace 내부에 foo, bar, qar, zoo가 있고, 이들 모두 버전이 1.5.0이라면 다음과 같습니다.
{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:~",
"qar": "workspace:^",
"zoo": "workspace:^1.5.0"
}
}
이 설명은 다음으로 변환됩니다.
{
"dependencies": {
"foo": "1.5.0",
"bar": "~1.5.0",
"qar": "^1.5.0",
"zoo": "^1.5.0"
}
}
이 기능을 사용하면 로컬 workspace 패키지에 의존할 수 있으면서 동시에 원격 레지스트리에 결과 패키지를 중간 단계없이 게시할 수 있습니다. 패키지 사용자는 다른 패키지처럼 게시된 workspace를 사용할 수 있으며 여전히 시맨틱 제공을 보장받습니다.
릴리즈 워크플로#
Workspace 내부에서 패키지 버전을 관리하는 것은 복잡한 작업이며 pnpm은 현재 내장된 솔루션을 제공하지 않습니다. 하지만 버전 관리를 해결하고 pnpm을 지원하는 2가지 잘 테스트된 도구가 있습니다.
Rush로 저장소를 설정하는 방법은 여기에서 확인할 수 있습니다.
Changesets를 pnpm과 함께 사용하는 방법은 이 가이드에서 확인할 수 있습니다.
트러블슈팅#
pnpm은 workspace 의존성에 순환이 있는 경우 스크립트가 토폴로지 순서대로 실행됨을 보장할 수 없습니다. Pnpm이 설치 도중 순환 의존성을 감지하면 경고를 생성합니다. Pnpm이 어떤 의존성이 순환을 야기하는지 찾을 수 있으면 해당 의존성 또한 경고에 보여줍니다.
There are cyclic workspace dependencies라는 메시지가 표시되면 dependencies, optionalDependencies 및 devDependencies에 선언된 workspace 의존성을 검사하십시오.
사용 예#
다음은 pnpm의 workspace 기능을 사용하는 가장 인기 있는 오픈 소스 프로젝트 중 일부입니다.
환경설정#
linkWorkspacePackages#
- 기본값: false
- 유형: true, false, deep
이 설정을 활성화하면 로컬에서 사용 가능한 패키지가 레지스트리에서 다운로드되는 대신 node_modules에 링크됩니다. 이는 모노레포에서 매우 편리합니다. 로컬 패키지를 하위 종속성에도 링크해야 하는 경우 deep 설정을 사용할 수 있습니다.
그렇지 않으면 패키지는 레지스트리에서 다운로드되어 설치됩니다. 하지만 워크스페이스 패키지는 여전히 workspace: 범위 프로토콜을 사용하여 링크할 수 있습니다.
패키지는 버전이 종속성 범위를 충족하는 경우에만 링크됩니다.
injectWorkspacePackages#
- 기본값: false
- 유형: Boolean
로컬 워크스페이스의 모든 종속성을 심볼릭 링크 대신 하드 링크로 연결합니다. 또는 특정 종속성에 대해서만 선택적으로 하드 링크를 활성화할 수 있는 dependenciesMeta[].injected를 사용하여 이를 구현할 수도 있습니다.
참고
이 설정을 활성화하더라도, 피어 종속성 불일치로 인해 여러 종속성 그래프가 필요한 경우가 아니라면 pnpm은 심볼릭 링크를 사용하여 주입된 종속성의 중복을 제거하는 것을 우선합니다. 이 동작은 dedupeInjectedDeps 설정으로 제어됩니다.
dedupeInjectedDeps#
- 기본값: true
- 유형: Boolean
이 설정을 활성화하면 주입된 종속성은 가능한 경우 워크스페이스에서 심볼릭 링크됩니다. 종속 프로젝트와 주입된 종속성이 동일한 피어 종속성을 참조하는 경우, 주입된 종속성을 종속 프로젝트의 node_modules에 물리적으로 복사할 필요가 없으며 심볼릭 링크로 충분합니다.
syncInjectedDepsAfterScripts#
버전 10.5.0에서 추가됨
- 기본값: undefined
- 유형: String[]
주입된 워크스페이스 종속성은 하드 링크의 모음이므로, 소스가 변경되어도 파일이 추가되거나 제거되지 않습니다. 이로 인해 빌드가 필요한 패키지(예: TypeScript 프로젝트)에서 문제가 발생합니다.
이 설정은 스크립트 이름의 목록입니다. 워크스페이스 패키지에서 이 스크립트 중 하나가 실행되면 node_modules 내부의 주입된 종속성도 동기화됩니다.
preferWorkspacePackages#
- 기본값: false
- 유형: Boolean
이 설정을 활성화하면 레지스트리에 더 새로운 버전의 패키지가 있더라도 레지스트리의 패키지보다 워크스페이스의 로컬 패키지가 우선됩니다.
이 설정은 워크스페이스가 saveWorkspaceProtocol을 사용하지 않는 경우에만 유용합니다.
sharedWorkspaceLockfile#
- 기본값: true
- 유형: Boolean
이 설정을 활성화하면 pnpm은 워크스페이스 루트에 단일 pnpm-lock.yaml 파일을 생성합니다. 이는 또한 워크스페이스 패키지의 모든 종속성이 단일 node_modules에 위치하게 됨을 의미합니다(그리고 Node의 모듈 해석을 위해 각 패키지의 node_modules 폴더에 심볼릭 링크됩니다).
이 옵션의 장점:
- 모든 종속성이 싱글톤입니다
- 모노레포에서 더 빠른 설치
- 모든 변경이 하나의 파일에 있으므로 코드 리뷰에서 변경 사항이 더 적음
참고
모든 종속성이 루트 node_modules에 하드 링크되더라도, 패키지는 자신의 package.json에 선언된 종속성에만 접근할 수 있으므로 pnpm의 엄격성이 유지됩니다. 이는 앞서 언급한 심볼릭 링크의 결과입니다.
saveWorkspaceProtocol#
- 기본값: rolling
- 유형: true, false, rolling
이 설정은 워크스페이스에서 링크된 종속성이 package.json에 추가되는 방식을 제어합니다.
foo@1.0.0이 워크스페이스에 있고 워크스페이스의 다른 프로젝트에서 pnpm add foo를 실행하면, foo는 다음과 같이 dependencies 필드에 추가됩니다. savePrefix 설정도 spec이 생성되는 방식에 영향을 줍니다.
| saveWorkspaceProtocol | savePrefix | spec |
|---|---|---|
| false | '' | 1.0.0 |
| false | '~' | ~1.0.0 |
| false | '^' | ^1.0.0 |
| true | '' | workspace:1.0.0 |
| true | '~' | workspace:~1.0.0 |
| true | '^' | workspace:^1.0.0 |
| rolling | '' | 작업 공간:* |
| rolling | '~' | workspace:~ |
| rolling | '^' | workspace:^ |
includeWorkspaceRoot#
- 기본값: false
- 유형: Boolean
워크스페이스에서 명령을 재귀적으로 실행할 때 루트 워크스페이스 프로젝트에서도 실행합니다.
ignoreWorkspaceCycles#
- 기본값: false
- 유형: Boolean
true로 설정하면 워크스페이스 순환 경고가 출력되지 않습니다.
disallowWorkspaceCycles#
- 기본값: false
- 유형: Boolean
true로 설정하면 워크스페이스에 순환이 있는 경우 설치가 실패합니다.
failIfNoMatch#
- 기본값: false
- 유형: Boolean
true로 설정하면 제공된 필터와 일치하는 패키지가 없을 때 CLI가 영이 아닌 코드로 종료됩니다.
예를 들어, 다음 명령은 bad-pkg-name이 워크스페이스에 없으므로 영이 아닌 코드로 종료됩니다:
pnpm --filter=bad-pkg-name test