JEONGGON

블로그

〈

Node.js 패키지

2024.03.12.

패키지

1. 패키지

1-1. npm(Node Package Manager)

Node.js의 패키지 관리 도구

다른 사람이 만들어 놓은 Node.js 모듈들의 리포지토리(저장소)
- ex) 로그인 모듈(패키지), 전화인증 모듈(패키지), 메일 발송 모듈(패키지) 등…
패키지 설치, 버전 관리 및 종속성 관리를 지원하는 해당 저장소와 상호 작용하기 위한 명령줄 유틸리티
- ex) npm install, npm run dev 등…

1-2. npm audit

audit 명령어는 프로젝트의 종속성을 레지스트리에 제출하고, 취약성에 대한 보고서를 요청
취약점(vulnerabilities) 발견 시, 영향과 적절한 교정이 계산됨
fix 인수가 제공되면 수정사항이 패키지 트리에 적용됨

# 문제점 발견 시, 해당 명령어를 통해 문제점을 자동으로 해결할 수 있음

$ npm audit fix --force

1-3. npm install -g, npm install –save-dev

- 전역 설치

패키지를 전역(Global)으로 설치하려면 -g flag를 사용
전역 설치된 패키지는 디렉토리 관계없이 작동함

# 전역 설치 예시

$ npm install -g nodemon

- 로컬로 설치

로컬로 설치 시, --save-dev flag 사 용

# 로컬 설치 예시

$ npm install --save-dev nodemon

2. npm을 이용하여 Node.js 패키지 만들기

2-1. 루트폴더

패키지 파일들을 효율적으로 관리하기 위해 하나의 최상위 부모인 루트폴더를 정하고 그 아래에 모뎀 패키지 파일들을 생성

루트폴더로 이동

# 루트폴더 이동
$ cd '루트폴더 명'

2-2. 패키지 생성

패키지 생성 명령어

# 패키지 생성 명령어 입력
$ npm init

패키지 이름 지정

# 패키지 이름 물어보면 지정
# ex)
$ 'package-example1'

버전 지정

# 버전 물어봄
# 첫 버전이면 그냥 'enter' 입력


# 이후 패키지를 개발하면서 버전 관리하기

# 1. 패치 버전 업데이트 (Patch Version Update)
# : 패치 버전을 1 증가 (예: 1.0.0 -> 1.0.1).
$ npm version patch


# 2. 마이너 버전 업데이트 (Minor Version Update)
# : 마이너 버전을 1 증가 (예: 1.0.0 -> 1.1.0)
$ npm version minor


# 3. 메이저 버전 업데이트 (Major Version Update)
# : 메이저 버전을 1 증가 (예: 1.0.0 -> 2.0.0)
$ npm version major


# 4. 특정 버전으로 업데이트
$ npm version 1.2.3

# 버전 변경 후, add, commit, push 진행

# npm에 패키지 업데이트 푸시
$ npm publish

2-3. Description

패키지에 대한 설명을 입력 (안 입력 해도 상관없음)

2-4. entry point 지정

기본적으로 index.js이며 enter로 넘어감
여러 개의 파일 중 실행해야하는 파일을 명시하는 것

2-5. test command

패키지의 테스트를 실행하기 위해 package.json 파일에 “test” 스크립트를 설정할 수 있음
이 스크립트는 개발자들이 패키지를 테스트하고 검증하는 데 사용됨
enter로 넘어가도 됨

// package.json

{
  "scripts": {
    "test": "mocha tests/**/*.js",
    "start": "node index.js"
  }
}

scripts : 패키지를 개발하면서, 자주 실행해야하는 명령어를 사전에 정의해 두는 곳

# 테스트 코드 실행 시
$ npm test

# 패키지 실행 시
$ npm start

2-6. git repository

패키지를 관리할 레포지토리 설정
enter로 넘어가도 됨

// package.json

{
  "repository": {
    "type": "git",
    "url": "https://github.com/your-username/your-repo.git"
  }
}

2-7. keywords

package.json 파일에 정의된 속성 중 하나로, 패키지를 설명하고 검색하기 위한 키워드나 태그를 나타냄
enter로 넘어가도 됨

// package.json
{
  "keywords": [
    "keyword1",
    "keyword2"
  ]
}

2-8. author

본인 닉네임을 입력하거나 enter로 넘어가도 됨

// package.json

{
  "author": "Your Name"
}

2-9. license

패키지가 사용되는 조건과 제약을 설명하는 데 사용됨
enter로 넘어가도 됨

// package.json

{
  "license": "MIT"
}

2-10. 작성된 내용 최종확인

‘yes’ 선택
최종적으로 루트폴더 안에 package.json이라는 파일이 생성되고 패키지가 초기화 됨
package.json : 만드는 패키지의 정보를 기록하는 환경설정 파일

2-11. 패키지 실행

package.json의 scripts에 "start": "node index.js" 추가하고 터미널에 npm start 입력
처음에 에러 발생하는데 이는 당연한 것
- node index.js를 실행하는데 폴더 안에 index.js 파일이 없기 때문임
- 루트폴더에는 현재 package.json만 존재함
따라서, 루트폴더 안에 index.js를 만들기
이제 에러 발생하지 않음

3. npm을 이용하여 다른 사람이 만든 패키지 설치 및 사용하는 예시

3-1. 패키지(=모듈) 공유 사이트 이용

사이트 npmjs.com에는 방대한 Node 모듈들이 있으며, 대부분 오픈 소스 패키지임
예시로 ‘randomcolor’ 검색하여 선택

3-2. 설치하기

# 터미널에서 설치 명령어 입력

$ npm i randomcolor

i는 install(설치)을 의미하며 npm i, npm install 중 아무 명령어나 사용해도 괜찮음

1개의 패키지 추가, 2개의 패키지가 조정되었다는 메시지 확인

3-3. Dependency 의존성

이전과 달리 dependecies가 생기고 안에 randomcolor 패키지가 설치되어있는 것을 확인 할 수 있음
버전이 명시되어있는데 버전의 '^' 문자의 의미는 이 이상의 버전으로 설치됨을 의미함

3-4. node_modules

node_modules라는 라이브러리 루트폴더가 생성됨
내부에 현재 설치된 외부 패키지들의 폴더가 위치함
외부 패키지들도 마찬가지로 각각 package.json을 가짐

3-5. package-lock.json

파일이 생성되는 시점의 의존성 트리(node_modules)에 대한 정보를 가지고 있는 파일
기존의 package.json과 유사하나 설치된 외부 패키지들의 정보를 정확하게 명시해놓음
예를들어 package.json에서는 randomcolor 패키지의 버전을 "^0.6.2"(0.6.2 이상)로 범위적으로 명시해놓았으나, package-lock.json에는 "0.6.2"로 정확한 버전을 표기함
package-lock.json 파일을 사용하는 이유
- 소스 리포지토리에 커밋하기 위한 용도를 포함한 다양한 용도를 위해 사용
- 협업 시, 동일한 종속성을 보장하기 위해 사용 (버전 충돌 방지)
- 커밋하지 않고도 node_modules의 이전 상태로 되돌아가는 기능을 제공
- 읽을 수 있는 소스제어 diff를 통해 변경사항을 쉽게 볼 수 있음
- npm이 이전에 설치된 패키지에 대해 반복되는 메타데이터 확인을 건너뛸 수 있게 하여 설치 프로세스를 최적화 함