TIL - legacy-peer-deps

What I Learned

서론

• 개발을 하다보면 누구나 한 번쯤 이런 문구를 본 적 있을 것이다.

  npm ERR! Fix the upstream dependency conflict, or retry npm ERR! this command with --force, or --legacy-peer-deps

• 간단히 해석해 보면 의존성 충돌 문제가 발생했고, --force를 사용하거나 --legacy-peer-deps를 사용하라는 것으로 보인다. 둘 사이에는 어떤 차이가 있고, 왜 사용하는 것일까?

본론

You have the option to retry with --force to bypass the conflict or --legacy-peer-deps command to ignore peer dependencies entirely (this behavior is similar to versions 4-6). - in npm github blog

해석하자면 다음과 같다.

--force로 재시도하여 충돌을 우회하거나 --legacy-peer-deps 명령으로 종속성을 완전히 무시할 수 있습니다. (이 동작은 버전 4-6과 유사합니다.)

--legacy-peer-deps 관련 에러는 npm 7버전 이후로 나온 에러로, 기존에는 --legacy-peer-deps로 설치하는 것처럼 처리된 모양이다. 물론 경고는 표시되었지만, 오류 없이 설치했었다.

7버전 이후로는 에러처리되며, 두 선택지 중 하나를 선택할 수 있고, 그것이 --force와 --legacy-peer-deps이다.

--force

--force를 통해 설치를 하면, 모든 충돌을 무시하고 최신 버전을 설치한다. 즉, peer dependencies 충돌을 무시하고 강제로 패키지를 설치한다. 때문에 의존성 버전 호환이 되지 않는 경우가 생길 수 있다.

--legacy-peer-deps

기존 방식대로 경고만 출력하고, 7이상 버전에 도입된 peer dependencies 검증을 비활성화 한다. 즉, 4-6 버전 처럼 peer dependencies 충돌만을 무시하고 설치한다. --force는 모든 충돌을 무시하지만 본 커맨드는 어디까지나 peer dependencies 충돌을 무시한다.

결론

만일 해당 에러 문구가 출력 된다면, 본인 상황에 맞게 커맨드를 입력해야 할 것이다.