package.json
: 프로젝트 전체 설명서
yarn init(npm init)
package.json 생성
구성요소
package.json 구성요소에 대해서는 npm Docs를 들어가면 잘 설명되어있다.
👉 name
출처: npm Docs
Docs를 보면 package.json에서 가장 중요한 것은 name 과 version 이고, 이게 없으면 패키지는 설치될 수 없다. 만약 패키지를 설치하고 싶지 않다면, 그 때는 선택 사항이 될 수 있다!
그리고 name을 쓰는 규칙이 있다.
- 이름은 214자 이하여야 한다.
- .(점)이나 _(언더스코어)로 시작할 수 있다.
- 새 패키지는 이름에 대문자가 들어갈 수 없다.
- URL-safe 하지 않은 name은 거부된다.
👉 version
semantic versioning guidelines를 따르며, x.x.x의 형태로 작성해야한다.
ex)[Major].[Minor].[Patch]의 형태👉 description
문자열로 기술한 패키지에 대한 설명. npm에서 검색되었을 때 리스트에 표시되어 사람들이 패키지를 찾아내고 이해할 수 있는데 도움을 준다.
👉 author
재작자의 이름을 지정
👉 private
package.json에서 'private': true를 설정하면 npm이 게시를 거부한다.
이는 개인 저장소에 실수로 게시되는 것을 방지하게 위해 npm에서 패키지의 공개 여부를 지정해주는 것이다!👉 license
패키지에 대한 라이센스를 지정해서 사람들이 패키지를 사용할 수 있는 방법과 패키지에 대한 제한 사항을 알 수 있도록 한다.
비공개로 사용하거나, 어떤 조건에서도 패키지를 퍼블리싱하지 않을 경우에는 'UNLICENSED'로 표기해준다.
👉 main
패키지의 진입점(entry point)이 되는 모듈의 ID이다.
예를 들어, 사용자가 foo라는 이름의 패키지를 설치하고, require("foo")를 통해 모듈을 import하면, "main"으로 지정한 모듈의 exports 객체가 반환된다.
패키지 root의 상대경로로 지정해야 한다. 지정하지 않은 경우, root 폴더의 index.js로 기본값이 설정된다.👉 scripts
패키지의 수명 주기에서 다양한 타이밍에 실행되는 스크립트 명령을 포함하는 사전이다. 키는 수명 주기 이벤트이고 값은 해당 시점에서 실행할 명령이다.
👉 dependencies
설치목록.
실제 배포할 때 사용되는 것들을 설치한다.
설치 명령어 : yarn add 패키지네임👉 devDependencies
개발전용 설치목록.
개발 연습을 할 때 사용되는 것들을 설치한다.
하지만, 배포할때는 포함되지 않는다.)
설치명령어 : yarn add 패키지네임 --dev
