TIL 19 | package.json

특정 프로젝트와 연결되어 있는 의존성을 관리

package.json

정의

• package.json 파일은 배포한 모듈 정보를 담고자 만들어졌는데 간단하게 말하면 현재 프로젝트에 대한 정보를 저장하고 있는 것이다.

만드는 법

• 직접 만들어서 작성할 수도 있지만 새로운 프로젝트를 진행하면서 npm init을 할 때 자동으로 생성되는 파일이기 때문에 따로 만들 필요는 없다.

필요한 이유

• 확장 모듈 형태로 배포하기 위한 것 뿐만 아니라 어플을 개발할 때 package.json 파일을 이용하면 사용하고 있는 확장 모듈에 대한 의존성 관리를 편하게 할 수 있다.

내용과 설명

name

• 프로젝트의 이름으로 배포할 때 version과 함께 필수적으로 작성하는 항목이다. 대문자를 포함하면 안되고, require() 함수의 인수로 사용되기 때문에 짧고 알기 쉽게 만드는 것이 좋다.

version

• 프로젝트의 version을 정의한다.

description

• 프로젝트에 대한 설명을 나타내는 것이다. 이는 문자열로 기술하고, 프로젝트를 빨리 이해할 수 있도록 돕는다.

keywords

• 프로젝트를 검색할 때 참조되는 키워드이고, 큰따옴표로 구성된 배열 구조로 구성되어 있다.

scripts

• 프로젝트에서 자주 실행되는 명령어를 scripts로 작성 해놓으면 npm명령어를 통해 사용가능하다.

dependencies

• 프로젝트의 의존성 관리를 위한 부분으로 현재 진행되고 있는 프로젝트에서 필요한 확장 모듈을 정리해서 기술해 놓은 것이다. 설치 시 이 기술한 내용을 토대로 확장 모듈을 자동으로 설치한다. 그리고 npm install은 기술해 놓은 확장 모듈을 포함한 모든 확장 모듈을 설치한다.

devDependencies

• 개발할 때만 사용되는 확장 모듈들을 관리하고 실제 배포 시 필요없는 테스트 도구 등을 넣어둔다.

---

package.json에 대해 궁금증이 생긴 이유는 node를 사용해서 프로젝트를 만들 때 만들어 지는 파일인데 여기에 기술되어 있는 것들이 무엇을 나타내는지 궁금했고, 이러한 정보들을 어떻게 사용되는지 모르고 사용하면 안되겠다는 생각이 있었기 때문이다. 내용들을 공부하면서 여기에 기술하는 내용들이 간단하게 정리를 해둔 것이지만 이것이 프로젝트를 구성하고 활용하는데 있어서 편리함과 효율성을 올릴 수 있다고 생각한다.