コンテンツにスキップ

05.設定ファイル

このセクションでは、JSON, YAML, Markdownなど、ソースコード以外の設定ファイルやデータ記述形式に関する規約を管理します。

これらのファイルは、プロジェクトの設定やドキュメントの基盤となるため、一貫したスタイルで記述することで、ヒューマンエラーを防ぎ、可読性とメンテナンス性を高めます。

前提

ここにリストされている全ての規約は、01.共通コーディング原則の思想を、各ファイル形式に適用するものです。

対象ファイル形式の規約一覧

  • 01.JSON規約

    • APIのレスポンスや設定ファイルで利用されるJSONの、インデント、キーの命名規則 (camelCase)、データ形式（ISO 8601日時）などを定義します。

  • 02.YAML規約

    • mkdocs.ymlやGitHub Actionsのワークフローファイルで利用されるYAMLの、インデント（スペース2つ）、クォーテーションの使い分けなど、エラーを防ぐための厳格なスタイルを定義します。

  • 03.Markdown規約

    • このドキュメントサイトを構成するMarkdownファイルの、見出し、リスト、コードブロック、注釈（Admonition）などの記述スタイルを定義します。これは、01.ドキュメント規則の要約版としても機能します。

自動フォーマッターの活用

このカテゴリで扱うファイルは、その多くがPrettierのような自動フォーマッターに対応しています。 手作業での整形は避け、ツールによる自動化で一貫性を保つことを強く推奨します。