sodol-dotcom

Node.js와 패키지 스크립트 본문

Fundamentals/JavaScript

Node.js와 패키지 스크립트

sod0l 2024. 10. 1. 18:08

프론트엔드 개발에서 Node.js는 백엔드와의 연결, 데이터 처리, 서버 실행 등 여러 용도로 사용된다.

프로젝트가 커지면서 파일과 폴도의 구조가 복잡해질 수 있는데, 이럴 때 패키지 스크립트를 사용하면 더 간편하게 작업할 수 있다.

 

 

1. 패키지 스크립트란?

패키지 스크립트는 `package.json` 파일에 있는 `scripts` 항목에 정의된 명령어이다. 이 명령어를 사용하면 자주 사용하는 작업을 손쉽게 실행할 수 있다. 마치 매크로처럼, 복잡한 명령어를 간단한 이름을 대체해준다.

 

 

2. `package.json` 파일 이해하기

  • `package.json` 파일은 Node.js 프로젝트의 설정 정보를 담고 있는 파일이다.
  • 여기에는 프로젝트의 이름, 버전, 의존성, 그리고 스크립트 명령어 등이 포함되어 있다.

 

2-1. `package.json`의 예시

// json
{
  "name": "section03",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "description": ""
}

 

 

3. `start` 스크립트 추가하기

이제 자주 사용하는 명령어를 추가해보자.

 

3-1. `package.json` 파일 열기: 프로젝트 폴더에 있는 `package.json` 파일을 열어보자.

 

3-2. `scripts` 항목 찾기: `scripts` 항목을 찾아 아래와 같이 수정한다.

// json
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node src/index.js"
  },
  • 여기서 `start`는 우리가 정의할 새로운 스크립트의 이름이다.
  • `"node src/index.js"는 실제로 Node.js를 실행하는 명령어로, `src/index.js` 파일을 실행하라는 뜻이다.

 

 

4. 스크립트 실행하기

이제 만든 `start` 스크립트를 실행해보자.

 

4-1. VSCode 터미널 열기: VScode에서 터미널을 열어주자.

상단 메뉴에서 View > Terminal을 클릭하거나 단축키 `Ctrl + Backtick`을 사용한다.

 

4-2. 명령어 입력하기: 다음과 같이 입력한다.

npm run start

 

4-3. 결과 확인하기: 이제 터미널에 "안녕 Node.js"라는 메시지가 출력된다.

 

 

5. 패키지 스크립트의 장점

  • 경로 간소화: 매번 긴 경로를 입력할 필요가 없어서 편리하다.
  • 일관성: 팀원들이 동일한 명령어를 사용할 수 있어 코드 관리가 쉬워진다.
  • 자동화: 여러 작업을 스크립트로 만들어 자동으로 실행할 수 있다.

 

 

6.  요약

Node.js를 사용할 때 패키지 스크립트를 활용하면 프로젝트 관리가 훨씬 더 수월해진다. 복잡한 파일 경로를 간단한 스크립트 이름으로 대체하고, 이를 통해 효율적으로 작업할 수 있다는 점을 꼭 기억해두자.