見出し画像

package.jsonにコメントを書く方法

どうも、おっさんです。
package.jsonにコメント書きたい!って思ったことないですか?
おっさんは思いました。
結局、現状、こうなってます。

{
   "name": "my-package",
   "description": "my first package ever",
   "license": "MIT",
   "version": "1.0.0",
   "bin": "./cli.js",
   "main": "index.js",
   "scripts": {
       "start": "node index.js"
   },
   "dependencies": {
       "axios": "^0.18.0"
   },
   "devDependencies": {
       "eslint": "^5.14.1"
   },
   "__comments": [
       "・あるところにおっさんとおばさんがいました。",
       "・おっさんは在宅で働き、おばさんはニートでした。",
       "・そこへ、大きな桃がどんぶらこどんぶらことAmazonさんから配達されてきと思ったら、",
       "  中から巨大な、おっさんJr.が見参ッ!!",
       "・なんてこともなく、2人でおいしく召し上がりましたとさ。",
       "・めでたしめでたし。",
       "・コメントはこの行より上に書いて下さいね。"
   ]
}

こだわりポイントは以下です。

"__comments"という名称

そんなプロパティ、ねぇよ!ってことでスルーされるので何事もないはずです。

"__comments": []とリストにしてるところ

たとえば、

__comment001: "",
__comment002: "",
__comment003: "",

とかにもできるでしょうけど、インクリメントが面倒になりました。

箇条書きにしてるところ

1つの項目を複数行にしてもよいです。項目ごとに番号を振ると、番号の管理が面倒になるし、手前に挿入して番号のズレを発生させることで、無駄な差分が出るので、やめました。

コメントはこの行より上に書いて下さいね

これがあることで、追加された行の末尾には必ず「,」が付くことになり、「,」がなかった所に付くように変わるケースは出て来ないので、差分を見る時に実質変わってないのに差が出て来るケースを無くせます。

おわりに

オレオレスタイルなので、何か支障があったら、その時、考えます。今の所は困ってません。以上、よろしくお願いいたします。



この記事が気に入ったらサポートをしてみませんか?