What is the best file format for configuration file?
What is the best file format for configuration file?
.yaml, .toml, etc?
48 comments
-
I usually use Json5. It's JSON, but with all the weird quirks fixed (comments added, you can use hex numbers, you can have trailing commas etc.)
-
Oh that's interesting. Wonder how many libraries out there support it...
-
I don't know if it's actual json5, but eslint and some other libraries use extended, commentable json in their config files.
-
-
-
JSON by a mile. I hate the YAML plague, it’s some of the most unintuitive syntax I’ve seen and yet it’s everywhere in DevOps/SysOps.
-
The only thing that really annoys me about JSON is that it doesn't allow comments.
-
JSON5, bay-beee
-
-
GitHub Actions and Azure DevOps had me hating on YAML pretty quickly
-
YAML works better with git than JSON, but so much config work is copy and pasting and YAML is horrible at that.
Having something where changing one line doesn't turn into changing three lines, but you could also copy it off a website would be great.
-
-
A lot of good answers but I would add one note:
- use a format that supports comments, and JSON is not one of those...
-
I believe the JSON deserializer .NET ships with has options to allow C#-style comments in JSON files.
-
JSON5 is a superset of JSON that supports comments.
-
json with comments can be parsed by a yaml parser. It's how I write yaml, in fact (yaml is a superset of json. any valid json is valid yaml, but it also supports comments)
-
It depends what you need your configuration file to be:
Need a well defined easy to understand concrete configuration file?
- Use
.toml. It was made to be both human and computer friendly while taking special attention to avoid the pitfalls commonly found in other configuration files by explicitly stating expected types around commonly confused areas.
Need a simple to implement configuration file?
- Use
.json. It's famous for being so simple it'screator"discoverer" could define it on a business card.
Need an abstract configuration file for more complicated setups?
- Use
.ncl. Nickle allows you to define functions so that you can generate/compute the correct configuration by changing a few variables/flags.
- Use
-
.ini
ducks
-
Give the windows registry a shot.
-
-
Yaml for me, I really like it. And the fact that every valid JSON is also a valid YAML is nice.
-
YAML here as well.
Configuration many levels deep gets so much harder for me to read and write in JSON with all [], {} and ""
Also the lack of comments... And YAML still is more used in software I'm using than JSON5, so I'd rather skip yet another format/library to keep track of.
-
Please do not use YAML. It's a syntactic minefield. It also doesn't allow tab indentation, which is supremely irritating.
-
As I said, I like it the most, so I will use it. I like its syntax (except for yes and no for booleans, but nothing's perfect). I don't care much for tabs vs spaces, I use tab in my IDE and whatever it does, it does.
-
-
-
It's like yaml but simple, consistent, untyped, and you never need to escape any characters, ever.
Types and validation aren't going to be great unless they're in the actual code anyway.
-
No reason to go beyond simple key-value format like dotenv or just env variables. If you need more structure then maybe you are confusing configuration with state and this is not really the same thing.
-
The one with a validator provided to the user.
-
It really depends. I usually prefer json. It's easily understandable from humans and from machines, it doesn't depends on indentation and above everything else I like it very much 🤣
-
Depends on what you mean exactly with "file format".
If declarative functional programming falls under that, I think something like Nickel, the already mentioned Dhall or Nix. Though Nix more so for packaging and some kind of system management (NixOS?), it's not easily embeddable into a runtime (your app?). Nickel or Dhall is better for that, as they are built from ground up with that in mind, Nickel is maybe the successor of Nix as it is inspired by Dhall and Nix (one goal is to use Nickel as frontend).
The reason why I recommend a simple declarative language, is that they are IMHO much better composable as it lets the user hide boilerplate via functions. I almost always feel limited by static configuration formats like yaml, json etc..
-
Need it to be user editable in a text editor? YAML. Otherwise, JSON.
-
I think it's YAML.
I'm not happy that it's YAML but it's become ubiquitous. Sure, there are lots of other formats that others have mentioned, but I'm sorry most of them are positioned as "it's better than YAML!" and the fact that everyone is mentioning YAML, even if it's about the things it does wrong (and boy does it do things wrong) still means that YAML is on everyone's mind.
-
Whatever. Comments are helpful, which makes pure JSON a poor choice. JSON5 or JSON-C are better, but linting and static analysis are important to every form of code, so make sure that what you use for that will understand your syntax.
My current preference is generally TOML, but I've started dabbling with custom HCL2 DSLs. (I write a lot of Go and Terraform.)
-
Tyson is nice - esp. if you are already using TS/JS.
48 comments