package.json이란?
프로젝트에 대한 메타데이터를 기록한 파일로 모든 npm패키지와 node.js프로젝트에 포함되어 있습니다. 조금 더 간단히 말하자면 어떤 npm패키지와 상호작용을 하는지, 어떤 패키지를 내려받는지 등의 정보가 저장되어있는 문서입니다. 프로젝트를 생성하는 단계에서 npm init을 하게 되면 루트 경로에 package.json 파일이 생성됩니다.
사용
프로젝트를 하나 생성해서 확인해 보겠습니다.
npm init명령을 실행하면 package name, version, description 등 여러가지 정보를 물어보는데 테스트 과정이니 쭉쭉 넘어가다 보면 마지막에 Is this OK? (yes)라고 물어보는데 여기까지 엔터를 입력하여 확인하면 완료됩니다.
package.json파일이 잘 생성된 것을 확인할 수 있습니다.🙂
이 상태에서 다른 패키지를 한 번 설치해 볼까요? lodash를 한 번 설치해보겠습니다.
npm install lodash명령을 입력 후 실행하면 새로운 패키지가 설치되었다는 메세지를 확인할 수 있습니다. 또 package.json 파일을 확인하면 license밑에 dependencies: lodash를 확인할 수 있는데요. 이는 방금 설치한 lodash패키지에 의해 추가된 항목이고 lodash패키지에 의존성을 두고 있다는 뜻입니다. node_modules란 폴더엔 방금 설치한 lodash패키지 항목들이 있는 걸 확인할 수 있습니다. 또 다른 항목이 남아있는데 바로 package-lock.json파일입니다.
이 파일엔 프로젝트에 사용하기 위해 설치한 패키지(방금 설치한 lodash + 앞으로 설치할 수도 있는 여타 다른 패키지)들의 연관성을 나타내고 있습니다.
정리해보자면 package.json파일엔 프로젝트에 직접적으로 연관있는 패키지들의 데이터, package-lock.json엔 그 패키지들의 관계정보 데이터라고 할 수 있겠습니다.
결론
여기까지 package.json에 대해 간략하게 알아보았는데요. 프로젝트에 대한 전반적인 메타데이터들이 저장되는 문서이기 때문에 관리에 유의해야겠습니다.
