[npm].npmrc

npmrc 파일이란?

💡 npm에서 설정을 저장해두는 파일 내장(builtin), 전역(global), 사용자(user), 프로젝트(project) 4가지 범위의 npmrc 파일이 존재

 

• 내장 설정
  • npm이 설치된 경로에 있는 npmrc 파일에 명시됨
  • 모든 기본 설정을 담고 있음
• 전역 설정
  • 같은 컴퓨터를 사용하는 다른 사용자와 모든 프로젝트에 광범위하게 적용
  • 일반적으로 잘 건들지 않음

보통, 사용자 범위와 프로젝트 범위에서 npmrc 파일을 다룸

⇒파일 명 앞에 . 을 붙여 숨긴 파일로 사용

• 사용자 범위
  • 운영 체제의 사용자 홈(home) 디렉토리에 위치
• 프로젝트 범위
  • 프로젝트 최상위(root) 디렉토리에 위치

프로젝트 범위가 사용자 범위보다 좁음

⇒ 프로젝트 설정이 사용자 설정보다 우선시

npm config 커맨드

💡 npm은 여러 npmrc 파일을 손쉽게 관리할 수 있도록 npm config 커맨드 제공

 

• npm config 커맨드를 사용할 때 --location 또는 -L 옵션을 통해서 범위를 지정해 줄 수 있음.
• 이 옵션을 global로 설정하면 전역, user로 설정하면 사용자, project로 설정하면 프로젝트 범위가 적용
• default는 user
  • 사용자 홈 디렉토리에 있는 .npmrc파일을 상대로 커맨드가 실행

private npm registry란?

 💡 외부적으로 노출되지 않는 npm registry

 

private npm registry 왜 필요?

💡 private package를 원하는 것 본인이 속한 조직을 위해 npm registry를 구축하는 것

 

private npm registry는 어떻게 구축?

💡 verdaccio 활용

• create-react-app, stroybook, angular cli, babel등이 이를 활용

 

• Use private packages
• Cache npmjs.org registry
  • npmjs.org 서버가 느리거나, 죽게 되는 이슈를 방지하기 위해 미리 필요한 패키지들을 캐시하여 대비
• Link multiple registries
  • 하나의 프로젝트에서 여러 개의 registry 의 모듈을 가져올 수 있음
  • verdaccio 에서 제공하는 기능인 uplinks 를 참고
• Override public packages
  • 본인의 프로젝트에 오픈 소스를 사용시, 버그를 발견하여 PR 를 날렸지만 승인되지 않거나 지연되고 있을 경우가 존재할 때 ⇒ 본인이 구축한 npm 서버에 반영된 코드를 올려놓고 사용 가능
• E2E Testing
  • E2E 테스트는 publish 하는 패키지들에 대해 체크를 의미
  • publish - npm 서버에 업로드 하는 행위
  • local npm registry 를 통해 publish 를 시뮬레이션
  • create-react-app, storybook 등에서 사용하고 있는 방식

 

사용 방법

private npm registry 구축 :: 마이구미

## 명령어를 입력하면 .npmrc 파일에 저장
$ npm config set @tistory:registry <http://localhost:4873>

//.npmrc파일에 직접 셋팅 가능
@tistory:registry=http://localhost:4873

• 참고

  $ npm install @myorg/mypackage
  

  or

  //.npmrc
  
  //example들
  @project_a:registry=https://npm.fury.io/AUTH_TOKEN/USER_NAME/
  
  :registry=https://npm.pkg.github.com/
  //npm.pkg.github.com/:_authToken=
  

• "dependencies": { "@myorg/mypackage": "^1.3.0" }
• scope | npm Docs

Reference

npmrc 파일과 npm config 커맨드

.npmrc | pnpm

using myproject/.npmrc with registry

Using a Private NPM Repository (.npmrc) - Colyseus & Arena Cloud Documentation

[NPM] 다른 npm registry에서 npm 모듈 다운로드하기

private npm registry 구축 :: 마이구미