npm과 패키지 관리
현대 웹 개발은 단순히 HTML, CSS, JavaScript 파일만으로 이루어지지 않습니다. 우리는 React, Express.js와 같은 프레임워크나 Axios, Lodash, date-fns 같은 다양한 유틸리티 라이브러리들을 사용합니다. 이러한 외부 라이브러리들을 일일이 다운로드하고 관리하는 것은 비효율적이고 복잡한 일입니다.
여기서 등장하는 것이 바로 패키지 관리자(Package Manager) 입니다. 패키지 관리자는 프로젝트가 의존하는 라이브러리(패키지)들을 설치, 업데이트, 삭제하며 효율적으로 관리해주는 도구입니다. Node.js 생태계에서 가장 널리 사용되는 패키지 관리자는 바로 npm (Node Package Manager) 입니다.
이번 장에서는 npm의 기본 개념과 주요 기능, 그리고 이를 활용하여 프로젝트의 패키지를 효율적으로 관리하는 방법에 대해 학습할 것입니다. npm에 대한 이해는 모던 JavaScript 개발에서 필수적이며, 거의 모든 웹 프로젝트에서 마주하게 될 중요한 도구입니다.
패키지와 패키지 관리자란?
패키지 (Package)
패키지는 특정 기능을 수행하기 위해 미리 작성되고 모듈화된 코드, 즉 라이브러리나 프레임워크를 의미합니다. 웹 개발에서는 react, express, axios, lodash 등이 모두 패키지의 예시입니다. 이 패키지들은 다른 개발자들이 만들어 공개한 오픈소스이며, 우리는 이를 가져다 사용함으로써 개발 시간을 단축하고 안정성을 높일 수 있습니다.
패키지 관리자 (Package Manager)
패키지 관리자는 이러한 패키지들을 검색, 설치, 업데이트, 제거하는 일련의 과정을 자동화하고 효율적으로 관리해주는 도구입니다. 또한, 특정 패키지가 동작하기 위해 필요한 다른 패키지(의존성, Dependency)들을 자동으로 설치해주고 관리하는 역할도 수행합니다.
Node.js 환경에서는 npm이 가장 대표적인 패키지 관리자이며, Yarn도 npm과 유사한 기능을 제공하는 인기 있는 대안입니다.
npm이란?
npm (Node Package Manager) 은 Node.js의 기본 패키지 관리자이자, 세계에서 가장 큰 소프트웨어 레지스트리(저장소) 중 하나입니다. 수백만 개의 오픈소스 JavaScript 패키지들이 npm 레지스트리에 등록되어 있으며, 누구나 이를 검색하고 사용할 수 있습니다.
npm의 주요 기능
- 패키지 설치:
npm install <package-name>명령어를 통해 필요한 패키지를 쉽게 설치할 수 있습니다. - 패키지 제거:
npm uninstall <package-name>명령어로 패키지를 제거합니다. - 패키지 업데이트:
npm update <package-name>명령어로 패키지를 최신 버전으로 업데이트합니다. - 의존성 관리: 프로젝트의
package.json파일을 기반으로 필요한 모든 의존성 패키지를 자동으로 설치합니다. - 스크립트 실행:
package.json에 정의된 커스텀 스크립트(예:npm start,npm test,npm build)를 실행할 수 있습니다. - 패키지 발행: 자신이 만든 패키지를 npm 레지스트리에 배포하여 다른 개발자들이 사용할 수 있도록 합니다.
package.json 파일의 이해
package.json 파일은 npm을 사용하는 모든 Node.js 프로젝트의 핵심 설정 파일입니다. 이 파일은 프로젝트에 대한 메타데이터와 패키지 의존성, 스크립트 등을 정의합니다.
package.json 파일 생성
새로운 프로젝트를 시작할 때 npm init 명령어를 사용하여 package.json 파일을 생성할 수 있습니다.
mkdir my-nodejs-app
cd my-nodejs-app
npm init이 명령어는 프로젝트 이름, 버전, 설명 등을 입력하라는 프롬프트가 나타납니다. 모든 질문에 기본값으로 응답하려면 -y 플래그를 사용합니다.
npm init -y생성된 package.json 파일의 기본적인 구조는 다음과 같습니다.
{
"name": "my-nodejs-app", // 프로젝트 이름 (필수)
"version": "1.0.0", // 프로젝트 버전 (필수)
"description": "My first Node.js app", // 프로젝트 설명
"main": "index.js", // 프로젝트의 진입점 파일
"scripts": { // 스크립트 명령어 정의
"test": "echo \"Error: no test specified\" && exit 1",
"start": "node index.js" // 예시: npm start 실행 시 node index.js 실행
},
"keywords": [], // 검색 키워드
"author": "Your Name <your@email.com>", // 저자 정보
"license": "ISC", // 라이선스
"dependencies": {}, // 프로덕션 의존성 (실제 서비스 운영에 필요한 패키지)
"devDependencies": {} // 개발 의존성 (개발/테스트/빌드에만 필요한 패키지)
}주요 필드 설명
name: 프로젝트의 이름입니다. npm 레지스트리에 발행할 경우 고유해야 합니다.version: 프로젝트의 현재 버전입니다. SemVer(Semantic Versioning) 규칙을 따르는 것이 일반적입니다. (예:1.0.0)main: 프로젝트의 진입점(Entry Point) 파일입니다.require('my-nodejs-app')처럼 프로젝트를 모듈로 임포트할 때 사용되는 파일입니다.scripts: 프로젝트에서 자주 사용하는 명령어들을 정의합니다.npm run <script-name>형태로 실행합니다.start,test등 일부 스크립트는run없이npm start,npm test로 바로 실행할 수 있습니다.dependencies: 프로젝트가 실제 운영 환경(프로덕션 환경) 에서 실행될 때 필요한 패키지들입니다. (예:react,express,axios)devDependencies: 프로젝트를 개발, 테스트, 빌드하는 데만 필요한 패키지들입니다. 실제 서비스 운영에는 필요하지 않습니다. (예:nodemon,jest,webpack)
npm 명령어 사용법
패키지 설치
-
일반적인 패키지 설치 (dependencies)
npm install express # express 패키지 설치 (최신 버전) npm i react # 'install'을 'i'로 줄여 쓸 수 있음 npm install axios@^1.6.0 # 특정 버전 범위의 패키지 설치이 명령어는 패키지를
node_modules디렉토리에 설치하고,package.json파일의dependencies섹션에 패키지 이름과 버전 정보가 자동으로 추가됩니다. -
개발용 패키지 설치 (devDependencies)
npm install nodemon --save-dev npm i jest -D # '--save-dev'를 '-D'로 줄여 쓸 수 있음이 명령어는 패키지를
node_modules에 설치하고,package.json파일의devDependencies섹션에 추가합니다. -
전역 설치 (Global Installation) 일부 패키지는 프로젝트 내에서 사용하는 것이 아니라, 시스템 전체에서 CLI(Command Line Interface) 도구로 사용하기 위해 전역으로 설치합니다. (예:
create-react-app,npm-check-updates)npm install -g create-react-app주의: 전역 설치는 가급적 피하고, 프로젝트 로컬에 설치하여
package.json에 의존성을 명시하는 것을 권장합니다. -
모든 의존성 설치 프로젝트를 처음 클론하거나, 다른 개발자가
package.json파일을 수정하여 새로운 의존성을 추가했을 때 사용합니다.npm install # package.json에 명시된 모든 dependencies 및 devDependencies 설치
패키지 제거
npm uninstall express
npm uninstall jest -D패키지 업데이트
npm update # 모든 패키지를 package.json에 명시된 버전 범위 내에서 업데이트
npm update express # 특정 패키지 업데이트팁: npm outdated 명령어를 사용하면 현재 설치된 패키지 중 업데이트가 가능한 패키지 목록을 확인할 수 있습니다.
SemVer (Semantic Versioning): 1.2.3과 같은 버전 번호는 메이저.마이너.패치를 의미합니다.
~1.2.3(틸드):1.2.x버전까지 업데이트 허용. (패치 버전만 업데이트)^1.2.3(캐럿):1.x.x버전까지 업데이트 허용. (마이너, 패치 버전 업데이트) 따라서npm update는 일반적으로package.json에 명시된 버전 범위 내에서만 업데이트를 수행합니다. 메이저 버전 업데이트 등 더 큰 업데이트를 원하면npm install <package-name>@latest또는npm-check-updates(패키지)와 같은 도구를 사용해야 합니다.
스크립트 실행
package.json의 scripts 섹션에 정의된 명령어를 실행합니다.
npm run test
npm run start # 'start' 스크립트는 'run' 생략 가능package-lock.json 파일
npm install 명령어를 실행하면 package-lock.json 파일이 자동으로 생성됩니다. 이 파일은 node_modules에 실제로 설치된 패키지들의 정확한 버전, 의존성 트리, 다운로드 URL 등의 상세 정보를 기록합니다.
- 왜 필요한가?:
package.json의 버전 범위(^1.2.3)는 여러 개발자가 동일한npm install명령어를 실행했을 때, 각기 다른 '최신' 패치/마이너 버전이 설치되어 결과적으로 다른 환경이 구축될 위험이 있습니다.package-lock.json은 모든 개발자가 정확히 동일한 버전의 패키지들을 설치하도록 보장하여 "내 컴퓨터에서는 되는데..." 문제를 방지합니다. - Git 관리:
package-lock.json파일은 반드시 Git 버전 관리 대상에 포함시켜야 합니다.
Yarn (선택 사항)
Yarn은 Facebook(현 Meta)에서 개발한 또 다른 JavaScript 패키지 관리자입니다. npm과 유사한 기능을 제공하지만, 일부 면에서 개선된 점을 제공합니다.
- 주요 특징
- 빠른 속도: 패키지 설치 시 병렬 처리 및 캐싱을 통해 npm보다 빠를 수 있습니다.
- 결정론적 설치:
yarn.lock파일을 사용하여 항상 동일한 의존성 트리를 보장합니다 (npm의package-lock.json과 유사한 역할). - 오프라인 모드: 이전에 다운로드한 패키지를 캐시하여 인터넷 연결 없이도 설치할 수 있습니다.
- 명령어:
npm과 유사하지만 약간 다릅니다.npm install -D->yarn add --devnpm install->yarn addnpm uninstall->yarn removenpm install(모든 의존성) ->yarnnpm run <script>->yarn <script>
- 선택 가이드: npm이 꾸준히 발전하여 Yarn과의 성능 차이가 많이 줄어들었지만, 여전히 Yarn을 선호하는 개발자나 팀이 많습니다. 어느 것을 사용해도 무방하며, 중요한 것은 팀 내에서 일관된 도구를 사용하는 것입니다. 이 책에서는 npm을 기본으로 사용합니다.
마무리하며
이번 장에서는 모던 웹 개발의 필수 도구인 npm (Node Package Manager) 과 패키지 관리에 대해 심층적으로 학습했습니다.
여러분은 package.json 파일이 프로젝트의 메타데이터와 의존성을 정의하는 핵심 파일임을 이해하고, dependencies와 devDependencies의 차이점을 알았습니다. 또한, npm install, npm uninstall, npm update, npm run과 같은 주요 npm 명령어들을 사용하여 패키지를 효율적으로 설치, 제거, 업데이트하고 스크립트를 실행하는 방법을 익혔습니다. package-lock.json 파일의 역할과 SemVer 규칙에 대해서도 이해했습니다.
npm은 웹 개발 프로젝트에서 수많은 외부 라이브러리들을 체계적으로 관리하고, 개발 환경의 일관성을 유지하는 데 필수적인 도구입니다. 이 장에서 배운 지식들을 바탕으로 npm을 능숙하게 활용하여 효율적인 개발 환경을 구축하고, 다양한 오픈소스 라이브러리의 강력함을 여러분의 프로젝트에 접목시키시길 바랍니다.