What is the canonical YAML naming style

yaml conventions
John McGehee picture John McGehee · Mar 31, 2014 · Viewed 30.5k times · Source

I am designing a new YAML file, and I want to use the most standard style of naming. Which is it?

Hyphenated?

- job-name:
    ...

lower_case_with_underscores?

- job_name:
    ...

CamelCase?

- jobName:
    ...

Answer

John McGehee picture John McGehee · Sep 8, 2016

Use the standard dictated by the surrounding software.

For example, in my current project the YAML file contains default values for Python attributes. Since the names used in YAML appear in the associated Python API, it is clear that on this particular project, the YAML names should obey the Python lower_case_with_underscores naming convention per PEP-8.

My next project might have a different prevailing naming convention, in which case I will use that in the associated YAML files.

Related questions

How do you do block comments in YAML?

How do I comment a block of lines in YAML?

Read More
How do I break a string over multiple lines?

In YAML, I have a string that's very long. I want to keep this within the 80-column (or so) view of my editor, so I'd like to break the string. What's the syntax for this? In other words, I have …

Read More
How can I parse a YAML file in Python

How can I parse a YAML file in Python?

Read More