[240924 TIL] yarn berry 관련(gpt질의)

Q1 yarn berry 적용법

yarn berry 도입에 대한 질문이 있습니다.
점차 개발 폴더들이 많아 지면서 용량을 많이 차지하기 시작했습니다.
여기서 가장 크게 용량을 반복적으로 차지하는 것은 node_modules 입니다.
그래서 yarn berry 를 도입하려고 합니다.
방법을 순차적으로 알려주세요.

A1

Yarn Berry(또는 Yarn 2)는 node_modules 폴더를 제거하고 패키지 종속성을 효율적으로 관리하는 데 도움을 줍니다. 이는 프로젝트의 용량을 줄이고 성능을 개선하는 데 유리합니다. Yarn Berry를 도입하는 방법을 순차적으로 설명하겠습니다.

1. Yarn 설치 확인

먼저, Yarn이 시스템에 설치되어 있는지 확인합니다. 터미널에서 다음 명령어를 실행해보세요:

yarn --version

Yarn이 설치되어 있지 않다면, 다음 명령어를 통해 Yarn을 설치할 수 있습니다:

npm install -g yarn

2. 프로젝트에 Yarn Berry(또는 Yarn 2) 설정

프로젝트에서 Yarn Berry로 마이그레이션하려면 프로젝트 루트에서 다음 명령어를 실행하세요:

yarn set version berry

이 명령어를 실행하면 .yarn/releases 폴더에 yarn-X.Y.Z.cjs 파일이 생성되며, Yarn 버전이 Berry로 설정됩니다.

3. .yarnrc.yml 파일 생성

프로젝트 루트에 .yarnrc.yml 파일이 생성됩니다. 이 파일에서 Yarn 설정을 관리할 수 있습니다. 기본적으로 아래와 같은 설정이 포함될 수 있습니다:

nodeLinker: 'pnp'

이 설정은 Yarn Berry가 node_modules 폴더 대신 Plug'n'Play(PnP) 모드를 사용하도록 지정합니다.

4. PnP 사용 설정

PnP는 node_modules 폴더를 생성하지 않고, 필요한 모듈을 바로 참조하는 방식입니다. 이미 설정된 것처럼 .yarnrc.yml에 nodeLinker: 'pnp' 설정이 되어 있다면 추가 설정은 필요하지 않습니다.

5. .gitignore 설정

.yarn/ 폴더와 .pnp.cjs 파일을 Git에 커밋해야 합니다. .gitignore 파일에 다음 내용을 추가해 주세요:

.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions
.pnp.cjs

6. 의존성 설치

이제 프로젝트의 의존성을 설치하세요. 기존 node_modules를 삭제한 후, 다음 명령어를 실행합니다:

yarn install

이 명령어는 의존성을 설치하고 PnP 캐시를 생성합니다.

7. 에디터 설정

PnP 모드에서는 IDE 또는 텍스트 에디터가 설정되어 있어야 합니다. VSCode를 사용 중이라면 Yarn PnP 플러그인을 설치하고, .vscode/settings.json에 다음을 추가하세요:

{
  "typescript.tsdk": ".yarn/sdks/typescript/lib"
}

8. PnP 환경에서의 명령어 사용

기존 명령어는 그대로 사용할 수 있으며, yarn add <패키지명> 명령어로 패키지를 추가하고, yarn remove <패키지명> 명령어로 패키지를 제거할 수 있습니다.

9. 기존 프로젝트 마이그레이션 (선택 사항)

기존 프로젝트에서 node_modules가 필요하다면, nodeLinker 옵션을 node-modules로 변경할 수 있습니다:

nodeLinker: 'node-modules'

이후 yarn install을 실행하면 기존 방식대로 node_modules 폴더가 생성됩니다.

10. 추가 설정 및 최적화 (선택 사항)

추가적으로 .yarnrc.yml 파일에서 필요한 플러그인 설치, 캐시 최적화 등의 설정을 추가할 수 있습니다. 예를 들어:

plugins:
  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
    spec: "@yarnpkg/plugin-interactive-tools"

위의 과정을 통해 Yarn Berry를 프로젝트에 성공적으로 도입할 수 있습니다. Yarn Berry를 사용하면 패키지 관리가 더 효율적으로 이루어지며, node_modules 폴더로 인한 용량 부담이 크게 줄어들 것입니다.

 

Q2 corepack 설정 관련

yarn set version berry 에서 다음 오류가 발생합니다.
YN0000: You don't seem to have Corepack enabled; we'll have to rely on yarnPath instead

A2

이 오류는 Corepack이 활성화되지 않은 상태에서 Yarn Berry를 설치하려고 할 때 발생하는 경고 메시지입니다. Corepack은 Yarn과 같은 패키지 관리 도구를 쉽게 사용할 수 있도록 도와주는 유틸리티입니다. 이 오류는 크게 문제되지 않으며, yarnPath를 통해 Yarn을 사용할 수 있도록 설정하겠다는 뜻입니다. 다음 단계를 따라 문제를 해결할 수 있습니다.

1. Corepack 활성화

Corepack을 활성화하려면 다음 명령어를 터미널에 입력하세요:

corepack enable

이 명령어를 실행하면 Corepack이 활성화되고, 이후 Yarn 명령어들이 올바르게 작동할 것입니다.

2. Yarn Berry 설치 다시 시도

이제 다시 Yarn Berry를 설치해 보세요:

yarn set version berry

3. Corepack이 없는 경우

만약 corepack enable 명령어가 작동하지 않는다면, Node.js 버전을 확인하세요. Corepack은 Node.js 16.10.0 이후 버전에 포함되어 있습니다. 만약 더 낮은 버전을 사용 중이라면 Node.js를 업데이트하세요.

4. .yarn/releases 폴더 확인

yarn set version berry 명령어를 실행한 후 .yarn/releases/ 폴더에 yarn-X.X.X.cjs 파일이 생성됩니다. 이 파일이 생성되었다면 Yarn Berry 설치는 완료된 것입니다. 경고 메시지에도 불구하고 프로젝트에서 Yarn Berry를 사용할 수 있습니다.

5. .yarnrc.yml 파일 수정

.yarnrc.yml 파일이 생성되었는지 확인하세요. 파일이 없다면 다음 내용을 직접 추가하세요:

yarnPath: .yarn/releases/yarn-X.X.X.cjs

이 설정은 Yarn 명령어를 실행할 때 이 파일을 사용하도록 지정합니다.

6. 의존성 설치 및 테스트

이제 프로젝트에서 Yarn을 사용하여 의존성을 설치하고 정상적으로 작동하는지 확인하세요:

yarn install

이 과정에서 추가적인 경고나 오류가 발생하지 않는다면 Yarn Berry 설치가 성공적으로 완료된 것입니다.

이 단계를 완료한 후에도 문제가 지속된다면 Node.js 버전이나 Yarn 설정을 다시 확인해보시길 권장합니다.