【ルール説明・basic】var-naming

こちらの記事はAnsible lint Advent Calendar 2022 14日目の記事になります。

今回はルールvar-namingについて説明します。

var-naming

var-namingはAnsible の変数が規約通りに命名されているか検証します。

Ansible lintの変数名は数字・アルファベットの小文字・アンダーバーが利用でき、最初の文字はアルファベットの小文字およびアンダーバーとなっています。

問題のあるコード

---
- name: Example playbook
  hosts: localhost
  vars:
    CamelCase: true # <- 大文字が含まれている
    ALL_CAPS: bar # <- 小文字ではない
    v@r!able: baz # <- 無効な文字列が含まれている

修正されたコード

---
- name: Example playbook
  hosts: localhost
  vars:
    lowercase: true
    no_caps: bar
    variable: baz

変数の命名規則を変更する

変数の命名規則はAnsible lintの設定ファイルで変更する事が可能です。しかし命名規則を独自に設けるのは混乱の元にしかならないのでやめた方が良いでしょう。

参考サイト

• var-naming — Ansible Lint Documentation