Yarn Berry 사용 시 PnP 모드에서도 node_modules 폴더가 생기는 이유는?

yarn

 

일단 Yarn Berry라는게 뭘까요?!

Yarn Berry란 2020년 1월에 출시된 Yarn Classic 의 업그레이드 버전입니다.

새롭게 뒤바뀐 패키지 매니저라는 것을 분명하게 하기 위해 yarn 팀에서는 Yarn Berry 라고 이름을 붙였습니다.

 

이런 Yarn Berry는 PnP(Plug'n'Play) 모드를 통해 node_modules 폴더 없이도 패키지 관리가 가능합니다.

분명 그렇게 알고 있었습니다!!

 

그런데, PnP 모드를 사용하고 있음에도 불구하고 yarn start를 실행하면 node_modules 폴더가 생기는 경우가 종종 발생합니다.

반년 정도 전에 생성한 알리니 프로젝트에서도 계속해서 node_modules가 생성됐습니다.

그렇다면, 왜 이런 일이 일어나는 걸까요?

 

1. PnP 모드의 기본 개념

PnP 모드는 Yarn Berry의 주요 기능 중 하나로, 전통적인 node_modules 폴더를 생성하지 않고도 패키지를 사용할 수 있게 해줍니다.

이 모드에서는 의존성 파일들이 .pnp.cjs라는 파일 하나에 모두 저장되고, 이 파일을 통해 필요한 패키지들을 직접 불러옵니다.

이론적으로는 node_modules 폴더가 전혀 필요하지 않게 됩니다.

 

 

2. 왜 node_modules가 다시 생성될까?

a. 특정 패키지의 호환성 문제

스터디원과 학습해 본 결과 일부 패키지들은 PnP 모드에서 정상적으로 동작하지 않을 수 있습니다.

해당 패키지가 여전히 node_modules 폴더에 의존하고 있거나, 특정 파일들을 직접 접근해야 하는 경우가 있기 때문입니다.

예를 들어, 패키지에서 fs 모듈을 사용하여 다른 의존성의 파일을 직접 읽으려 할 때, node_modules 경로를 하드코딩한 경우 문제가 발생할 수 있습니다.

이런 상황에서 Yarn은 패키지 호환성을 유지하기 위해 자동으로 node_modules 폴더를 생성하게 됩니다.

 

위처럼 임시로 결론짓게 되었지만 교차 검증이 필요할 것 같습니다. 잘못된 내용이 있다면 언제라도 댓글 남겨주세요.

b. Webpack이나 Vite 같은 번들러의 캐시 처리

Webpack이나 Vite 같은 번들러를 사용할 때도 node_modules 폴더가 생성될 수 있습니다.

번들러는 종종 의존성 파일들을 미리 트랜스파일링하여 캐싱하는데, 이 캐시 파일들이 기본적으로 node_modules/.cache 폴더에 저장됩니다. 이 과정에서 의도치 않게 node_modules 폴더가 생성될 수 있습니다.

c. 특정 의존성 버전 문제

esbuild 같은 특정 패키지의 버전이 PnP 모드에서 완벽히 호환되지 않을 수 있습니다. 이 경우, 의존성 트리에서 특정 패키지가 하위 호환성을 가지지 못해 node_modules 폴더가 생성되는 경우가 있습니다. 예를 들어, esbuild 버전이 0.15.15보다 낮다면 문제가 발생할 수 있으며, 이 경우 버전을 업그레이드함으로써 해결할 수 있습니다.

 

 

3. 해결 방법

이 문제를 해결하기 위해서는 몇 가지 방법을 고려해볼 수 있습니다:

• 패키지 버전 업그레이드: esbuild나 다른 문제를 일으킬 수 있는 패키지들의 버전을 최신으로 유지하는 겁니다. yarn.lock 파일을 수동으로 수정하여 원하는 버전을 명시할 수도 있습니다.
• 번들러 설정 조정: Webpack이나 Vite의 설정에서 캐시 파일 경로를 다른 곳으로 지정할 수 있습니다. 예를 들어, cacheDir 옵션을 사용하여 .cache 폴더의 위치를 변경할 수 있습니다.
• Yarn 설정 조정: 패키지의 특정 설정, 예를 들어 preferUnplugged 설정을 통해 node_modules가 생성되지 않도록 유도할 수 있습니다.

 

결론

특정 상황에서 node_modules 폴더가 생성되는 것은 이런 호환성 문제 때문이며, 이를 해결하기 위해서는 의존성 버전을 업그레이드하거나, 번들러의 설정을 조정하는 등의 조치가 필요한 걸로 생각됩니다!

Yarn이 앞으로 더 발전하면서 이러한 문제들이 점점 해결될 것으로 생각되나, 그때까지는 이러한 문제를 인지하고 적절히 대응하는 것이 중요할 것 같네요.

 

 

📃 참고 문헌

yarn 룰북

GitHub - esbuild가 Yarn PnP 리포지토리에 node_modules/.cache 디렉터리를 생성