noyaml
yq
noyaml | yq | |
---|---|---|
9 | 66 | |
416 | 10,872 | |
- | - | |
5.3 | 9.2 | |
2 months ago | 4 days ago | |
CSS | Go | |
GNU Affero General Public License v3.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
noyaml
-
Kubernetes Through the Developer's Perspective
Most commonly written in YAML, these files are large and complex to read and understand. And being written in YAML comes with its challenges (and quirks) since it is an additional programming language that devs need to learn.
-
JSON Canvas โ An open file format for infinite canvas data
YAML is kind of like C++:
> You like C++ because you're only using 20% of it. And that's fine, everyone only uses 20% of C++, the problem is that everyone uses a different 20% :)
https://eli.thegreenplace.net/2009/10/17/the-c-bashing-seaso...
The YAML footguns are too numerous to reproduce here, so here are some sources:
https://stackoverflow.com/questions/3790454/how-do-i-break-a...
https://www.arp242.net/yaml-config.html
https://noyaml.com/
-
Why the fuck are we templating YAML? (2019)
Relevant: https://noyaml.com/
YAML and its ecosystem is full of footguns and ergonomics problems, especially when the length of the document extends beyond the height of a user's editor or viewport. Loss of context with indentation, non-compliant or unsafe parsers, and strange boolean handling to name a few.
It becomes even worse when people decide that static YAML data files should have variable substitution or control flow via templating. "Stringly-typed programming" if you will. If we all started writing JSON text templates I think a lot of people would rightly argue we should write small stdlib-only programs in Python, Typescript, or Ruby to emit this JSON instead of using templated text files. Then it becomes apparent that the YAML template isn't a static data file at all, but part of a program which emits YAML as output. We're already exposing people to basic programming if we're using YAML templates. People brew a special kind of YAML-templated devops hell using tools like Kustomize and Helm, each of which are "just YAML" but are full of idiosyncracies and tool-specific behaviour which make the use of YAML almost coincidental rather than a necessity.
Yes, sometimes people would prefer to look at YAML instead of JSON, in which case I suggest you use a YAML serialization library, or pipe output into a tool like `yq` so you can view the pretty output. In a pinch you could even output JSON and then feed it through a YAML formatter.
The Kubernetes community seems to have this penetrating "oh, it's just YAML" philosophy which means we get mediocre DSLs in "just YAML" which actually encode a lot of nuanced and unintuitive behaviour which varies from tool to tool.
Look at kyverno, for examle: it uses _parentheses_ in YAML key names to change the semantics of security policies! https://kyverno.io/docs/writing-policies/validate/ . This is different to what I think is the (much better ideas of) something like kubewarden, gatekeeper, or jspolicy, which allow engineers to write their policies in anything that compiles to WASM, OPA, and Typescript/Javascript respectively.
We engineers, as a discipline, have decades of know-how building and using general purpose programming languages with type checkers, linters, packaging systems, and other tools, but we throw them all away as soon as YAML comes along. It's time to put the stringified YAML templates away and engage in the ecosystem of mature tools we already to use to perform one simple task they are already good at: dumping JSON on stdout.
Let's move the control flow back into the tool and out of the YAML.
-
YAML's homepage is displayed in YAML
The webpage documenting some of the sharp edges of yaml is also displayed as an editable yaml document
https://noyaml.com/
-
stopDoingJson
Itโs the least secure config format, even worse than XML IMO since itโs unsafe even with trusted inputs. https://noyaml.com/
- That's a Lot of YAML
yq
-
Show HN: Flatito, grep for YAML and JSON files
What I often use to just get the full key paths is yq (https://github.com/mikefarah/yq), piping into grep when necessary
yq -o=props
- K8s Service Meshes: The Bill Comes Due
- Using facts and the GitHub API in Ansible
- FLaNK 25 December 2023
-
Command line tools I always install on Ubuntu servers
For more information about this command visit https://github.com/mikefarah/yq
-
Runtime error with plugin that uses io.popen to run executable during plugin startup
I've been trying to install and config a plugin (papis.nvim) for a couple of days and am having issues with a function that uses io.popen to run yq to convert yaml files to json. I know my install of yq is fine- I can run yq -oj info.yaml from the command line with no issue and it produces the correct json output. I know the function can find the yq executable, but it returns nil. I've saved the error from the yq golang code: panic: runtime error: invalid memory address or nil pointer dereference
-
Jaq โ A jq clone focused on correctness, speed, and simplicity
- yq has no if-then-else https://github.com/mikefarah/yq/issues/95 which is a poor design (or omission) in my opinion
-
HTTPie Desktop: cross-platform API testing client for humans
After which, I use openapi-generator to make a yaml output.
https://gist.github.com/freshteapot/3637e8d2b5ecdf01b7d25246...
- yq version 3.4.1 (Worth noting, the example uses an out of date yq, so a few modifictaions might be needed)
https://github.com/mikefarah/yq
-
jq 1.7
For those pining for a similar yaml query tool for working through acres of config: https://github.com/mikefarah/yq
jq is awesome and thanks to the new team for their recent efforts and energy, it massively appreciated.
-
That's a Lot of YAML
For anyone looking for such a script, there's some CLIs that make it easy. One is `yq -o props` [1], another way is to use `yq -j` or `yj` [2] to convert to JSON and pipe it to `gron` [3].
[1] https://github.com/mikefarah/yq
[2] https://github.com/sclevine/yj
[3] https://github.com/tomnomnom/gron
What are some alternatives?
yj - CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.
yq - Command-line YAML, XML, TOML processor - jq wrapper for YAML/XML/TOML documents
hjson - Hjson, a user interface for JSON
jq - Command-line JSON processor [Moved to: https://github.com/jqlang/jq]
doximus - static, smart and developer friendly API documentation generator
yaml.nvim - ๐ YAML toolkit for Neovim users
json2jsii - Generates jsii-compatible structs from JSON schemas
csvq - SQL-like query language for csv
PyYAML
oq - A performant, and portable jq wrapper to facilitate the consumption and output of formats other than JSON; using jq filters to transform the data.
crd-to-sample-yaml - Generate a sample YAML file from a CRD
miller - Miller is like awk, sed, cut, join, and sort for name-indexed data such as CSV, TSV, and tabular JSON