Sanity checking an idea for editing yaml without wanting to throw my laptop out the window
Often find myself getting frustrated editing yaml, and it seems to be used everywhere for some reason I cannot fathom
I have an idea to write an editor plugin that will, when opening a yaml file, convert it to json (or some other less painful configuration language), then convert back on save. I don't know enough about yaml syntax to know if that's possible or if there's some quirk that makes them not completely cross compatible
Or alternatively if it exists a better CLI tool for editing yaml than just a normal text editor because I'm getting sick of pasting in a block of yaml and then having to fix the 8 indentation errors that somehow spawn from that
What text editor are you using? In theory most should detect a yaml file and adjust their indentation behaviour appropriately. I edit yaml in VSCode and Kate and it's never been a problem.
Well in that case, I have good news. All valid JSON is also valid yaml. It's a superset by definition. So if you really hate yaml so much you can just write your yaml files as JSON and the parser should handle it fine. Just be aware that yaml does some more agressive typecasting when quotes are omitted, so you may need to figure out which value is actually being used when converting.
I could see some problems when working with yaml anchors, otherwise the conversion should work fine.
But yeah, using a good editor should fix most problems and would be much easier
They are basically constants where you can define reoccurring sections once and reference them multiple times throughout the file. A processor will then resolve these.
As gar as I know, there is no comparable concept in JSON so they could get lost in translation
I have an idea to write an editor plugin that will, when opening a yaml file, convert it to json (or some other less painful configuration language), then convert back on save. I don't know enough about yaml syntax to know if that's possible or if there's some quirk that makes them not completely cross compatible
You could probably do this pretty easily with a simple python script. Use the yaml parser to convert into a dictionary, use the JSON renderer to save that dictionary into a pipe file. Launch the visual editor of your choice on that file. When the editor exits, read the file as JSON, parse it back into a dictionary, and use the yaml renderer to save that dictionary back into the original file.
YAML to JSON is probably doable, JSON back to YAML not so much.
There are multiple ways to mark multiline strings in YAML. Then there are anchors, like bionicjoey mentioned. Also comments, YAML has them. You'd have to have some way to retain the extra information, if you want to make the full round trip.
Here's an example:
def-db: &def-db
# here be dragons
login: admin
passwd: nimda
prod:
db: *def-db
desc: |
I'm a teapot
short and stout
dev:
db:
<<: *def-db
passwd: pass
desc: "I'm a teapot\nshort and stout\n"
I think the difference is that it sounds they are just looking for something JSON-like, just enough to edit and save a change. It might not need to be valid.
So, a new not-a-markup-language, only human readable and editable, and objectively better than its predecessor? Well, it's all according to tradition. I believe YAML got its start the same way.
Comments are an issue I'd have to think about. Would prebuilt libraries for importing/exporting data from/to these languages not handle the multiline strings for me?
What do anchors do in yaml I've never heard of them before