1. ホーム
  2. comments

[解決済み] npmインストール時にpackage.jsonにコメントを追加するにはどうすればよいですか?

2022-03-20 06:01:05

質問

簡単な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" }