[Node.js] package.json

package.json

package.json은 프로젝트에 대한 중요한 정보들을 담고 있는 파일이다. package.json 파일을 생성하는 방법은 3가지가 있다.

 

• 직접 package.json 파일을 생성하고 그 안에 들어가는 정보들을 입력하는 방법
• npm init 명령으로 생성 - 필요한 정보들을 하나씩 입력해서 package.json을 생성한다.
• npm init -y 명령으로 생성 - package.json이 default 값으로 바로 생성된다.

name

프로젝트의 이름으로 npm에 배포할 때는 동일한 이름이 있으면 안된다.

version

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

description

프로젝트에 대한 설명을 적는다.

keywords

프로젝트를 검색할 때 사용되는 키워드이다.

hompage

프로젝트의 홈페이지 주소를 적는다.

author

프로젝트를 만든 사람으로 한 명만 적는다.

contributors

프로젝트에 참여한 사람들을 적는다.

repository

프로젝트의 소스 코드 저장소의 주소를 적는다.

scripts

프로젝트를 만들면서 사용하는 다양한 명령어들을 npm 명령어를 이용해서 실행하게 한다.

"scripts" : {
    "start": "node app.js"
}

// 실행할 때 node app.js 대신에 npm start로 실행할 수 있다

start / test 외 다른 명령어들은 npm run <명령어>와 같이 사용해야 한다.

config

코드에서 config에 있는 값들을 변수처럼 사용할 수 있다.

private

만약 true로 하면 npm에 저장하지 않는다.

dependencies

프로젝트를 사용하려면 어떤 모듈들이 필요한지를 보여준다. npm install을 하면 dependencies에 있는 모든 모듈들이 node_modules라는 폴더에 설치된다. 여기에 설치되는 모듈들은 굉장히 많을 수도 있기 때문에 github나 다른 저장소에 저장할 때에는 node_modules 폴더를 제외하고 pacakge.json 올린다.

devDependencies

개발할 때만 필요한 모듈들을 보여준다.

engine

실행 가능한 node 버전을 알려준다.