package.json 파일

package.json이란?

package.json은 프로젝트 관리 파일이다. 프로젝트의 이름, 버전, 작성자, 운영 플랫폼, 버전 공개/비공개, 의존성 모듈을 확인하고 설정할 수 있다.

생성하기

npm init -y

npm init 명령어로 package.json을 생성할 수 있다.

{
  "name": "more_magazine_style",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/hanna244"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/hanna244"
  },
  "homepage": "https://github.com/hanna244",
  "private": true
}

private

package.json이 생성 될 때 자동으로 설정되지 않는 항목이다. 그래 명시적으로 루트에 입력해주어야 한다.

true: NPM에 배포 하지 않도록 하거나 개인 저장소가 실수로 배포되는 것을 막을 용도로 사용한다. false: NPM에 배포할 때 사용한다.

모듈 설치하기

npm install 패키지_이름
npm i 패키지_이름

npm install 또는 npm i 명령어로 (i는 install의 약자이다.) 패키지를 설치할 수 있다. 설치 후 package.json파일에 "dependencies" 항목에 추가된다.

설치 옵션 명령어

패키지를 설치 할 때 여러 옵션을 설치 할 수 있다.

-D, --save-dev

npm i -D 패키지_이름
npm i --save-dev 패키지_이름

-D는 루트 위치에 있는 "devDependencies" 에 설치된다. 이는 지금 설치한 해당 프로젝트에서 개발을 할 때 사용한다는 말이다.

"devDependencies": {
    "@euid/scss-mixins": "^0.1.1",
    "sass": "^1.30.0"
  }

참고

• package.json 공식 문서

• package.json 공식 문서 (한글 번역)

• npm install 공식 문서