package.json 스크립트 설정에 대해 이해하기

yujin·2023년 11월 20일
0

TIL

목록 보기
14/48
post-thumbnail

package.json 스크립트 설정에 대해 이해하기


1. package.json 스크립트 설정

package.json 파일은 Node.js 프로젝트의 메타데이터를 담고 있는 파일이며, 프로젝트의 이름, 버전, 설명, 저자 등의 정보와 사용하는 패키지의 목록을 저장한다. 또한 package.json 파일의 scripts 항목을 통해 다양한 명령어를 설정할 수 있다.

2. package.json 스크립트 설정 방법

package.json 파일의 scripts 항목에서는 특정 명령어를 간단한 이름으로 설정할 수 있다. 이렇게 설정한 스크립트는 npm run [스크립트 이름] 형태의 명령어로 실행할 수 있다.

예를 들어, 아래와 같이 start 스크립트를 설정하면 npm run start 명령어로 node app.js를 실행할 수 있다.

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

3. package.json 스크립트 설정의 장점

package.json 파일의 scripts 항목에서 스크립트를 설정하면, 복잡하고 긴 명령어를 간단하게 실행할 수 있다. 또한, 설정된 스크립트는 프로젝트를 사용하는 다른 사람들에게도 명령어를 쉽게 공유할 수 있다.

4. 예시

package.json 파일에서 Sequelize 마이그레이션 관련 스크립트를 설정하는 예시.

"scripts": {
  "migrate": "sequelize-cli db:migrate",
  "migrate:undo": "sequelize-cli db:migrate:undo",
  "migrate:generate": "sequelize-cli migration:generate --name"
}

위와 같이 설정하면 npm run migrate 명령어로 마이그레이션을 실행하고, npm run migrate:undo 명령어로 마이그레이션을 롤백하게 된다. 또한, npm run migrate:generate -- --name [마이그레이션 이름] 명령어로 새로운 마이그레이션 파일을 생성할 수 있다.

5. etc

오늘 해설 영상에서 다시 한번 인지하게 된 기능.
개인적으로 딱히 쓸 일이 없다 생각해서 지워버리고 있었는데 앞으로 자주 쓰게 될듯 하다.

profile
고통 받는 코딩일기

0개의 댓글