.yaml, .toml, etc?

  • simonced@lemmy.one
    link
    fedilink
    English
    arrow-up
    16
    ·
    1 year ago

    A lot of good answers but I would add one note:

    • use a format that supports comments, and JSON is not one of those…
    • AeroLemming@lemm.ee
      link
      fedilink
      English
      arrow-up
      15
      arrow-down
      3
      ·
      1 year ago

      Of course it does!

      {
        comment: "This data is super important and it runs the system or something",
        data: ["Some", "stuff", "here"]
      }
      
        • AeroLemming@lemm.ee
          link
          fedilink
          English
          arrow-up
          1
          ·
          1 year ago

          It’s so easy to use, and you can read the comments from in your program too!

          ^(in case you weren’t just playing along, please never do comments this way)

          • simonced@lemmy.one
            link
            fedilink
            English
            arrow-up
            1
            ·
            1 year ago

            I liked the idea to be honest. I can just call the entry “description” instead and all is good ^^

            • AeroLemming@lemm.ee
              link
              fedilink
              English
              arrow-up
              2
              ·
              1 year ago

              Ideally, you would use TOML for human-readable configuration and document your JSON API with external documentation instead of sending comments around a bunch. If you need to display the description to the end user though, that would be a valid use case.

        • AeroLemming@lemm.ee
          link
          fedilink
          English
          arrow-up
          2
          ·
          1 year ago

          Please don’t actually do this. Comment stuff in the code and documentation, not the JSON.

          • sfera@beehaw.org
            link
            fedilink
            arrow-up
            1
            ·
            1 year ago

            Don’t worry, I wouldn’t do things like this in JSON. Nevertheless, it can be very useful to have comments along with configuration values, for example to explain the actual values (not their purpose) and why they were chosen. That’s information you can’t add to the code which processes the values.

    • vrighter@discuss.tchncs.de
      link
      fedilink
      arrow-up
      2
      arrow-down
      1
      ·
      1 year ago

      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)