npm 배포하기

kler_HJ·2020년 6월 1일
0

NPM

목록 보기
2/2

1. 회원가입

npm에 자신이 직접 만든 모듈을 배포하기 위해서는 당연히 npm 계정이 있어야한다.
회원가입 을 하러 가보자.

Public EmailUsername은 추후 배포시 패키지와 함께 공개됨에 주의하자.

2. 로그인

로그인은 console 실행 후 npm login 을 입력한다.

로그인 후, npm whoami를 입력하면 로그인 상태를 확인할 수 있다.


3. Git repository에 연동

npm에 배포될 모든 패키지는 git repository에 업로드 되어있어야 한다.

// git repository 연동
git init
git remote add origin [repository 주소] 

npm 배포 전, giit 저장소에 업로드 하고
READEME.md에 사용 방법에 대한 설명도 적어주는 것을 잊지말자.


4. package.json

우리가 배포할 패키지에 대한 거의 모든 정보는 package.json에 기록된다.

우선, package.json 파일을 생성하기 위해 console에 npm init 을 실행하자.

npm init --yes 를 실행하면
현재 프로젝트 directory 정보에 기반해 package.json을 생성할 수 있다.

npm init --yes로 package.json을 생성할 경우, 아래와 같은 키와 벨류 쌍이 자동으로 생성된다.

  • name (현재 directory 이름)
  • version (1.0.0)
  • description (README)
  • main (index.js)
  • scripts (test)
  • keywords
  • author
  • license (ISC)
  • bugs
  • homepage

package.json 에는 name, version 이 필수로 있어야 함에 주의하자.

{
  // name 소문자, 한 단어 
  "name": "my-awesome-package",
  "version": "1.0.0"
}

5. 버전 관리

npm은 패키지를 배포할 때 특정한 "의미있는" 버전 규칙을 따르도록 권장하고 있다.

패키지의 가장 첫 버전은 1.0.0 으로 시작한다.

  • 버그를 수정한 release는 1.0.1 과 같이, 가장 마지막 숫자를 증가시킨다.
  • 마이너한 업데이트가 있을 경우 1.1.0 처럼 두번째 숫자를 증가시켜야 한다.
  • 마지막으로, 큰 변화와 같은 메이저 업데이트2.0.0 가장 첫번째 숫자를 증가시킨다.

6. 테스트 & 배포

실제 npm에 배포하기 전,
npm install [프로젝트 경로] 를 통해 자신이 만든 패키지를 설치하여 테스트를 해보자.

아무 문제가 없다면,

간단히 npm publish --access public 명령어를 통해 npm에 배포할 수 있다.

profile
더 나은 제품과 디자인에 대해 고민하기를 즐기는 Front-end 개발자입니다.

0개의 댓글