[Node.js] package.json

·2023년 1월 27일
0

⚡ Package.json이 뭘까


package.json은 어떤 라이브러리를 썼는지, 모듈을 썼는지를 자동으로 기록해 두는 목록 파일이라고 생각 할 수 있다.

npm Docs에 따르면 package.json에서 가장 중요한 부분은 이름과 버전 필드 부분이라고 한다. 이름과 버전은 함께 완전히 고유한 것으로 간주되는 식별자를 형성하고, 패키지 변경은 버전 변경과 함께 제공되어야 한다고 한다. 또한 파일을 작성할때는 JS 객체 리터럴이 아닌 JSON 포맷을 사용해야 한다고 한다.

그렇다면 가장 중요하다고 하는 이름과 버전 필드 부분에 대해 가볍게 알아보도록 하자.

Name 이름

  • 이름은 반드시 214자보다 짧아야 하고 범위 패키지의 범위가 포함된다.
  • 범위가 지정된 패키지의 이름은 점이나 밑줄로 시작할 수 있다. 범위 없이는 허용❌.
  • 이름은 URL의 일부, 명령줄의 인수 및 폴더 이름이 된다. 따라서 이름에는 URL에 안전하지 않은 문자가 포함될 수 ❌.
  • 새 패키지는 이름에 대문자가 없어야한다.

이름에 "JS" 또는 "node"를 넣지❌.
package.json 파일을 작성 중이고 "engines" 필드를 사용하여 엔진을 지정할 수 있으므로 JS라고 가정한다.

Version 이름

  • 버전은 반드시 npm의 디펜던시에 포함된 node-semver로 parsing 가능해야 한다.

이 이외에도 description에 관한 항목과 keywords 부분등 더 많은 관련 부분이 있지만 패키지.json에서 제일 중요한 버전과 이름에 대해 알아보았고, 그 점을 유의하면서 사용해야 할 것이다.

좀 더 많은 부분에 대해 알고 싶다면 npm Docs를 참조하는 것이 좋을 것으로 보인다.

profile
뉴비는 문서화를 습관화 해보자

0개의 댓글