Каков канонический стиль именования YAML
Я разрабатываю новый файл YAML, и я хочу использовать самый стандартный стиль именования. Что это?
Hyphenated?
- job-name:
...
lower_case_with_underscores?
- job_name:
...
CamelCase? (возможно, нет)
- jobName:
...
Ответы
Ответ 1
Используйте стандарт, продиктованный окружающим программным обеспечением.
Например, в моем текущем проекте файл YAML содержит значения по умолчанию для атрибутов Python. Поскольку имена, используемые в YAML, отображаются в ассоциированном API Python, ясно, что в этом конкретном проекте имена YAML должны подчиняться соглашению об именах Python lower_case_with_underscores
.
У моего следующего проекта может быть другое преобладающее соглашение об именах, и в этом случае я буду использовать его.
Ответ 2
Добавление в @john ответов:
Кубернеты с использованием CamelCase: https://kubernetes.io/docs/user-guide/jobs/
apiVersion
, restartPolicy
CircleCI с использованием snake_case: https://circleci.com/docs/1.0/configuration/
minitest_globs
vcs_url
, build_url
Дженкинс с тире: https://github.com/jenkinsci/yaml-project-plugin/blob/master/samples/google-cloud-storage/.jenkins.yaml
stapler-class
Таким образом, не похоже, что существует один определенный стандарт, а проекты используют свои собственные соглашения.