npm 패키지 생성 가이드

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

웹 개발

대상자

초보 개발자, JavaScript/Node.js 사용자, NPM 패키지 등록에 관심 있는 개발자

핵심 요약

• npm init을 통해 package.json 생성
• index.js에 함수 작성 후 npm publish로 배포
• package.json에 "main", "description", "keywords" 설정 필수
• README.md 작성 및 Semantic Versioning 적용

섹션별 세부 요약

1. 패키지 생성 이유

• 개인 기술 성장: 패키지 구조, 버전 관리, 공유 방식 학습
• 커뮤니티 기여: 유용한 함수나 라이브러리 공유
• 이력서 강화: 실무 경험 증명
• 개발자 신뢰도 향상: 커뮤니티 참여 경험

2. 기본 프로젝트 설정

• 폴더 생성: my-title-case와 같은 이름으로 폴더 생성
• npm init: 기본 설정 적용 후 package.json 파일 생성
• index.js 작성: titleCase 함수 구현

function titleCase(str) {
  return str.toLowerCase().split(' ').map(word => word.charAt(0).toUpperCase() + word.slice(1)).join(' ');
}
module.exports = titleCase;

3. 테스트 및 설정

• test.js 생성: require('./index')로 함수 불러와 테스트
• package.json 수정:

- "main": "index.js"

- "description": "A simple function to convert text to title case"

- "keywords": ["title case", "text", "utility"]

4. 패키지 등록

• npm 계정 생성: https://www.npmjs.com/signup
• npm login 실행 후 npm publish으로 등록
• 패키지 이름: 유니크한 이름 선택 (예: my-title-case)

5. 추가 고려사항

• TypeScript 지원: index.d.ts 생성 및 "types": "index.d.ts" 추가
• 버전 관리: npm version patch 또는 npm version minor 사용
• 공통 오류:

- 패키지 이름 대문자 사용 금지

- 함수 export 누락

- README.md 생략

- 버전 업데이트 없이 재등록 시 NPM 차단

결론

• npm publish로 패키지 배포 시 Semantic Versioning 적용 필수
• README.md 작성은 사용자 이해를 위한 필수 요소
• 유니크한 패키지 이름 선택 후 등록
• 작은 유틸리티라도 커뮤니티에 기여 가능, 실무 경험의 중요한 축