Quel est le style canonique de nommage YAML?
je suis en train de concevoir un nouveau fichier YAML, et je veux utiliser le style de nommage le plus standard. Qui est-il?
avec un trait D'Union?
- job-name:
...
lower_case_with_underscores?
- job_name:
...
CamelCase?
- jobName:
...
2 réponses
Utilisez le standard dicté par le logiciel environnant.
par exemple, dans mon projet actuel, le fichier YAML contient des valeurs par défaut pour les attributs Python. Puisque les noms utilisés dans YAML apparaissent dans L'API Python associée, il est clair que sur ce projet particulier, les noms YAML doivent obéir au Python lower_case_with_underscores convention de nommage selon PEP-8.
mon prochain projet pourrait avoir une autre convention de nommage en vigueur, auquel cas je vais utiliser cela dans le YAML files.
ajouter à @ john's réponses:
Kubernetes à l'aide de CamelCase: https://kubernetes.io/docs/user-guide/jobs/
apiVersion,restartPolicy
CircleCI à l'aide de snake_case: https://circleci.com/docs/1.0/configuration/
minitest_globs vcs_url,build_url
Jenkins avec dash-case: https://github.com/jenkinsci/yaml-project-plugin/blob/master/samples/google-cloud-storage/.jenkins.yaml
stapler-class
il ne semble donc pas qu'il y ait une norme définie, et les projets utilisent leurs propres conventions.