Package.json 주석 - package.json juseog

질문 : npm 설치를 위해 package.json에 주석을 어떻게 추가합니까?

간단한 package.json 파일이 있고 주석을 추가하고 싶습니다. 이 작업을 수행하는 방법이 있습니까, 아니면이 작업을 수행 할 수있는 해킹이 있습니까?

{ "name": "My Project", "version": "0.0.1", "private": true, "dependencies": { "express": "3.x", "mongoose": "3.x" }, "devDependencies" : { "should": "*" /* "mocha": "*" not needed as should be globally installed */ } }

위의 예제 주석은 npm 중단으로 작동하지 않습니다. 나는 또한 // 스타일 주석을 시도했습니다.

답변

이것은 최근 Node.js 메일 링리스트 에서 논의되었습니다.

npm을 만든 Isaac Schlueter에 따르면 :

... "//"키는 npm에서 어떤 용도로도 사용되지 않으며 주석 용으로 예약되어 있습니다. 여러 줄 주석을 사용하려면 배열 또는 여러 "//"를 사용할 수 있습니다. 열쇠.

일반적인 도구 (npm, yarn 등)를 사용할 때 여러 "//"키가 제거됩니다. 이것은 살아남습니다.

{ "//": [ "first line", "second line" ] }

이것은 살아남지 못할 것입니다.

{ "//": "this is the first line of a comment", "//": "this is the second line of the comment" }
출처 : https://stackoverflow.com/questions/14221579/how-do-i-add-comments-to-package-json-for-npm-install