npm 만들기


NPM(Node Package Manager)은 이름에서 알수 있듯이, 노드를 패키지로 만들어 관리해주는 역할한다.  오픈소스개발자가 만든 자신의 모듈(라이브러리)를 공개된 레지스트리에 등록하고 공유하여 여러사람이 사용할수 있게 관리하는게 목적이다. 여기서 앞글자가 Module 아닌 Node라고 했던 것은 npm이 처음 생겼을때 Node.js용 패키지 관리자로 생성되었기 때문이라고 알려져 있다.

기본적으로 node.js를 단, 한번이라도 사용해본 개발자라면 npm에 대하여 깊이 생각해본적은 없을지라도 모듈에 대한 개념과 필요한 모듈이 있을 경우 git을 통해 내려받고 설치하고 등등 npm install 명령어를 자주 접했을 것이다.

여기서는 그렇게 다른 개발자들이 만들어 올려둔 모듈을 사용하는것이 아니라 직접 만들어 배포하기 위해서는 어떻게 해야 하는지에 대한 내용을 작성하려고 한다.


npm 모듈을 만들어 배포하고 사용하는 개념을 그림을 간단히 표현하면 다음과 같다.

그림처럼 npm을 모듈을 만들어 배포하고 사용하기 위해서는 npm을 등록/저장하기위해 np에 멤버 가입 및 로그인이 필요하다. 가입과 사용은 무료이며, 비용(월 약 7$)을 지불하고 유로로 전환하면 비공개/개인적용도로 사용이 가능하다.

npm 생성 초기화

아래와 같은 명령어를 입력하여 npm 패키지를 만들기 위한 초기화를 수행하자.


패키지 초기 설정과 관련된 입력을 해야하는데 자신의 프로젝트에 맞도록 입력하면된다. 엔터를 입력하면 괄호 안에 있는 내용으로 자동입력되고 다음으로 넘어간다.
  • package name : 배포될 모듈명 
  • version : 배포 버전
  • description : 패키지 설명
  • entry point : 배포될 패키지의 진입 점(default export/import 대상 파일)
나머지는 그냥 엔터로 패스하도록 하자. 명령어를 입력한 디렉토리에 보면 아래와 같은 package.json 파일이 생성된 것을 확인 할수 있다.

package.json 생성 확인


package.json 파일이 생성된 디렉토리에서 패키지의 entry point 파일인 index.js를 생성하자.

npm 배포를 위한 로그인

