PRACTICAL GUIDE
設定ファイルに使う形式
まず対象ツールが受け入れる形式を確認し、選べる場合はチームが安全に検証・保守できる形式を選びます。
迷ったら、ここで選ぶ
- APIやWebのデータ交換 → JSON
- インデントで構造を読みやすく書く設定 → YAML
- キーと値を中心に設定を管理 → TOML
- 形式を選べないツール → 指定された形式を優先
対応ツールを最優先する
設定形式は見た目の好みだけで選べません。利用するアプリケーション、ライブラリ、CI、ホスティング環境が受け入れる形式と仕様版を確認します。
構文検証を自動化する
JSON、YAML、TOMLはいずれも構文や型の誤りで読み込みに失敗することがあります。保存時やCIで構文検証を行い、秘密情報を設定ファイルに直接保存しない運用にします。
候補形式
関連する比較
注意点
- 対象ツールが対応する形式と仕様版を確認してください。
- 認証情報や秘密鍵をリポジトリに保存しないでください。