JSONファイルを整形してくれるCLIツールを公開した

JSONを整形してくれるCLIツールを作って公開した。

導入方法

$ npm install -g format-jsonfile

これにより、ターミナルでどこからでも format-jsonfile を利用可能になる。

使い方

第1引数に、整形したいjsonファイルのパスを入れるだけである。
sample.json がカレントディレクトリにある場合、整形のコマンドはこのようになる。

$ format-jsonfile sample.json

整形されたjsonのデフォルト出力先は、標準出力である。

コマンドラインオプション

• -o | --out : 後続するパスに、整形済みjsonを出力する
• -w | --width : インデントの幅を、後続する数値に変更する
• -t | --tabs : インデントをタブにする
• -h | --help : ヘルプを表示する

利用例

$ cat sample.json
{"array":[1,2,3], "object":{"num":1,"bool":true}}

$ format-jsonfile sample.json -w 4
{
    "array": [1,2,3],
    "object": {
        "num": 1,
        "bool": true
    }
}

作った理由

JSONを整形してくれるウェブサービスはごまんとあるが、ウェブ経由だと巨大なJSONファイルの扱いに不向きである。
オフラインで処理が完結するツールを探したが、意外と手頃なものが存在しなかった。
このため、勉強がてら自分で作ることにした。

その他

• npm公開の手順は、こちらを参照した
  • ユーザー登録から実際の公開作業まですべてターミナル上の数コマンドで完結し、便利であった
• npm -g install で実行可能なバイナリとしてインストールさせるための設定方法はこちら
  • package.json に1行追加するだけで済む
  • 実行するjsファイルの1行目に #!/usr/bin/env node を追加するのは忘れないようにしよう
• CLIコマンドのパースは minimist が便利