[Node.js 교과서] #14. package.json으로 패키지 관리하기

서비스에 필요한 패키지를 하나씩 추가하다 보면 패키지 수가 100개를 훌쩍 넘어 버리게 된다. 그리고 사용할 패키지는 저마다 고유한 버전이 있으므로 어딘가에 기록해두어야 한다. 같은 패키지라도 버전별로 기능이 다를 수 있으므로 동일한 버전을 설치하지 않으면 문제가 생긴다. 이 때 설치한 패키지의 버전을 관리하는 파일이 package.json이다.

따라서 프로젝트를 시작하기 전에 package.json부터 만들고 시작하는 것이 좋다. npm은 package.json을 만드는 명령어를 제공한다.

■ package.json 만들기

 

 

 

• package name : 패키지의 이름이다. package.json의 name 속성에 저장된다.
• version : 패키지의 버전이다. npm의 버전은 다소 엄격하게 관리된다.
• entry point : 자바스크립트 실행 파일 진입점이다. 보통 마지막으로 module.exports를 하는 파일을 지정한다. package.json의 main 속성에 저장된다.
• test command : 코드를 테스트할 때 입력할 명령어를 의미한다. package.json scripts 속성 안의 test 속성에 저장된다.
• git repository : 코드를 저장해둔 git 저장소 주소를 의미한다. package.json의 repository 속성에 저장된다.
• keywords : 키워드는 npm 공식 홈페이지에서 패키지를 쉽게 찾을 수 있게 해준다. package.json의 keywords 속성에 저장된다.
• license : 해당 패키지의 라이선스를 넣어주면 된다.

 

☑ Note 라이선스

• 오픈 소스라고 해서 모든 패키지를 아무런 제약 없이 사용할 수 있는 것은 아니다. 라이선스별로 제한 사항이 있으므로 설치 전에 반드시 라이선스를 확인해야 한다.
• ISC, MIT나 BSD 라이선스를 가진 패키지를 사용할 때는 사용한 패키지와 라이선스만 밝혀주면 자유롭게 사용할 수 있다. 
• Apache 라이선스 패키지는 사용은 자유롭지만 특허권에 대한 제한이 포함되어 있다.
• GPL 라이선스 패키지를 사용할 때는 조심해야 한다. GPL 계열의 패비지를 사용한 패키지를 배포할 때는 자신의 패키지도 GPL로 배포하고 소스 코드도 공개해야 하기 때문이다.
• 라이선스별로 특징이 다르므로 오픈 소스를 사용하기 전에 반드시 라이선스를 확인하고 세부 내용을 읽어봐야 한다.

 

 

scripts 부분은 npm 명령어를 저장해두는 부분이다. 콘솔에서 npm run [스크립트 명령어]를 입력하면 해당 스크립트가 실행된다. 예를 들어 npm run test를 하면 echo "Error: no test speicified" && exit 1가 실행된다. echo "Error: no test speicified"는 콘솔에 핻아 문자열을 출력하라는 뜻이고, exit 1은 에러와 함께 종료하라는 뜻이다.

 

 

test 스크립트 외에도 scripts 속성에 명령어 여러 개를 등록해두고 사용할 수 있다. 보통 start 명령어에 node [파일명]을 저장해두고 npm start로 실행한다. start나 test 같은 스크립트는 run을 붙이지 않아도 실행된다.

■ 패키지 설치하기

express 패키지를 설치해보자. npm install [패키지 이름] 을 package.json이 있는 폴더의 콘솔에서 입력하면 된다.

 

 

설치한 패키지가 package.json에 기록된다.

 

 

dependencies라는 속성이 새로 생겼고, express라는 이름과 함께 설치된 버전이 저장되었다. 버전 앞에 ^ 표시가 붙어있는데, 여기에는 특별한 의미가 있다. (추후 설명 예정)

 

☑ Note npm WARN npmtest@0.0.1 No repository field.

• 이 경고는 package.json에 repository 속성이 없어서 발생한 것이다. 나중에 소스 코드를 GitHub이나 Gitlab 등과 같은 저장소에 저장한 후, repository 속성을 만들고 GitHub이나 Gitlab 주소를 적어주면 된다.

 

☑ Note --save 옵션

• 패키지를 설치할 때 npm install 명령어에 --save 옵션을 붙이는 책이나 블로그를 많이 볼 수 있다. dependencies에 패키지 이름을 추가하는 옵션이지만 npm@5부터는 기본값으로 설정되어 있으므로 따로 붙이지 않아도 된다.

 

