npm을 이용해 오픈소스 배포하기

 

1. 준비물

• Node.js 설치
• npm 계정
• Git 저장소(선택이지만 사실상 필수)

---

2. 프로젝트 초기화

빈 프로젝트라면 아래부터 시작한다.

npm init -y

package.json이 생성되고, 이 파일이 배포의 핵심이다.

---

3. package.json에서 꼭 확인할 것

{
  "name": "my-awesome-lib",
  "version": "0.1.0",
  "main": "dist/index.js",
  "license": "MIT"
}

중요한 필드

• name: npm에서 유일해야 함
• version: 배포할 때마다 반드시 증가
• main: 패키지 진입 파일
• license: 오픈소스라면 명시 필수

---

4. 배포할 파일만 남기기

보통은 빌드 결과물만 배포한다.

{
  "files": ["dist"]
}

또는 .npmignore를 사용해 제외할 파일을 지정할 수 있다.

---

5. npm 로그인

npm login

아이디, 비밀번호, 이메일을 입력하면 로그인 완료.

---

6. 배포하기

npm publish

처음 배포되면 즉시 npm 레지스트리에 공개된다.

이후 수정 시에는

npm version patch
npm publish

처럼 버전을 올린 뒤 다시 배포해야 한다.

---

7. 배포 확인

npm view my-awesome-lib

또는 npm 웹사이트에서 검색하면 정상 배포 여부를 확인할 수 있다.

---

8. 오픈소스로서 최소한의 예의

권장 파일

• README.md : 사용법
• LICENSE : 라이선스 전문

이 두 개만 있어도 오픈소스로서 충분하다.

---

마무리

npm 배포는 복잡하지 않다.

• package.json을 제대로 작성하고
• 버전을 관리하며
• npm publish만 하면 된다

나머지는 선택사항이다.