package.json内に、「why not」的な意図をコメントとして書きたいと思い調べたが、結論として仕様(spec)上はそういうユースケースで想定されていない様子だった。
以下のStack Overflowスレッドでは、ハック的なやり方でコメントを書く方法が2案紹介されていたので備忘録的に残しておく。
How do I add comments to package.json for npm install? - Stack Overflow
案1
{ "//": "comment!", "dependencies": {...} }
案2
{ "name": "package name", "version": "1.0", "description": "package description", "scripts": { "start": "npm install && node server.js" }, "scriptsComments": { "start": "Runs development build on a local server configured by server.js" }, "dependencies": { "ajv": "^5.2.2" }, "dependenciesComments": { "ajv": "JSON-Schema Validator for validation of API data" } }