[Node.js] npm에 대해서 알아보자!

 

npm이란?

npm은 node package manager의 약자로, Node.js의 기본 패키지 관리 도구다. 즉, 전세계의 개발자들이 만든 다양한 패키지(라이브러리, 모듈 등)을 설치, 업데이트, 삭제, 관리할 수 있다. Node.js를 설치하면 npm도 함께 설치가 되며, Node.js 환경에서 바로 npm 명령어를 사용할 수 있다.

 

npm을 대체하기 위한 패키지 관리 도구로는 yarn, pnpm 등이 있다.

 

패키지, 모듈, 라이브러리

npm은 패키지 관리 도구인데, 그렇다면 이 '패키지'는 무엇을 의미하는 것일까? JavaScript에서의 패키지는 코드와 함께 해당 코드에 대한 메타데이터를 묶은 하나의 배포 단위이다. 즉, 특정 기능을 수행하고 있는 코드의 모음으로, 보통 package.json 파일을 포함하고 있어야 패키지로 인식한다. 예를 들어, 숫자나 날짜를 처리하는 코드들을 패키지로 만들어 놓으면, 다른 개발자들은 이 패키지를 설치해 바로 사용할 수 있다.

 

한마디로 패키지는 주로 JavaScript에서 자주 사용되는 기능이나 로직을 재사용할 수 있도록 만든 것이다. 패키지 안에는 다양한 형태의 코드가 포함될 수 있으며, 그 중 대표적인 개념이 모듈과 라이브러리다.

 

모듈은 하나의 독립적인 기능을 수행하는 작은 단위, 코드 덩어리이다. 일반적으로 하나의 모듈은 하나의 특정 작업을 처리하는 코드로 구성되어 있다. 예를 들어, 숫자를 더하는 기능만 하는 코드, 날짜를 초기화하는 기능만 하는 코드가 하나의 모듈이다.

라이브러리는 보통 이러한 모듈 여러 개를 묶어서 제공하는 코드의 집합이다. 예를 들어, 날짜와 시간 관련 여러 기능을 다루는 코드들이 모여 하나의 라이브러리가 될 수 있다. 

 

 

package.json

프로젝트를 진행하다보면, 수많은 패키지들을 추가하게 된다. 이러한 패키지들은 저마다의 고유한 버전이 있고, 이것을 기록하고 관리해주는 파일이 바로 package.json이다.

 

npm을 사용하여 패키지를 관리하려면, 프로젝트 내에 package.json 파일이 존재해야 한다. package.json 파일을 생성하려면, 다음 명령어를 터미널에 입력하고, 패키지 이름 등의 정보를 입력해주면 된다.

npm init

 

이 명령어는 프로젝트의 메타데이터를 설정하고, package.json 파일을 생성하는 과정으로, 이후 패키지를 설치하고 관리하는 데 사용된다.

 

아래와 같이 npm init 명령어에 -y 플래그를 붙이면, 프로젝트 생성 시 일일이 정보를 넣지 않아도 package.json을 기본 내용으로 생성할 수 있다.

npm init -y

 

 

아래와 같이 생성된 package.json의 내용을 살펴볼 수 있다.

• name: 프로젝트 이름
• version: 프로젝트 버전
  • 일반적으로 semver(유의적 버전 관리)를 따름.
• main: 패키지가 모듈로 사용될 때 기본으로 로드될 파일을 지정한다.
  • 다른 프로젝트가 이 패키지를 require할 때 어떤 파일이 불러와져야 하는지 정의한다.
• scripts: 프로젝트에서 사용할 수 있는 명령어를 정의
  • 터미널에서 npm run <script-name>으로 실행 가능
• keywords: 프로젝트를 설명하는 키워드
  • 패키지 레지스트리에서 검색을 용이하게 함
• author: 프로젝트의 저자 정보.
  • 보통 이름과 이메일 포함
• license: 프로젝트의 라이선스 정의
  • 프로젝트가 어떤 라이선스를 따르는지 명시 (ex. MIT, GPL-3.0)
• description: 프로젝트에 대한 간단한 설명
  • 주로 패키지를 배포할 때 사용되고, npm 레지스트리에서 패키지 설명란에 표시됨

 

패키지 설치

아래의 명령어를 사용하 패키지를 설치할 수 있다.

npm install <package-name>

 

일반적으로 위와 같이 패키지를 설치해주면, 개발할 때와 프로젝트 실행할 때 모두 필요한 패키지인 일반 의존성 패키를 설치하는 것이 된다. npm install 명령어에 --save-dev (약어: -D)를 붙여주면, 개발과정에서만 필요한 패키지인 개발용 의존성 패키지(빌드 도구, 테스트 도구 등)를 설치하겠다는 의미가 된다.

npm install <package-name> --save-dev
npm install --save-dev <package-name>
npm install <package-name> -D
npm install -D <package-name>

 

package.json의 dependencies, devDependencies

 

패키지를 설치하고 나면 위와 같이 package.json 파일에 dependecies와 devDependencies가 추가된 것을 확인할 수 있다. 여기엔 현재 프로젝트에 설치된 패키지의 이름과 버전이 기록된다.

• dependencies : 일반 의존성 패키지 목록
• devDependecies: 개발용 의존성 패키지 목록

 

package-lock.json

 

npm install 후에 자동으로 package-lock.json 파일이 생성된다. 위 사진에서 확인할 수 있다시피, package.json보다 내용의 양이 훨씬 많다. 그 이유는 package-lock.json 파일은 프로젝트에서 설치된 정확한 패키지 버전과 설치된 패키지들의 모든 의존 관계를 기록하기 때문이다.

 

package.json은 주로 프로젝트에서 직접 사용하는 의존성을 관리하고, package-lock.json은 그 의존성들이 어떤 다른 의존성을 가지고 있는지까지 관리한다. 또한, package.json의 dependencies에는 ^1.0.0과 같은 버전 범위를 설정할 수 있지만, package-lock.json에서는 1.0.1과 같이 구체적인 버전이 기록된다.

 

위와 같이 package-lock.json을 통해 여러 명의 개발자가 같은 프로젝트에서 작업할 때, 모든 개발자가 동일한 패키지 버전을 설치하게 되어 버전 차이로 인한 문제를 방지할 수 있다.

 

 

node_modules

패키지 설치 후 생성되는 폴더로, 패키지를 설치하면 실제로 그 코드가 저장되는 곳이다. 이 폴더에는 프로젝트에서 사용되는 모든 외부 패키지와 라이브러리들이 설치되는 디렉토리이다.

 

일반적으로 node_modules는 아주 크고 무겁기 때문에 git과 같은 버전 관리 시스템에는 포함하지 않는다. .gitignore 파일에 node_modules를 추가하여 커밋되지 않도록 한다.

 

node_modules는 삭제가 되어도, 다시 npm install 명령어를 실행하면 package.json에 기록된 의존성들의 정보를 참고해 다시 생성할 수 있다. package-lock.json은 유지하는 것이 권장되지만, 실수로 삭제했더라도 역시 package.json의 정보를 바탕으로 새로운 package-lock.json 파일 생성할 수 있다. package.json 파일은 의존성 정보와 각종 설정을 기록하는 핵심 파일이므로 절대 삭제해서는 안된다.