SOML – A Config Format for Humans

(github.com)

53 points | by microflash 4 hours ago

25 comments

  • layer8 2 hours ago
    > what you see is what you get: […] '10.20' and 10.20 are a string and a float, exactly as written.

    This seems both underspecified and incorrect. Assuming a single-precision binary IEEE 754 floating-point number, 10.20 is actually 10.19999980926513671875. With double precision, it would be 10.199999999999999289457264239899814128875732421875. So what you see is not what you get, and it’s also unclear what exactly you’ll get.

    > A value's type comes from its syntax, never from its content […] allowed-origins: [ 'https://example.com' 'https://example.org' ]

    This looks like URLs, but are strings. What if you had:

    > allowed-origins: [ 'httpș://example.com' 'ħttps://example.org' ]

    Still strings and therefore fine for the SOML parser, but probably not a valid configuration in terms of the application-level types of the values. The syntax telling you the types is of limited utility as soon as the application schema has more specific ideas about the types than the configuration language.

    • mofle 48 minutes ago
      > This seems both underspecified and incorrect.

      "exactly as written" was wrong for the value. Only the type is. The spec already says a float is IEEE 754 binary64, same as JSON. Fixed the readme.

      > Still strings and therefore fine for the SOML parser,

      I have plans for some kind of schema support.

      • layer8 7 minutes ago
        Schema support is the way to go, because applications will have a formal or informal schema no matter what, but then it’s better to drop most of the schemaless syntax rules in the first place. If someone wants `10.20` to mean the exact decimal value, or wants `30m` to mean “30 meters” instead of a duration, then that should be possible. Similarly, self-delimiting syntax like URLs shouldn’t require quotes.
    • qubex 52 minutes ago
      #whatcouldpossiblygowrong
    • vbezhenar 2 hours ago
      Should be 0x1.466666p+3 for clarity.
    • supersimpleguy 1 hour ago
      [flagged]
  • mofle 54 minutes ago
    Hey all. I'm the one working on this (a human). It's still early. It's something I have been wanting for many years, but I never had the time to invest in it until now.

    It's already powering the frontmatter of my website: https://github.com/sindresorhus/sindresorhus.github.com/blob...

  • lightandlight 3 hours ago
    Ironically the project seems LLM-generated.

    I don't want to read Claude's interpretation of why your project matters. I want you to tell me directly.

    • mofle 1 hour ago
      It's created by a human, me. All decisions are human-made. I obviously used AI to help double-check all the work and improve the writing.
    • functionmouse 2 hours ago
      > your project

      there's a very good chance there's no human involvement at all in this

  • ActionHank 2 hours ago
    Gotta be honest, any time there's a solution like there that makes it more "human" they've just removed the structure / syntax.

    I'm guessing so you don't need to learn them, so then anyone off the street can edit the files, but it will break so bad without those guardrails, usually in some non-obvious way.

    Leading us back to inventing some new "human" thing, but with more implicit rules, and the cycle continues.

    • econ 1 hour ago
      Have a text area that checks if the config is valid on each key stroke, if not rollback to the previous one. Can put some red ink under it explaining why you can't do that.

      Trying to remove a required number the last remaining digit is highlighted so that you can type over it.

      • ActionHank 54 minutes ago
        "Have a text area"

        You've already failed. Config files are for more than just editing in an environment that you solely control.

    • nine_k 1 hour ago
      > just removed the structure / syntax.

      But they added syntax, such as unit specifiers for time.

      And some syntax, like YAML bare strings, or XML entities referring to external resources, has to be removed.

  • joshheitzman 2 hours ago
    From the comments here I can infer that it has a schema and in turn I can extrapolate that this is as much "for humans" as many other config formats that are deterministically parseable.

    A GUI is a config format for humans as it can you show what all of the configuration options are along with text that tells you what they do. A GUI can also ensure that there are no invalid settings that are discovered separately from the edit session (sure it may not do so, but it has the possibility unlike whatever random text editor the user opens the config in).

  • james_marks 3 hours ago
    From the title, I thought this was a specification for configuring humans. I don't quite know what that means, and I'm disappointed still not to know.
    • VTimofeenko 2 hours ago
      Could probably compile it into CRISPR editing spec
  • tln 1 hour ago
    Feedback:

    1. You should mention TOML in your first paragraph. "Why not TOML" exists at the end

    2. how often are "instants"/dates really specified? Are you baking this in for TOML parity?

    If you want leaner, drop this. If nothing else it's a lot of grammar.

    If you want to lean in to "A value's type comes from its syntax", I'd suggest taking a cue from postgres and JS -- extensible literals. With JS tagged literals it would look like date`2026-09-19T14:00:00Z`. Conforming readers can fall back.

    I'd use ver`3.1.0` 1000x more in config files than dates... I do like durations being baked in though.

    Solid improvements over TOML and YAML.

    • nine_k 1 hour ago
      Instants are important if you migrate something, like TLS certificates, data flows, etc. ISO-8601 is widely adopted, unambiguously interpreted, human-friendly format for that. I see no reason to not have it.
      • tln 43 minutes ago
        Is this format for data or for config?

        The reason for not having is simply a matter of specification size. ISO-8601 is full of weirdness! SOML's date spec is reasonable looking but there is still a lot of nuance.

        Having durations is nice and instants are highly complementary. My feedback is just that if lots of literal formats are desired, maybe an extensible literal format!

  • yegle 51 minutes ago
    Genuine question for TOML (or any config DSL that don't support inheritance) users: what's the advantage compared to text protobuf configs?

    To me being able to do some templating/inheritance to generate slightly different config (or deviating from the standard/default config) seems to be vital as a config DSL. In that regard, even YAML is superior with its half-ass anchor thingy.

  • Yasuraka 2 hours ago
    > no key needs quotes

    > 'the name': 'quotes are the escape hatch, when a key needs spaces'

    To quote David Fincher:

    > They know you have computers and can show a Tyrannosaurus Rex eat a car, so they know you can do anything. The question is: what don't you do, not what do you do.

    Constraints liberate; I wish people tended to more strictness. I had plenty of stumbling over "features", asking myself who couldve ever needed them. This particular one also irked me about CUE.

    But that's just a nit.

    • walthamstow 1 hour ago
      Love the Fincher quote. That escape hatch thing is such a Claudism.
  • andyferris 1 hour ago
    I get some of this... but the argument around versions like 3.10 being footguns in YAML apply here too - in both YAML and SOML both you want to quote that as a string. (I suppose in SOML the user might be used to quoting strings, but in both cases you'd still want your application-level parser to reject floats for that field for safety's sake).
  • catlifeonmars 2 hours ago
    There are numerous inaccuracies in the “Why not TOML” section of the README. Here are a few:

    > CVE-2026-44244 injected a [core] section into .git/config for code execution.

    Git config is not TOML. It’s an ini-based bespoke syntax

    > SOML needs quotes for a literal dot.

    So does TOML, the dot notation is for nested keys. You use quotes for a literal dot.

    ——

    FWIW I like the decision to have a first class duration type.

    • mofle 37 minutes ago
      Git config indeed isn't TOML, but it's the same trick; a newline adds a section header in any line-oriented config.

      TOML needs quotes too. But if you forget them, TOML nests silently, while SOML errors.

      I have updated the readme to make these things more clear.

  • yoyohello13 1 hour ago
    Isn't every configuration format made for humans? In fact, every programming language was made for humans.
    • ModernMech 1 hour ago
      In a reductive sense, yes. But practically, sometimes design considerations are made so the language is easier to parse or implement, which at the same time make it harder for humans to parse and understand. When someone says it's "made for humans" they mean they decided to make it easier for humans to read and write, often with the tradeoff that the parser and compiler will be more complicated.
  • umvi 2 hours ago
    > durations like 30s are real values, so nobody has to guess the unit of timeout: 30

    Pet peeve of mine, but I would argue that it's better to always keep units baked into the key.

    If you have:

       timeout_s: 30
    
    Then unit information will never be lost, because the unit is always marshalled as a part of the key name and you don't have to worry if the target language has a duration type or not.

    If you have:

       timeout: 30s
    
    Then unit information probably won't be lost, but could in the following scenarios:

    - Target language doesn't have duration types (looking at the list - Ruby?)

    - If you ever need to convert to/from a data format without durations like JSON

    So basically you have to use SOML across your entire stack and always use languages that have native duration types, and also you have to be careful never to convert SOML to/from JSON (which is highly likely if you ever have to interface with external APIs). Do any of those things and you'll likely run into a unit confusion scenario at some point.

    But there are going to be lots of configs that won't have native type like size. Again, just include units in key:

        max_size_bytes: 30000000
    
    In conclusion, my opinion is to KISS by including units in the key name and by sticking to bool/number/string primitives, hence why I almost always use JSON for everything (though if I could be granted one wish, it would be for JSON spec to allow for dangling commas)
    • vbezhenar 2 hours ago
      `timeout: 72h` reads better than `timeout_s: 6220800`
      • umvi 1 hour ago
        I agree, but there's a tradeoff which is that not every language/data format supports duration types:

        Ruby:

            config = SOML.load_file('config.soml', symbolize_names: true)
            config[:timeout] # what are the units? uses SOML::Duration non-Ruby type
        
        Even worse if you ever convert to/from JSON. My opinion is that config files should be as dumb and simple as possible. If you want humans to be able to read/write fancy stuff like "72h" for config, build a UI layer for the human to use in front of the config. Then they can click a little calendar icon to select the date. The backing config uses dumb iso 8601 string instead of a magical date type baked into the config language.
  • sedatk 1 hour ago
    People who research new configuration formats should take a look at PSD1 too: https://ssg.dev/powershell-accidentally-created-a-nice-confi...
    • Diti 1 hour ago
      I found out about this format because of PowerShell DSC (the Microsoft equivalent of Ansible). The format itself is very neat, but the `Import-PowerShellDataFile` cmdlet is absolutely unhelpful at showing you where the error is if it cannot parse the PSD1 file.
      • sedatk 1 hour ago
        Ouch. I'm surprised that it's still the case after so many years.
  • priomsrb 2 hours ago
    Looks nice!

    It would be great if you had a simple website that allowed you to enter SOML and see the JSON side-by-side (similar to typescript playground https://www.typescriptlang.org/play/).

    • mofle 23 minutes ago
      This is definitely planned.
  • CodesInChaos 3 hours ago
    What I'm missing:

    1. The readme doesn't make it clear what its "float" type is. A double, a decimal, implementation defined. I'm generally not a fan of restricting numbers to what a double can represent, like toml does.

    2. It doesn't have a good way to model key-value pair like types such as tagged unions, polymorphic types, or function invocations. Simply allowing a key-value pair as a value (right associative) where the key is a string matching the keys of an object would fix this. Alternatively a function call syntax would fix this, which would also enable tuples as a concept distinct from arrays.

    • mofle 29 minutes ago
      1. It's in the spec. It's a binary64 double.

      2. These are schema and app concerns. Schema is something I plan to tackle.

    • bjacobso 2 hours ago
      The tagged-union / function-call point is where I keep ending up too. Once a config needs “one of these shapes” or “this thing with these arguments”, data formats grow conventions on top (type: keys, YAML !tags, $ref), and every consumer reimplements them.

      I’ve been building Forma (https://forma-lang.com), a small typed Lisp aimed at that zone. Everything is (head args...), so a tagged value and a call are the same syntax, and you declare the vocabulary yourself:

        (job nightly-export
          :schedule "0 3 * * *"
          :retry (backoff :max 5))
      
      job and backoff are forms you define with typed holes. The checker reports errors at the line you wrote, even after macro expansion. The output is plain JSON (or generated Effect TypeScript, but could target any language), so the app reading it doesn’t embed the language.
  • stonyrubbish 1 hour ago
    • ModernMech 1 hour ago
      This is not relevent, as there's no proposed standard here, nor any reason everyone should standardize on a particular config format.
  • jll29 3 hours ago
    Looks like Windows *.ini format except ":" instead of "="...
    • CodesInChaos 3 hours ago
      Not really. INI has a fixed structure (section>key>value) and its values are untyped.
  • arionmiles 3 hours ago
    See also: HUML [1]

    1: https://huml.io/

  • drvd 3 hours ago
    So a stripped down variant of cue? Why not use cue directly?
    • brianm 3 hours ago
      Cue only really exists in go, and has a dependency chain to make maven weep.

      I think cue is better thought of as a language you use to generate JSON (or yaml, or, let's be honest, k8s flavored yaml) configs rather than a config language you use in your app.

  • petre 2 hours ago
    We already have TOML and it's great. I can seamlessly upgrade from ini to toml.
    • catlifeonmars 2 hours ago
      TOML is probably my go-to these days.

      I think where TOML shines is when your configuration schema is relatively flat and simple. If you want to heavily nest configuration it can quickly get difficult to read. I’d love a more limited version of TOML that restricts the nesting depth.

    • microflash 2 hours ago
      There's a comparison [0] where some differences are explained.

      [0]: https://github.com/soml-lang/soml/blob/main/comparison.md

  • esafak 3 hours ago
    Can you add README sections for the schema and supported types?
  • paulddraper 3 hours ago
    > Top-level arrays. A TOML file is always a table, so a list of records needs a wrapper key.

    I'm curious for example configs that are top-level lists?

    • priomsrb 2 hours ago
      One example could be something that's a list of files/folders e.g. .gitignore

      Or it could be a list of records:

      {name: 'Alice', age: 42}

      {name: 'Bob': age: 44}

  • sscaryterry 2 hours ago
    We really don't need yet another format.
  • hk1337 1 hour ago
    yet another format? https://xkcd.com/927/