シンプルなファイルがあり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 が壊れているため機能しません。スタイルコメントも試しました。
ベストアンサー1
これは最近議論された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" }
はオブジェクトのルート
"//"
でのみ使用できることに注意する必要があります。たとえば、package.json
{ "//": "comment!", "dependencies": {...} }
有効だが
{ "dependencies": { "//": "comment?" } }
無効です。