[정리] package.json

15June 2024. 6. 3. 11:57

: 프로젝트의 메타데이터 포함하고 있는 설정 파일로, 프로젝트에 필요한 모듈과 버전, 스크립트 등을 정의한다.

-------------------------------------------------------------------------------------

{
  "name": "project-name",
  "version": "1.0.0",
  "description": "A sample Node.js project",
  "main": "server.js",
  "scripts": {
    "start": "node server.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Your Name",
  "license": "ISC",
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "nodemon": "^2.0.7"
  }
}

-------------------------------------------------------------------------------------

- name : 프로젝트 이름

※ npm 전체에서 고유해야 합니다.
- version : 프로젝트 버전
- description : 프로젝트에 대한 간단한 설명
- main : 서버 시작 파일- scripts : 스크립트 (#npm run <script-name>)

- start : npm start 통해 실행할 명령어

즉, 애플리케이션 시작 스크립트 지정

ex) node server.js를 기입하면 npm start 명령어 입력 시 node server.js 명령어가 실행됩니다.

- test : npm test 통해 실행할 명령어로 테스트 스크립트- author : 프로젝트 작성자 이름
- license : 프로젝트 릴리스 라이센스
- dependency : 프로젝트 실행 시 필요한 패키지
- devDependency : 테스트 프레임워크/빌드 도구와 같은 개발 목적 패키지 (# npm install <package-name> --save-dev)