1 Minute Tips

jsonにコメントを書く

Written by

sumito.tsukada

in

はじめに

Jsonは正式にコメント欄というのがない。しかしコメント重要。なんとかする

解決策

“` hjson “` を導入する。

hjsonは正式にはjsonではないが、コメントついたjson。ちゃんとしたjsonにするには、変換コマンドを通すことにより、正式なjsonへ変換が可能。

導入

前提条件としてnodeがインストールされていることが必須。

npm install hjson -g

使い方

hjsonファイルを用意する

[
{
  /*
    email  (tsukada@sumito.jp)
  */
  "name": "mailAddress",
  "type": "STRING"
},
{
  /*
    realname (TSUKADA SUMITO)
  */
  "name": "realName",
  "type": "STRING"
},
{
  /*
    nickname (Smith)
  */
  "name": "nickname",
  "type": "STRING"
},
{
  /*
    day (2013/08/03 15:11:00)
  */
  "name": "recordDay",
  "type": "TIMESTAMP"
},
{
  /*
    some plans
  */
  "name": "Plan",
  "mode": "REPEATED",
  "type": "RECORD",
  "fields": [
    {
      "name": "optionID",
      "type": "INTEGER"
    },
    {
      "name": "optionName",
      "type": "STRING"
    }
  ]
}
]

hjsonコマンドでコメントが外れる

[
  {
    "name": "mailAddress",
    "type": "STRING"
  },
  {
    "name": "realName",
    "type": "STRING"
  },
  {
    "name": "nickname",
    "type": "STRING"
  },
  {
    "name": "recordDay",
    "type": "TIMESTAMP"
  },
  {
    "name": "Plan",
    "mode": "REPEATED",
    "type": "RECORD",
    "fields": [
      {
        "name": "optionID",
        "type": "INTEGER"
      },
      {
        "name": "optionName",
        "type": "STRING"
      }
    ]
  }
]

 

リダイレクトをしてコメントを省いたjsonフォーマットに変換することが可能

hjson -j sample.hjson > sample.json

参考情報

https://co.bsnws.net/article/131

 

 

More posts