나만의 npm 패키지 만들기

먼저 npm이란?



npm은 두 가지입니다. 무엇보다도 오픈 소스 Node.js 프로젝트 게시를 위한 온라인 저장소입니다. 둘째, 패키지 설치, 버전 관리 및 종속성 관리를 지원하는 저장소와 상호 작용하기 위한 명령줄 유틸리티입니다. 수많은 Node.js 라이브러리와 애플리케이션이 npm에 게시되고 매일 더 많은 것이 추가됩니다.

☝ 이것은 내 머리에서 나온 것이 아닙니다. 🧠

정의에 대한 참조
https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/

설정하기



시작해야 할 것은 간단한 Node.js 설치로 시작하는 것입니다.
👇아래 링크 참고

How to install Node.js

Download link for Node.js

이를 간단한 단계로 나누어 보겠습니다.


1. package.json 파일 생성



npm 패키지를 게시하려면 package.json 외에는 아무것도 필요하지 않습니다. 그러나 예, 기능이 없을 것입니다.

package.json 파일을 만드는 방법에는 두 가지가 있습니다. 아무 코드 편집기나 열고 옛날 방식으로 직접 편집할 수 있습니다. 한번 해보시길 권해드립니다. JSON 파일에 키-값 쌍으로 추가하는 방법과 대상을 알게 됩니다.

{
    "name": "your-amazing-package",
    "version": "1.0.0",
}


패키지를 게시하는 데 필요한 최소 키-값 쌍입니다.

그러나 일을 효율적으로 수행하려면 다시 한 번. 아래 명령으로 package.json을 생성합니다.

npm init




지침에 따라 세부 정보를 차례로 입력하고 세부 정보를 확인한 후 Enter를 선택하십시오.

이것은 당신의 Package.json이 그것을 돌볼 방법입니다 👇

{
  "name": "awesome-npm",
  "version": "1.0.0",
  "description": "the awesome package",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/YOUR_Git_USERNAME/awesome-npm.git"
  },
  "keywords": [
    "awesome"
  ],
  "author": "Sourav Dey",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/YOUR_Git_USERNAME/awesome-npm/issues"
  },
  "homepage": "https://github.com/YOUR_Git_USERNAME/awesome-npm#readme"
}


package.json이 준비되었습니다. 이제 index.js는 pacakge.json에서 "main": "index.js"로 정의된 그림에 도달합니다.

2. index.js 파일 생성.



index.js 파일에 간단한 함수를 만들어 봅시다. 👇

function awesomeEmojiLog(message) {
    if (message === undefined) throw new Error("No Message Found");
    console.log("😎", message)
};

module.exports = awesomeEmojiLog


기능을 게시하기 전에 테스트하는 것이 좋습니다.
index.js 내부에서 다음과 같이 쉽게 호출할 수 있습니다.

awesomeEmojiLog("This is awesome emoji")


간단한 명령으로 테스트

node index.js


출력은

😎 This is awesome emoji


완료되면. 이제 그것을 출판할 때입니다.

3. npm 패키지 게시



npm 패키지를 게시하려면 먼저 👉Signup for npm 링크를 사용하여 npm 레지스트리에 계정을 만들어야 합니다.

완료. 시원한.

다음 두 명령 중 하나와 함께 터미널을 사용하여 npm에 로그인합니다.

npm login


또는

npm adduser


요청에 따라 사용자 이름, 비밀번호 및 이메일 ID를 입력하십시오.

그 후에는 npm 패키지에서 하나의 명령만 있으면 됩니다. 그냥 입력

npm publish


참고- 패키지 이름이 "@Your-username/packageName"으로 시작하는 경우

아래 명령을 사용하십시오.

npm publish --access=public


🎉🥳 npm 패키지가 게시되었습니다. 동일한 메일을 받게 되며 로그인한 경우 npm 레지스트리에서 패키지 목록을 확인할 수 있습니다.

4. 패키지용 Github Repo를 생성합니다.



저장소 awesome-npm을 만들고 코드를 푸시합니다.

명령을 따라 코드를 푸시합니다.

echo "# awesome-npm" >> README.md
git init
git add .
git commit -m "first commit"
git branch -M main
git remote add origin https://github.com/Souravdey777/awesome-npm.git
git push -u origin main


패키지에 대한 라이센스를 추가하십시오. 나는 MIT를 사용했습니다.



사용 방법 및 기능과 같은 패키지의 기본 세부 정보를 Readme 파일에 작성합니다. 이제 적절한 버전 관리를 통해 npm 패키지의 새 릴리스를 만들 수 있습니다.

참고용 레포를 확인하실 수 있습니다 👉
https://github.com/Souravdey777/awesome-npm

그리고 npm 패키지 👉
https://www.npmjs.com/package/awesome-npm

😎



멋진 npm 패키지가 준비되었습니다. 🎉🎉

당신이 그것을 사랑 바랍니다! 댓글로 알려주세요.

저에게 연락


  • Github


  • 좋은 웹페이지 즐겨찾기