npm 배포를 위해서는 아래와 같이 npm 레지스트리 사이트에 회원가입 및 로그인을 해야 한다. 회원가입은 해당 사이트(https://www.npmjs.com)에서 쉽게 할 수 있다.


Email의 경우 회원가입시 입력한 이메일 주소를 입력한다.

npm 배포

배포를 위해서 아래의 명령어를 입력하자. 


정상적으로 배포 될 경우 위와 같은 화면이 표시된다. 그리고 사이트에 접속하여 등록된 패키지를 확인할 수 있다.



혹시라도 오류가 발생한다면 아래와 같은 경우일 수 있으니 자세한 내용은 검색을 통해 해결하자.
  • npmjs.com의 이메일 인증을 받지 않은 경우
  • 패키지명이 중복된 경우(error code E403) : npm info [패키지명] 으로 중복 확이 가능
  • proxy or network에 문제가 있는 경우
  • 해당 패키지의 버전이 이미 존재하는 경우

패키지 설명 및 버전관리(README.md)

패키지의 설명과 버전 관리를 위해 README.md 파일을 생성하고 버전 관리에 대한 히스토리 및 패키지에 대한 설명을 추가하도록 하자. 위 파일은 해당 패키지를 검색했을 때, README.md 파일에 작성한 내용이 패키지으 메인에 표시되기 때문이다.

패키지 재배포

패키지를 재배포하기 위해서는 아래와 같이 version을 변경해줘야한다. 동일한 버전이 존재할경우 패키지를 등록할때 오류가 발생한다. 아래와 같이 patch를 사용하면 자동으로 패키지명으로 올려주며, 직접 수정을 원하면 npm version <major 또는 minor 또는 patch>를 사용하거나 package.json에서 직접 수정해도 된다. 명령어를 사용하면 package.json도 자동 수정된다.

$ npm version patch
v0.0.2
$ npm publish

npm version patch로 버전을 업데이트해주고, npm publish로 재배포하자.

정상적으로 배포될 경우 아래와 같은 화면이 표시된다.



패키지 확인

아래와 같이 패키지를 사이트에서 확인할 수 있으며, 해당 패키지를 이제 우리가 알고 있는 명령어인 npm i [패키지명]으로 설치하는 것이 가능해졌다.


배포한 패키지 삭제

배포한 패키지는 npm unpublish 커맨드를 이용해서 배포 후 72시간 내에 삭제 가능하다 (그 이후에는 npm 측에 직접 연락해서 삭제 요청을 해야한다)


배포한 패키지의 특정 버전을 삭제하려면 npm unpublish <패키지명>@<버전> 커맨드를 이용하면 된다.

$ npm unpublish xxx-npm@0.0.1
- xxxx-npm@0.0.1


배포한 패키지의 모든 버전을 삭제하려면 npm unpublish <패키지명> -f 커맨드를 이용합니다.

npm unpublish xxx-npm -f
npm WARN using --force I sure hope you know what you are doing.
- @xxx-npm



배포한 패키지 사용

이제 사용하고자 하는 프로젝트 폴더에서 아래와 같이 npm i 명령어를 통해 배포한 패키지를 설치하고 사용해보자.


위 그림에서 보는 것과 같이 패키지가 정상적으로 설치 되었다. 또한 node-module 디렉토리 아래에 해당 패키지의 폴더가 생성되고 그 아래에 패키지 파일들이 생성된 것을 확인 할 수 있다.

패키지 사용은 알다시피 아래와 같이 사용하고자 하는 파일에 import 하면된다.

import testui from 'txx-xxx-xe'

console.log(testui.ko)


아래와 같이 사이트를 실행하여 정상적으로 동작하는 것을 콘솔에서 확인해 볼 수 있다.



scope

npm 사용자 계정에 가입하거나 Org.를 만들면 사용자, Org. 이름과 일치하는 범위가 부여됨. 이 범위를 관련 패키지의 네임 스페이스로 사용할 수 있다.
스코프를 사용하면 충돌없이 다른 사용자나 Org.이 만든 패키지와 이름이 같은 패키지를 만들 수 있다. @과 /사이가 스크프이다.
@npm/package-name


scoped and package

  • unscoped 패키지는 항상 public
  • private 패키지는 항상 scoped 패키지여야 함
  • scoped 패키지는 디폴트로 private이기 때문에, 공개할 경우 커맨드 라인에 플래그를 명시해야함
username 이 아닌 스코프를 사용하고 싶다면 Org. 를 만들어야 한다.(https://www.npmjs.com/org/create)

댓글

댓글 쓰기

이 블로그의 인기 게시물

[JAVA] 변수란? 변수타입?

이미지
프로그램 언어를 배울때 항상 먼저 배우거나 집고 넘어가는 것이 있죠? 네 맞습니다.  변수 라는 것입니다. C언어나 Java에서는 int, char, float 등 자료형에 따라 다르고, Javascript에서는 모든 변수를 그냥 var로 사용하죠. 물론 또 개발 언어마다 조금씩 차이가 있습니다. 하지만, 기본적으로 "변수"라는 기본 개념은 모든 언어에서 모두 동일합니다. 이번 포스팅은 이 변수에 대하여 낱낱이 파헤쳐 봅시다.  아! 참고로 변수에 대하여 정말로 낱낱이 땅끝까지 파헤치자면 이 한번의 포스팅으로는 부족합니다. 따라서 오늘은 일차적으로 가장 기본이 되는 변수의 정의와 원시타입에 대해서만 낱낱이 살펴보도록 하겠습니다. 변수란 무엇일까? 자! 일단 변수란 무엇일까요? 변수란? 물어보면 가장 먼저 사람들은 당당히 말을 하죠.  "변하는 수" 물론 이 말도 틀린 말은 아닙니다. 우리 프로그래밍에서는 변수라는 공간에 값이 항상 변하는 그리고 그런 용도로 사용하려는 것이 변수니까요. 변수는 영어로 "Variable"라고 읽습니다. 이것을 사전에서 찾아보면 "변화하기 쉬운, 변덕스러운, 다양한" 이라는 의미를 갖습니다. 뭐 이 말도 틀린 말은 아니네요. 하지만! 우리는 개발자로도 더 프로그래밍 적인 의미를 원합니다. 그래서 이렇게 정의를 했죠. 변수란? 데이터(값)을 저장할 수 있는 프로그램의 저장 공간! 서론이 길었네요. ^^. 항상 무언가 정의를 내리기란 쉽지 않습니다..ㅎㅎㅎ 변수를 좀 더 이해하기 위해 아래의 그림을 예를 들어 보겠습니다. 위와 같이 우리가 물을 마셔야 한다면, 물을 마시기 위해 당연히 물 컵이 있어야겠죠.  아! 물통에 입을 대고 드시는 분들도 계시지만... 그러면 엄마한테 혼납니다. ㅎㅎ 아무튼 이렇게 물을 마시기 위해 물을 담을 컵을 준비하는 것을 프로그래밍에서는 "데이터를 사용하기 위해 변수를 선언한다" 라고 이야기 할 수 있습니다.  그럼 ...
자세한 내용 보기

[JAVA] 문자셋(Charset)

이미지
문자셋의 역사 2022년 현재를 기준으로 가장 많이 사용되고 많이들 알고 있는 문자셋(Charset)은 UTF-8일 것이라 생각합니다. 물론 여러분들이 프로그래밍을 공부했거나 컴퓨터 공학을 전공했다면 ASCII 뿐만 아리나 UNICODE 등 다양한 문자셋을 알고 있겠죠. 그래서 이렇게 많은 문자셋들이 왜 생겨서 우리를 괴롭히는지 그리고 다 공부해야하는지 궁굼해 하는 분들이 많으실거라 생각하여 짧게 문자셋의 역사와 자주 사용되는 문자셋 몇개를 정리해 보려 합니다. 일단 문자셋의 대략적인 역사 또는 발전기를 아래와 같은 그림으로 살펴보도록 하죠. 위에서 보는 바와 같이 최초의 컴퓨터는 알파벳권에서 처음 개발 및 사용되었다고 합니다. 그래서 초기에 컴퓨터를 만들 당시 알파벳만 사용하면 되었던 것이죠. 그 시대 배경을 보더라도 글로벌 시대도 아닌 냉전 시대였으니 뭐 당연한거라고 생각할 수 있었을거 같습니다. 그렇게 시작되었던 초기 컴퓨터에서 0과 1밖에 모르던 컴퓨터에서 사람이 사용하기 위해 글자를 표시할 방법을 컴퓨터 과학자들이 의논하게 되죠. 고민끝에 컴퓨터에서는 데이터를 부호화하는 방법으로 숫자를 문자로 치환하는 방법을 생각하게 됩니다. 예를 들어 0은 NULL 이라는 아무것도 없다라는 기호로 그리고 숫자 65면 문자 알파벳 대문자 ‘A’로 66면 대문자 ‘B’ 이렇게 쭈욱 이어지다가 소문자 ‘a’는 97로 정하게 되죠.  이렇게 사람이 볼수 있는 문자를 컴퓨터 언어인 코드번호로 변경 또는 ‘부호화’하는 방법을 ‘인코딩(Encoding)’ 이라고 하고. 코드번호를 사람이 알아들을 수 있는 문자로 다사 되돌리는 것을 복호화 또는 ‘디코딩(Decoding)’이라고 합니다. 인코딩 : 문자, 숫자, 기호 등을 컴퓨터의 내부처리를 위해 숫자코드번호로 변경하는 것. 디코딩 : 컴퓨터의 내부처리 숫자코드번호를 문자, 숫자, 기호 등을로 다시 복원하는 것. 그래서 처음으로 이러한 기준을 만들었던 것이 ASCII(American Standard Code for Info...
자세한 내용 보기

[JAVA] 문자열 비교[== vs equals()]의 차이

이미지
자바에서 기본 자료형(원시타입)의 비교 연산은 일반적으로 == 연산자를 사용합니다. 하지만 String의 경우는 == 연산자를 사용하여 비교하면 안전하지 않죠? 안전하지 않다는 말은 무슨 뜻일까요? String의 경우 여러분들이 편하게 아무생각(?) 없이 사용하는 리터럴 즉, 대입 연산자를 이용해 바로 상수를 대입하는 방식으로 사용할 경우에는 일반적으로 == 를 이용해 값을 확인해도 문제가 없습니다. 하지만 사용자로 부터 입력을 받아 사용할 경우 동일한 값을 입력 받더라도 비교 연산자(==)는 동일한 값인데도 false를 반환하죠. 즉 아래와 같이 코드를 작성했다고 가정합시다.  Scanner sc = new Scanner(System.in); String id = sc.next();      // 사용자한테 ‘abc’를 입력 받았다고 가정. System.out.println(id == “abc”); // 비교연산자(==)를 이용해 비교하면 false. // 그래서 우리는 String의 메소드인 equals()를 이용해 비교하면 true를 반환합니다. System.out.println(id.equals("abc")); 이처럼 비교연산자(==)와 equals()는 왜 차이가 나는 것인지 한번 살펴보기로 하겠습니다. 먼저 그림을 보도록 하겠습니다. 위 그림에 대한 결론부터 이야기 하자면 String과 같은 클래스에서의 비교연산자(==)는 객체의 주소을 비교하는 것이고, equals()는 주소가 가리키는 실제의 값, 즉 문자열을 비교하는 메소드입니다. 따라서 우리는 String를 사용할 때 항상 안전하게 그리고 생각하지 말고 equals()를 사용하라고 배우죠. 위의 그림에서 선언한 각각의 변수들 주소를 이클립스에서 출력해보면 다음과 같습니다. String str1 = "Hello"; String str2 = "Hello"; String str3 = new String("World...
자세한 내용 보기