첫 번째 NPM 패키지를 작성하고 게시하는 방법

시작하기 전에…

이 작업을 시작하기 전에 다음 항목을 설정해야 합니다.

GitHub account

NodeJS 및 npm 설치됨

npm account

패키지 이름 선택

npm 패키지에 해당 이름을 사용할 수 있는지 확인해야 합니다. 범위가 지정되지 않은(공용) 패키지를 게시하는 경우; 패키지 이름은 고유해야 합니다.

그러나 범위가 지정된(비공개) 패키지를 게시하는 경우 이름은 고유하지 않아도 되며 이름은 @npm_username/package-name 형식을 사용합니다.
더 읽어보기

Scoped packages

Package name guidelines

npm 패키지 초기화

새 디렉터리를 만들고 다음을 사용하여 초기화합니다npm init.

$ npm init

패키지를 초기화하면 설정에 대한 몇 가지 질문이 표시됩니다.
기본package.json 파일이 프로젝트 디렉토리에 생성됩니다.

{
  "name": "number-to-comma-format",
  "version": "1.0.0",
  "description": "Convert a number to comma separated format",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "RAJESH K",
  "license": "MIT"
}

자세한 내용은 package.json을 참조하세요.

노드 모듈 생성

package.json의 main 필드는 패키지의 진입점을 정의합니다.
index.js 파일 생성

$ touch index.js

index.js에 다음 코드를 추가합니다.

'use strict'

const defaultOptions = {
  minimumFractionDigits: 2,
  maximumFractionDigits: 2
};

/**
 * @param  {Number} num - Number to be converted
 * @returns - Formatted number format
 */
function formatNumberToComma(num) {
  return Number(num).toLocaleString('en', defaultOptions);
}

module.exports = formatNumberToComma;

읽어보기 추가

다른 사람들이 사용 방법을 알 수 있도록 패키지에 대한 설명서를 포함하는 것이 좋습니다.
일반적으로 README는 다음을 포함해야 합니다.

패키지 기능에 대한 설명

설치 및 사용 지침

예제 코드

기부 가이드라인

패키지에서 사용하는 라이선스Choosing the right license

로컬에서 패키지 테스트

npm에 게시하기 전에 패키지를 로컬에서 테스트하는 것이 좋습니다.

패키지 디렉토리 외부에서 새 프로젝트 생성 및 초기화

패키지는 다음 명령으로 설치할 수 있습니다.

npm install number-to-comma-format

이것의 문제는 패키지가 아직 게시되지 않았으므로 npm에 없다는 것입니다. 패키지를 개발하고 테스트하는 동안 로컬에서 패키지를 참조해야 합니다.
패키지의 절대 경로를 사용하여 패키지를 설치할 수 있습니다.

npm install /home/rajesh/dev/number-to-comma-format

힘내 초기화

패키지의 github에 새 리포지토리를 만들고 소스 코드를 git에 푸시합니다.

git init
git add .
git commit -m "Initial commit"
git remote add origin https://github.com/rajeshkumaravel/numbertocommaformat.git
git push origin master

패키지를 npm에 게시

npm에 로그인

npm에 등록하는 동안 사용한 사용자 이름, 암호 및 이메일 주소를 입력하라는 메시지가 표시됩니다.

npm login

이제 패키지를 다음과 같이 npm에 게시할 수 있습니다.

npm publish

마무리

짜잔...! 이제 패키지가 npm에 게시되었습니다.

초기화npm init

노드 모듈/소스 코드 추가

로컬에서 패키지 테스트

자식 초기화

패키지 게시npm publish

그리고 그게 다야!

이 기사가 npm 게시를 시작하는 데 유용한 입문서가 되었기를 바랍니다. 항상 읽어주셔서 감사합니다!

자세한 내용은 npm 패키지를 확인하십시오Node express request idSource.

행복한 코딩!
RK