package.json에 대해서
javascript
작성일 : 2023.04.06
package.json이란?
package.json이란 패키지 매니저로 설치한 모듈들의 의존성을 명세하고 관리하는 파일이다.
구성요소
name, version
패키지의 이름과 버젼을 명세하기 위해 필요한데 몇가지 규직이 존재한다.
- 이름은 214자 이하여야 한다.
- 범위가 지정된 패키지의 이름은 점 또는 밑줄로 시작할 수 있다. 범위가 없으면 허용되지 않는다.
- 새 패키지의 이름에는 대문자가 없어야 한다.
- 이름은 URL의 일부, 명령줄의 인수 및 폴더 이름이 된다. 따라서 이름에는 URL 안전이 아닌 문자를 포함할 수 없다.
description
패키지에 대한 설명을 기술한다. npm에서 검색됐을 때 리스트에 표시되기 때문에 사람들이 패키지를 찾아 내고 이해하는 데 도움이 된다.
keywords
키워드를 문자열 배열로 설명한다. npm에서 검색됐을 때 리스트에 표시되기 때문에 사람들이 패키지를 찾아 내고 이해하는 데 도움이 된다.
main
프로젝트의 진입점이 되는 파일을 지정한다. 일반적으로 "index.js"와 같이 프로젝트의 주요 JavaScript 파일을 가리키는 경로를 작성합니다.
scripts
프로젝트에서 사용할 수 있는 명령어 스크립트들을 정의한다. 이는 개발, 빌드, 테스트 등의 작업을 자동화하는 데 사용되고 예를 들어, "start", "build", "test" 등의 스크립트를 지정할 수 있다.
dependencies
프로젝트가 의존하고 있는 패키지와 해당 버전에 대한 정보를 명시한다.
devDependencies
개발시에만 필요한 패키지와 해당 버전 정보를 명시한다. 예를들어 프로젝트 개발 및 빌드 도구, 테스트 프레임워크, 코드 포맷터 등을 포함한다.
author
프로젝트의 작성자 정보를 포함한다. 보통 이름 이메일주소, 웹사이트 등을 작성한다.
license
프로젝트의 라이센스에 대해 기재한다. 프로젝트의 사용, 수정, 배포하는데 적용되는 규정을 나타내는 것 이다.