(react) package.json

Node.js에서 package.json이란?

 

package.json은 Node.js 프로젝트에서 핵심적인 역할을 하는 파일로 프로젝트에 대한 메타데이터와 프로젝트가 의존하는 패키지들에 대한 정보를 담고 있음. 마치 프로젝트의 신분증과 같은 역할을 수행하며, npm(Node Package Manager)을 통해 패키지를 관리하는 데 필수적임.

 

package.json의 주요 역할

• 프로젝트 정보: 프로젝트의 이름, 버전, 설명, 저자 등 기본적인 정보를 기록
• 의존성 관리: 프로젝트에서 사용하는 외부 패키지(모듈)들의 목록과 버전을 관리
• 스크립트 정의: npm 명령어를 통해 실행할 수 있는 스크립트(예: 시작, 테스트, 빌드 등)를 정의
• 프로젝트 설정: 프로젝트의 다양한 설정 값들을 저장

 

package.json의 주요 속성

• name: 프로젝트의 이름
• version: 프로젝트의 버전
• description: 프로젝트에 대한 간략한 설명
• author: 프로젝트의 저자 정보
• dependencies: 프로젝트 실행에 필요한 의존성 패키지
• scripts: npm 명령어를 통해 실행할 스크립트 정의
• main: 프로그램의 진입점 파일

 

 

package.json 예시

{
  "name": "my-node-project",
  "version": "1.0.0",
  "description": "A simple Node.js project",
  "author": "Your Name <your.email@example.com>",
  "license": "MIT",
  "dependencies": {
    "express": "^4.17.1",
    "lodash": "^4.17.21"
  },
  "devDependencies": {
    "nodemon": "^2.0.15",
    "jest": "^27.4.7"
  },
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  }
}

 

위 예시에서:

• dependencies: 프로젝트 실행에 필요한 express와 lodash 패키지를 정의
• devDependencies: 개발 환경에서만 필요한 nodemon (자동 재시작 도구)과 jest (테스트 프레임워크)를 정의
• scripts: start 스크립트는 index.js 파일을 실행하고, test 스크립트는 jest를 실행하여 테스트를 수행