YAML awesomeness

A curated list of YAML resources. Inspired by the awesome. See also Awesome Yaml (@datatxt)

• awesome-yaml
  • Overview
    • YAML is underrated
    • YAML is a supserset of JSON
• Digging in
  • Advanced
  • Alternatives
  • Annoyances
  • Cloud
  • Critique
  • Documentation and resources
  • GUI
  • Mentions
  • NoCode
  • Parsers
  • People
  • Projects
  • Security
  • Specification
  • Templating
  • Tools
  • Transformation
  • Variables
    • Variables (example workarounds)
  • Validation
  • Tutorial
  • YAML GISTS
  • YAML Gems
  • Searches
  • See also
    • Aweseomeness
    • Github
  • 💀 R.I.P.

awesome-yaml

Overview

YAML is a configuration format similar to JSON.

• YAML Online
• YAML Specfication v1.2
• YAML Cheatsheet
• YAML Cheatsheet
• YAML Wikipedia

YAML is underrated

• Some developers who use it had a negative first-impression of the format, usually because of the syntax.
• Some dislike the fact that YAML allows the use of indentation for specifying scope (although indentation is technically not required).
• Some consider YAML to be superfluous: "XML and JSON fit the bill nicely enough".
• Some have either never heard of YAML or are influenced by the fact that it is (or at least was) not as famous as JSON or XML.

YAML is a supserset of JSON

• Does JSON support comments? ... NO
  • http://stackoverflow.com/questions/244777/can-i-use-comments-inside-a-json-file
  • http://stackoverflow.com/questions/26775073/how-to-add-comments-in-json-file
  • http://stackoverflow.com/questions/11195101/add-json-file-comments
• Does JSON support comments? ... YES (if you use YAML)
  • To get JSON with comments, just use YAML instead of JSON
  • YAML is a superset of JSON

## This is valid YAML syntax
## Try it out now by copy-pasting it into an online YAML parser
## (e.g., http://yaml-online-parser.appspot.com/)

{
 "json": [
   "fat and rigid"
 ],
 "yaml": [
   "skinny and flexible"
 ],
 "object": {
   "array": [
     {
       "null_value": null
     },
     {
       "boolean": true
     },
     {
       "integer": 1
     }
   ]
 }
}

• Try it now!

Digging in

Advanced

• Advanced YAML features (@cyklo)

Alternatives

• Alternatives compared
  • Comparison of config formats (@njsmith)
  • Comparison of config formats (blogpost)
  • Structured text tools (@dbohdan)
• Alternatives (one-off competing)
  • ArchieML
  • dhall-lang
  • Hjson
  • HOCON
  • JSON various (@burningtree)
  • jsonnet
  • NestedText
  • NixOS Operating System
    • NixOS YouTube
  • TOML
• Variants
  • Strict YAML uses a subset of the full YAML specification.

Annoyances

• Parsers Consistently bad parsing of YAML

Cloud

• Azure Pipeline

Critique

• Blog post -- Blog post
• NBWTWY -- Blog post Nobody wants to write yaml
• YAML sucks -- Github
• YAML test matrix -- Validators

Documentation and resources

• Discussion Archives
• Stackoverflow
• YAML Multiline

GUI

• DDG Search

Mentions

• After XML JSON then what?
• blog entry praising YAML over JSON
• drupal convert
• Flextype
• Hacker News
• HackerNews JSON/XML comparison
• kubernetes
• Statamic CMS

NoCode

• NoCode and LowCode
• Lowdefy - An open-source low-code framework to build internal tools, web apps, admin panels, BI dashboards, workflows, and CRUD apps with ease by simply writing YAML.

Parsers

• Dynamic YAML -- childish
• golang
• javascript
  • http://nodeca.github.io/js-yaml/
• Node.js
• R
• shell
• yay
• YAML Syntax Checker (Linter)
  • https://www.maxoberberger.net/blog/2017/04/yaml-syntaxcheck.html

People

• [email protected]
• top users stackoverflow

Projects

• ADA YAML with focus on YAML 1.3
• Amazon ALEXA
• ANSIBLE ansible uses YAML
• Code Beautify
• Dynamic YAML -- childish
• Go language golang-specific
• Heat Openstack
• Kubernetes uses YAML
• Python-Related
• Repoze
• Spiff (on-hold as of 2017-08)
• Sublime YAML Macros
• YAML Official
• Yamlinc
• YAMLForm-Drupal8
  • YAMLForm-Blog post

Security

• Norway Problem
• Ruby exploit

Specification

• Merge-keys spec
• Official site
• YAML Test Matrix
• YAML test suite

Templating

• Ansible-based YAML plus Jinja
• gomplate -- golang templating system that supports YAML
• Ruby-based YAML plus Ruby
• Tempered YAML plus Bash
• Yasha YAML plus Jinja
• Yglu Structural YAML templating and processing
• YST YAML plus Haskell
• ytt YAML Templating Tool. Templating and patching, together. Includes Python-like programming environment.
• Zenbu YAML plus Jinja

Tools

• Tools and services (@datatxt)
• YAML parser (appspot.com)
• YAML to golang

Transformation

• AdaYaml Transforms
• dasel - Query and update data structures using selectors from the command line. Comparable to jq / yq but supports JSON, YAML, TOML and XML with zero runtime dependencies.
• DDG Search
• Online transformation tools
• JMESPath technically a JSON tool, but powerful enough to be relevant here
  • JMESPath extensions

Variables

• Dynamic YAML -- childish
• Variable placeholders in YAML

Variables (example workarounds)

• Blog post on bash

Validation

• Cerberus validation package for Python
• Copper
• DDG Search
• kube-score
• Kubeval
• learnk8s -- blog post

Tutorial

• YAML introduction
• YAML learnxinyminutes
• YAML Primer
• YAML Primer
• YAML tutorial

YAML GISTS

• YAML succinct tutorial from user:ddlsmurf

YAML Gems

• Using YAML custom tags (Advanced)

Searches

• YAML placeholder variables
• YAML shell

See also

Aweseomeness

• Awesome YAML (datatxt)
• Awesome home assistant
• Awesome curated
• Awesome manifesto
• Awesome contributions
• Awesome JSON
• Ansible Jinja addon filters

Github

• GH Topic Code Generation
• GH Topic YAML

💀 R.I.P.

• DEPRECATED -- Stackoverflow Documentation
• Dynamic YAML -- dreftymac
• golang JSON and YAML gotchas