1. NPM 계정 만들기
2. 배포 전 패키지명 중복 확인
npm info Javascript-Package-Name
중복 된 이름이라면 해당 패키지의 내용이 뜰 것이고, 없다면 404 에러가 뜸 (배포 가능한 이름)
3. 패키지 정의
npm init
#cd projectFolder
위 명령어를 입력하면 아래와 같이 뜸. (한 줄 한 줄씩)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
- version은 major.minor.patch (1.4.2 같은)로 구분 되어지고 각 도트 별 의미에 따라 이 후 코드 수정 후 재배포 할 때 마다 그 의미에 맞게 설정하면 됨. (패키지 파일에서 직접 수정하거나 npm version patch, npm version minor, npm version major 명령으로 업데이트 가능) - 만약 초기 배포시에 이미 개발을 완료한 상태라면 1.0.0 으로 해두고 그렇지 않다면 0.0.1 로 잡아주는게 좋다
- description 은 라이브러리에 대한 설명
- entry point 는 메인 파일 지정
- test command - 라이브러리를 테스트 할 수 있는 테스트 명령어 입력
- git repository - 깃 저장소 url
- keywords - 배포 환경 (javascript / jQuery / reactjs 등등)
- author - 보통 name<email>
- license:(ISC) 라이브러리의 라이센스 -MIT, ISC 등등 (설정하는 것에 따로 제한 사항은 없지만 해당 라이센스의 규칙을 따르고 있다고 명시 하는 격)
4. npm 로그인
npm login
로그인 성공 후 계정 확인할려면 npm whoami 명령어 입력
5. .npmignore
gitignore 처럼 npm에 배포 시 포함 하지 않을 파일/폴더 명시 ( 존재하지 않는다면 npm은 gitignore에 입력 된 내용으로 대체 함 )
// eg
node_modules
Develop
DevelopWithExpo
Example
ExampleWithExpo
.github
demo
6. 배포
라이브러리 배포하기 전에 특정 명령어가 필요하다면 (타입스크립트 일 경우 빌드 ) 패키지.json에서 스크립트 옵션을 사용
"scripts": {
...
"prepare": "rm -rf dist && tsc"
},
배포 할 준비가 끝났다면 아래 명령어를 통해 배포
npm publish
'오픈소스' 카테고리의 다른 글
@radix-ui 훑어보기 - accordion (0) | 2024.03.24 |
---|---|
[npm] package.json 옵션 정리 *main, module, exports, type, types (0) | 2024.01.10 |