NPM 모듈 개발

📌 아주 간단한 NPM모듈을 만들어 봅시다.

NPM을 개발 시작 1

• Node.js가 설치되어 있어야 합니다.
• 개발을 위한 IDE가 있어야 합니다.
  • vscode로 진행 합니다.
• 기본적인 Javascript 문법을 숙지하고 있어야 합니다. Typescipt도 괜찮습니다.
• 일단 프로젝트 폴더를 하나 만들어 vscode에 프로젝트 폴더를 로드 합니다
  • 여기에서는 npmadd 라는 이름으로 생성 하였습니다.
• vscode에서 터미널을 하나 열어 줍니다.
• 기본 npm 개발 준비가 끝이 났습니다.

NPM을 개발 시작

💡 개발을 위한 기본 파일들을 생성 합니다.

• 가장 먼저 필요한 것은 package.json을 생성 해야 합니다.
• 직접 파일을 만들고 내용을 채워도 되며, npm init command를 이용하여 생성해도 괜찮습니다.
  • 자세한 항목 설명은 아래 링크를 참조 하세요
  • Modules: Packages | Node.js v20.6.1 Documentation
• 여기에서는 npm init으로 생성 합니다. vscode terminal에서 npm init command을 입력 합니다.

npm init

• npm init command를 입력하면, package name, 패키지 이름을 설정해야 합니다. 괄호내부에는 현재 폴더 이름을 디폴트로 보여주게 되며, 괄호 내부 값이 디폴트 값입니다. 아무 입력하지 않고 엔터를 눌러 넘어가면 기본으로 npmadd로 설정됩니다.

• 이름 설정 후 만들 npm 모듈의 버전을 설정하게 됩니다. 디폴트로 1.0.0이 나오게 됩니다.

• 다음으로 이 패키지대한 설명을 작성하게 됩니다. 디폴트 값은 없고 그냥 넘겨도 문제 없습니다.

• 다음으로 entrypoint를 설정하게 됩니다. entrypoint는 패키지 실행시 가장 먼저 실행되는 혹은 import되는 js 파일입니다.
  • 디폴트는 index.js 입니다.

• 다음은 test command를 설정합니다. test command는 현재 패키지 실행이 정상적인지 테스트 할 수 있는 command(혹은 script)을 입력합니다. 필수 항목은 아닙니다.
• 그 다음으 이 코드의 git repo 주소를 설정합니다. 필수 항목은 아닙니다.

• 그다음 이 패키지를 설명하기 위한 키워드를 설정합니다. 이 키워드는 일종의 hash tag 같은 역할을 하게 됩니다. npm.js 사이트등에서 검색 시 사용됩니다. 필수 값이 아닙니다.

• 패키지의 작성자를 설정 합니다. 역시 필수 값은 아닙니다.

• 이 패키지의 라이선스를 설정 합니다. ISC가 디폴트 입니다. 소프트웨어 라이선스에 대한 자세한 내용은 아래 링크를 참조 하세요
• ISC License

• 마지막으로 내용을 확인한 후 전체 내용이 맞는지 확인합니다.
• 맞는 다면 yes 혹은 그냥 엔터를 치면 package.json이 생성 됩니다.

{
  "name": "npmadd",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

• 생성된 package.json 입니다.

NPM 개발 시작2

• 이제 코드를 개발 합니다.
• 위 package.json에서 main을 index.js로 설정 하였으니, index.js 파일을 생성 합니다.

• require 혹은 import시 디폴트로 포함되는 파일이다.
• 즉 const npmadd = require(”npmadd”)와 같이 모듈을 포함하면 index.js파일이 import됩니다.
• 여기서는 단순히 2개의 수를 더하는 모듈을 만들어 보겠습니다.

exports.addNumber = (a, b) => {
    return a + b;
}

• exports 키워드를 사용하여, 모듈 외부에서 사용할 수 있게 하였습니다.
• 이제 이 상태로 npm을 생성해 보겠습니다.
• npm을 생성하는 방법은 간단합니다. code가 모두 있는 프로젝트 폴더에서 npm pack이라는 command만 치면 생성됩니다.
• npmadd-1.0.0.tgz가 생성되는 것을 확인 할 수 있습니다.
• 실제로 npm install {pacakge name}으로 설치할때에도, {package name}-{version}.tgz 파일을 다운받아 압축을 풀고 node_module에 copy하는 방식 입니다.

Local NPM 사용

• 먼저 nodejs 프로젝트를 개발한 폴더 하나를 생성한후 vscode에서 폴더를 열어 줍니다.
• 그리고 위에서 제작한 tgz 파일을 프로젝트 폴더에 카피하여 위치 시킵니다.
• 
• 터미널을 열고 “npm install ./npmadd-1.0.0.tgz” command를 입력합니다.

• node_modules와 package.json이 생성되고, 설치되는 것을 확인 할 수 있습니다.
• main.js에 아래와 같이 코딩합니다.

const npmadd = require('npmadd')
console.log(npmadd.addNumber(1,2))

• 아래와 같이 실행 시키면 동작을 확인 할수 있습니다.

node main.js

• 이제 기본적인 npm 개발이 가능 하게 되었습니다.
• 다음은 npmjs에 배포하는 방법에 대하여 알아보겠습니다.