package.json

설명 : package.json파일은 패키지에 무엇이 필요한지 알 수 있으며 파일 내 구성은 자바스크립트 객체 리터럴이 아닌 실제 JSON이어야 한다.

원문 : This document is all you need to know about what's required in your package.json file. It must be actual JSON, not just a JavaScript object literal.

개인 정리 : 프로그램 패키지 설명서

name, value

패키지를 배포할 계획이 있다면, name과 values는 가장 중요한 항목이다. json은 이름과 버전 필드로 구성되며, 이름과 버전은 완전히 고유한 식별자로 형성한다. 또한, 패키지에 대한 변경은 버전에 대한 변경과 함께 진행되어야하고 패키지를 배포할 계획이 없는 경우 이름 및 버전 필드는 선택 사항이다.

원문: If you plan to publish your package, the most important things in your package.json are the name and version fields as they will be required. The name and version together form an identifier that is assumed to be completely unique. Changes to the package should come along with changes to the version. If you don't plan to publish your package, the name and version fields are optional.

---

규칙

• 이름은 214자 이하여야 하며 범위는 스코프로 감싸진 패키지를 감싸는 스코프가 포함되어야 한다.

• 범위 패키지의 이름은 점 또는 밑줄로 시작할 수 있으며, 범위 없이는 허용되지 않는다.

• 새 패키지는 이름에 대문자를 사용할 수 없다.

• 이 이름은 결국 URL, 명령줄의 인수 및 폴더 이름의 일부가 되며, 이름에 URL을 사용할 수 없는 문자를 사용할 수 없다.

원문 :

• The name must be less than or equal to 214 characters. This includes the scope for scoped packages.
• The names of scoped packages can begin with a dot or an underscore. This is not permitted without a scope.
• New packages must not have uppercase letters in the name.
• The name ends up being part of a URL, an argument on the command line, and a folder name. Therefore, the name can't contain any non-URL-safe characters.

description

description에는 설명을 넣게 되며 이후 해당패키지가 npm 검색에 나열되므로 다른 사용자가 패키지를 검색할 수 있다.

원문 : Put a description in it. It's a string. This helps people discover your package, as it's listed in npm search.

keywords

키워드를 넣게되며, 형태는 문자열로 구성된 배열형태이다. 이 또한 다른 사용자가 해당 패키지를 찾을 수 있게 도와준다.

원문 : Put keywords in it. It's an array of strings. This helps people discover your package as it's listed in npm search.

homepage

프로젝트 홈페이지에 대한 URL

원문 : The url to the project homepage.

bugs

프로젝트의 문제 확인에 대한 URL 과 문제를 보고를 위한 전자 메일 주소를 입력할 수 있으며, 이 기능은 패키지에서 문제가 발생한 사용자에게 유용하다.

원문 : The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.

license

패키지의 사용 허가 및 패키지에 대한 제한 사항을 알 수 있도록 패키지에 대한 라이센스를 지정할 수 있다.

원문 : You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.

author, contributors

author는 한 사람이며, contributors는 여러사람으로 이루어진 배열 형태이다. 한 사람은 객체 형태이며, 객체의 필드로는 "이름"필드를 가지고 선택적으로 "url"과 "이메일"을 추가할 수 있다.

원문 : The "author" is one person. "contributors" is an array of people. A "person" is an object with a "name" field and optionally "url" and "email".