PART 02 — ツール導入
VS Code YAML拡張機能とyamllintによる構文チェック環境構築

エディタ上では問題なく見えていたYAMLが、CI環境で実行したら構文エラーで落ちる、ということが何度かありました。エディタのチェックとコマンドラインのチェックは別物だと気づいてから、両方を必ずセットで用意するようにしています。

この記事で構築する環境

図1: エディタ側のリアルタイムチェックと、コマンドライン側の静的チェックを両方用意する

本記事では2つのツールを導入します。1つはVS Code の YAML拡張機能で、編集中にリアルタイムでエラーや警告を表示してくれます。もう1つはyamllintというPython製のコマンドラインツールで、エディタを介さずファイルを直接検査でき、CI（継続的インテグレーション）にも組み込めます。

この2つを揃えることで、「書いている最中に気づける」チェックと「提出前に機械的に強制できる」チェックの両方をカバーします。

VS Code — YAML拡張機能の導入

VS Code の拡張機能マーケットプレイスで最も広く使われているYAML拡張機能は、Red Hat社が提供する YAML（拡張機能ID: redhat.vscode-yaml）です。裏側でJSON Schemaを使ったバリデーションエンジン（yaml-language-server）が動いています。

# コマンドパレット経由でもよいが、CLIから一括導入すると再現性が高い
code --install-extension redhat.vscode-yaml

GUIから入れる場合は、拡張機能タブ（Ctrl+Shift+X）で YAML を検索し、発行元が Red Hat のものをインストールしてください。

拡張機能の主な機能

特に便利なのがスキーマ検証機能です。GitHub Actionsのワークフローファイルや Kubernetes マニフェストなど、有名なフォーマットについては拡張機能が自動的にスキーマを推測して適用してくれる場合があります。独自フォーマットの場合は、設定でスキーマファイルのパスを明示的に紐づけることもできます。

{
  "yaml.schemas": {
    "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml",
    "./schemas/app-config.schema.json": "config/*.yaml"
  }
}

yamllintのインストール

yamllint はPython製のYAML構文・スタイルチェッカーです。エディタに依存せず、ターミナルやCI環境でそのまま実行できるのが最大の利点です。

# pip でインストール（仮想環境の利用を推奨）
pip install yamllint

# インストール確認
yamllint --version

# 特定ファイルを検査
yamllint config.yaml

# ディレクトリを再帰的に検査
yamllint .

# 標準のstrictルールを使う場合
yamllint -d default config.yaml

config.yaml
  3:1       error    wrong indentation: expected 2 but found 4  (indentation)
  7:10      warning  line too long (92 > 80 characters)  (line-length)
  12:1      error    duplication of key "port" in mapping  (key-duplicates)

yamllintの実行と設定ファイル（.yamllint）

デフォルトのルールセットは厳しめに設定されています。プロジェクトごとに緩めたい・強めたいルールがある場合は、リポジトリ直下に .yamllint（または.yamllint.yml）を置いてカスタマイズします。

extends: default

rules:
  # 1行の長さ制限を緩和（デフォルトは80文字）
  line-length:
    max: 120
    level: warning

  # インデント幅を明示的に2に固定
  indentation:
    spaces: 2
    indent-sequences: true

  # 末尾の空白行を最大1行まで許容
  empty-lines:
    max-end: 1

  # true/false以外の曖昧な真偽値表記を禁止（yes/no, on/offなど）
  truthy:
    allowed-values: ["true", "false"]

ignore: |
  vendor/
  node_modules/

2つのツールを組み合わせたワークフロー

1. VS Code上でYAMLファイルを編集し、拡張機能の赤波線でその場のミスに気づく
2. 区切りの良いタイミングでターミナルから yamllint . を実行し、プロジェクト全体を横断的に検査する
3. コミット前に問題がないことを確認してからPushする

動作確認

わざとインデントを崩したファイルで、拡張機能とyamllintの両方が反応することを確認しておきましょう。

service:
  name: web-app
   port: 8080

このファイルをVS Codeで開くと、3行目の port の位置に赤波線が表示されます。同じファイルに yamllint check.yaml を実行すると、syntax error として行番号付きでエラーが報告されます。両方で検出できれば、環境構築は完了です。