PythonとYAML Linting: yamllintの使い方

yamllintはPythonで書かれたYAMLファイルのリンターで、構文の有効性だけでなく、キーの繰り返しや行の長さ、末尾のスペース、インデントなどの問題もチェックします。

yamllintのインストール

Pythonのパッケージマネージャーであるpipを使用してyamllintをインストールします。

pip install --user yamllint

yamllintの使用方法

yamllintはファイルまたはディレクトリに対して実行できます。

# ファイルに対してLintを実行
yamllint my_file.yml my_other_file.yaml

# ディレクトリ内のすべてのYAMLファイルに対してLintを実行
yamllint .

# 事前定義されたLint設定を使用
yamllint -d relaxed file.yaml

# カスタムLint設定を使用
yamllint -c /path/to/myconfig file-to-lint.yaml

yamllintの設定ファイル

以下はyamllintの設定ファイルの例です。

extends: default
rules:
  # 80文字は十分なはずですが、行が長すぎる場合は失敗しないでください
  line-length:
    max: 80
    level: warning
  # このルールについては気にしないでください
  indentation: disable

特定のファイルを無視する（全体または一部のルールのみ）ために、.gitignoreスタイルのパターンを使用できます。

# すべてのルールに対して無視
ignore: |
  *.dont-lint-me.yaml
  /bin/
  !/bin/*.lint-me-anyway.yaml
rules:
  key-duplicates:
    ignore: |
      generated
      *.template.yaml
  trailing-spaces:
    ignore: |
      *.ignore-trailing-spaces.yaml
      /ascii-art/*

以上がPythonとyamllintを使用したYAMLファイルのLintingについての基本的なガイドです。これにより、YAMLファイルの品質と一貫性を向上させることができます。