[git] 협업을 할 때 Package-lock.json 파일을 커밋해야 하는 이유

협업 프로젝트에서 개발자들이 서로 다른 버전의 의존성 패키지 때문에 오류가 발생하곤 한다.

이 문제를 방지하는 방법중 하나는 Package-lock.json 파일을 커밋하는것이다.

 

 

1. Package-lock.json

Package-lock.json 파일은 npm 패키지 매니저에서 사용하는 파일로, 프로젝트에 필요한 모든 의존성 패키지의 정확한 버전과 설치된 경로를 기록한다.

쉽게 말해, 프로젝트를 실행하는 데 필요한 모든 부품 목록과 각 부품의 버전 정보를 담은 파일임.

 

 

2. 협업 프로젝트에서 Package-lock.json을 커밋해야 하는 이유:

• 의존성 문제 방지:
  개발자마다 설치된 의존성 패키지의 버전이 다를 경우 버전 충돌 문제가 발생하여 예상치 못한 오류가 발생할 수 있다. Package-lock.json 파일을 커밋하면 모든 개발자가 동일한 의존성 환경을 사용하도록 하여 이러한 문제를 방지할 수 있음.
• 프로젝트 재현성 보장: 
  다른 개발자가 프로젝트를 복제하거나 새 환경에 설치하려고 할 때 Package-lock.json 파일을 사용하면 정확히 동일한 의존성 패키지 환경을 구축할 수 있는데 이는 프로젝트의 재현성을 높이고 협업 효율성을 증대시킨다.
• 문제 해결 용이: 
  의존성 패키지 관련 문제가 발생했을 때 Package-lock.json 파일을 참고할 수 있음.

 

 

3. 어차피 npm install이 Package-lock.json을 초기화하지 않는가?:

일반적으로 npm install 명령어를 실행하면 기존의 package-lock.json 파일은 초기화된다.

하지만 다음과 같은 특정 상황에서만 해당되는 사항이며, 협업 환경에서는 여전히 package-lock.json 파일을 커밋하는 것이 중요하다.

• package.json 파일에 명시된 의존성 패키지의 최신 버전을 설치할 때
• package-lock.json 파일에 기록된 의존성 패키지 버전이 유효하지 않거나 손상된 경우
• --force 옵션을 사용하여 npm install 명령어를 실행한 경우

 

 

4. Package-lock.json 파일을 활용한 효과적인 의존성 관리:

• 버전 범위 사용: 
  package.json 파일에 의존성 패키지의 버전 범위를 명시하면, npm install 명령어가 해당 범위 내에서 가장 적합한 버전을 자동으로 설치함. 이는 개발 환경과 배포 환경에서 의존성 패키지 버전 차이를 최소화할 수 있다.
• CI/CD 파이프라인 활용: 
  CI/CD 파이프라인을 사용하여 프로젝트가 변경될 때마다 자동으로 npm install 명령어를 실행하고 package-lock.json 파일을 커밋하도록 설정하면, 협업 환경에서 지속적인 의존성 관리를 수행할 수 있다.