package.json은 프로젝트에 대한 설정파일이다.
npm을 통해 설치된 패키지 목록을 관리하고 프로젝트의 정보 및 기타 실행 스크립트를 작성하는 파일
npm install을 통해 설치한 package에 대한 정보를 저장하는 용도
package.json
-> 개발자가 배포한 패키지에 대해, 다른 사람들이 관리하고 설치하는 것을 편히하기 위한 문서
-> npm에 패키지를 배포하고 npm registry에 올리기 위해 반드시 필요한 문서파일
자신의 프로젝트가 의존하는 패키지의 리스트
자신의 프로젝트의 버전을 명시
다른 환경에서도 빌드를 재생 가능하게 만들어 다른 개발자가 쉽게 사용할 수 있도록 함
package.json 구성
// "name": "패키지의 이름", 이름에는 규칙 존재(only 소문자, 한 단어, (-,_) 사용가능)
// "version": "x.x.x"의 형태로 작성
// 패키지의 생명주기에서 다양한 타이밍에 자주 사용할 Commandfmf alias(별칭)을 통해 지정해 둘 수 있는 dictionary
"scripts": {
}
// 패키지 리스트
"dependencies": {
}
// 운영이 아닌 개발 시에만 필요한 패키지 리스트
"devDependencies": {
}
dependencies와 devDependencies의 작성 방법
기본적인 작성 방법은 똑같다
$ npm install <package>
dependencies 필드에 자동으로 install한 패키지명과 버전이 기록됌
$ npm install --save-dev <package>
devDependencies는 개발 시에만 필요한 의존 패키지
배포시에는 필요 없는 패키지를 포함
참고자료
https://hoya-kim.github.io/2021/09/14/package-json/
npm 공식 홈페이지
https://docs.npmjs.com/cli/v7/configuring-npm/package-json