Package.json

조영래·2022년 5월 17일
0
post-custom-banner

Package.json 란?

. package.json 파일은 배포한 모듈 정보를 담고자 만들어졌다.
. package.jsoin 파일은 기본적으로 CommonJS의 명세를 충실히 따르고 있으며 JSON 형식의 파일이다
. 직접 작성할 수도 있고 yarn init 명령을 통해서 자동으로 생성할 수도 있다.

name

. 프로젝트 이름으로, 가장 중요! 중앙 저장소에 배포할 때 version과 함께 필수 항목이다.
. url로 사용가능하고 설치할 때 디렉토리 이름이 되기 때문에 url이나 디렉토리에 쓸 수 없는 이름을 사용하면 안된다, 이름에 node나 js가 들어가면 안된다.
. name은 214자보다 짧아야 하며, 점(.)이나 밑줄(_)로 시작할 수 없다.

version

. 프로젝트 버전을 정의한다.

description

. 프로젝트 설명으로, 문자열로 기술한다.
. npm search로 검색된 리스트에 표시되기 때문에 사람들이 패키지를 찾아내고 이해하는데 도움이 된다.

keywords

. 프로젝트를 검색할 때 참조되는 키워드이다.
. description과 마찬가지로 npm search로 검색된 리스트에 표시된다.

homepage

. 프로젝트 홈페이지 주소이다.
. url 항목과는 다르며, url을 설정하면 예상치 못한 움직임을 하게 되므로 주의한다.

repository

. 프로젝트의 소스 코드를 저장한 저장소의 정보이다.
. 소스 코드에 참여하고자 하는 사람들에게 도움이 될 수 있다. 프로젝트의 홈페이지 url을 명시해서는 안된다.

scripts

. 프로젝트에서 자주 실행해야 하는 명령어를 scripts로 작성해두면 yarn 명령어로 실행 가능하다.


참조

profile
난될놈이야
post-custom-banner

0개의 댓글