package.json scripts의 생명주기 스크립트, NPM LifeCycle Hook

📒 package.json scripts의 생명주기 스크립트, NPM LifeCycle Hook

---

이번에 이직을 하게 되어 기존 코드를 이리저리 파악해 봤습니다.

리드분과 Q&A를 하던 중 package.json scripts의 생명주기에 대한 이야기를 스치듯 들었고, 궁금해서 자세히 찾아보게 되었습니다.

 

📌 package.json의 scripts

"scripts": {
  "dev": "next dev",
  "build": "next build",
  "start": "next start",
  "lint": "next lint"
},

위는 next.js에서 흔히 보던 스크립트 필드입니다.

해당 스크립트를 실행시키기 위해 사용하는 패키지 매니저에 따라 npm run dev / yarn dev / pnpm dev와 같이 터미널에 명령어를 입력했습니다.

여기까진 npm이 제공하는 스크립트 실행 방식으로, 특정 이름의 스크립트를 정의하면 npm이 이를 자동으로 호출하거나 특정 이벤트에 따라 실행된다는 것을 당연하다는 듯 알고 있었습니다.

이에 더해서 빌드 혹은 패키지 배포 자동화를 위해 js 파일을 노드로 실행하거나, && 연산자를 사용하여 여러 스크립트를 이어서 실행하곤 했습니다.

그런데 이러한 스크립트 앞뒤에 자동으로 실행되는 생명주기 훅을 추가하여 && 연산자로 명령어를 길게 늘어뜨리지 않아도 자동화를 시킬 수 있었습니다.

 

📌 pre와 post 훅

package.json scripts에 특정 anyscript가 있다면 다음과 같이 pre와 post 키워드를 prefix로 붙여 스크립트 실행 전, 실행 후에 자동으로 스크립트를 실행시킬 수 있습니다.

"scripts": {
  "preanyscript": "echo '*** RUN PRE ***'",
  "anyscript": "echo '*** RUN ANYSCRIPT ***'",
  "postanyscript": "echo '*** RUN POST ***'"
},

 

이처럼 커스텀 스크립트 전, 후로 명령어를 자동 실행할 수 있을 뿐만 아니라 특정 상황에서만 발생하는 몇 가지 특별한 생명주기 스크립트 또한 있습니다.

 

📌 특수한 생명주기 스크립트

특정 상황에서만 발생하는 npm 스크립트를 실행 순서에 따라 소개드립니다.

자세한 실행방법과 생명주기 스크립트는 다음 npm 공식 문서를 참고 바랍니다.

https://docs.npmjs.com/cli/v8/using-npm/scripts#npm-start

🔎 install

1. preinstall: 패키지 설치 전에 실행
2. install: 패키지가 설치될 때 실행
3. postinstall: 해당 패키지가 로컬에 설치된 후 실행
4. prepublishOnly: npm install 중 패키지가 설치될 때 실행 (배포와 관련 없음)

🔎 publish

1. prepare: 배포 전에 실행 (Git 저장소에 설치할 때도 실행)
2. prepublishOnly: 패키지 배포 전에 실행 (prepare 다음)
3. publish: 패키지 배포 시 실행
4. postpublish: 패키지 배포가 완료된 후 실행

이러한 생명주기 스크립트를 이용한다면 특정 버전에서 오류가 발생하는 패키지를 install 후 로컬에서 패치할 수도 있고, 발행한 패키지를 로컬에 설치할 때 파일을 옮기는 사후 작업을 하는 등 무궁무진한 자동화 방법들을 떠올릴 수 있을 겁니다.

 

📌 주의할 점

이렇게 편리한 생명주기 스크립트를 사용할 때 유의할 점이 있습니다.

yarn 혹은 pnpm에서 특정 생명주기 스크립트를 지원할 수도, 지원하지 않을 수도 있기에 잘 찾아보고 사용하셔야 됩니다.