추가로 node_modules라는 폴더도 생성되었다. 그 안에 설치한 패키지들이 들어 있다.

 

 

Express 하나만 설치했는데 패키지가 여러 개 들어 있다. 이는 Express가 의존하는 패키지들이다. 패키지 하나가 다른 여러 패키지에 의존하고, 그 패키지들은 또 다른 패키지들에 의존한다. 이렇게 의존 관계가 복잡하게 얽혀 있어 package.json이 필요한 것이다.

 

package-lock.json이라는 파일도 생성되었다.

 

 

직접 설치한 express 외에도 node_modules에 들어 있는 패키지들의 정보가 담겨 있다. npm으로 패키지를 설치, 수정, 삭제할 때마다 내부 의존 관계를 이 파일에 저장한다.

■ 모듈 여러 개 동시에 설치해보기

npm install [패키지1] [패키지2] [패키지3] [...] 와 같이 패키지들을 나열하면 된다.

 

 

설치한 패키지들이 dependencies 속성에 기록된다.

 

■ 개발용 패키지 설치하기

실제 배포 시에는 사용되지 않고, 개발 중에만 사용되는 패키지를 설치할 수 있다. npm install --save-dev [패키지] [...] 로 설치한다.

 

 

 

package.json에 devDependencies라는 새로운 속성이 생겼다. devDependencies 속성에서는 개발용 패키지들만 따로 관리한다.

■ npm 전역 패키지 설치하기

npm에는 전역 설치라는 옵션도 있다. 패키지를 현재 폴더의 node_modules에 설치하는 것이 아니라 npm이  설치되어 있는 폴더(Windows의 경우 기본 경로는 C:\Users\사용자이름\AppData\Roamng\npm, macOS의 경우에는 /usr/local/lib/node_modules)에 설치한다. 이 폴더의 경로는 보통 시스템 환경 변수에 등록되어 있으므로 전역 설치한 패키지는 콘솔의 커맨드로 사용할 수 있다.

 

 

• rimraf 패키지 : 리눅스나 macOS의 rm -rf 명령어를 윈도에서도 사용할 수 있게 해주는 패키지이다. rm -rf는 지정한 파일이나 폴더를 지우는 명령어이다. 전역 설치했으므로 rimraf 명령어를 콘솔에서 사용할 수 있다. 전역 설치한 패키지는 package.json에 기록되지 않는다.

■ rimraf로 node_modules 폴더 삭제해보기

 

오류가 발생했다. 인터넷에 찾아보니 해결책이 있었다. (https://singa-korean.tistory.com/21)

 

① PowerShell 관리자 권한으로 실행

② get-help Set-ExecutionPolicy로 설정할 수 있는 권한 확인

③ RemoteSigned 권한으로 정책 설정

④ 원래 하려고 했던 거 다시 해보기

rimraf 실행 후 NodeProject 폴더 내에 node_modules 폴더가 제거된 것 확인

 

설치한 패키지를 지워버렸지만 package.json에 설치한 패키지 내역이 들어 있으므로 걱정하지 않아도 된다. npm install만 하면 알아서 다시 설치된다.

 

 

 

즉, node_modules는 언제든지 npm install로 설치할 수 있으므로 node_modules는 보관할 필요가 없다는 점을 알 수 있다. Git 같은 버전 관리 프로그램과 같이 사용할 때도 node_modules는 커밋하지 않는다. 중요한 파일은 package.json이다.

 

☑ Note npx 명령어

• 전역 설치를 기피하는 개발자들도 있다. 전역 설치한 패키지는 package.json에 기록되지 않아 다시 설치할 때 어려움이 있기 때문이다. 이러한 경우를 위한 명령어로 npx가 있다.
• 아래와 같이 rimraf 모듈을 package.json의 devDependencies 속성에 기록한 후, 앞에 npx 명령어를 붙여 실행하면 된다. 패키지를 전역 설치한 것과 같은 효과를 얻을 수 있다.

  npm install --save-dev rimraf​
  npx rimraf node_modules

 

☑ Note npm에 등록되지 않은 패키지

• 모든 패키지가 npm에 등록되어 있는 것은 아니다. 일부 패키지는 오픈 소스가 아니거나 개발 중인 패키지라서 GitHub나 nexus 등의 저장소에 보관되어 있을 수도 있다. 그러한 패키지들도 npm install [저장소 주소] 명령어를 통해 설치할 수 있다.

 

☑ Note 명령어 줄여쓰기

• npm install 명령어는 npm i로 줄여쓸 수 있다. --save-dev 옵션은 -D로, --global 옵션은 -g로 줄여서 써도 된다.