Meme transcription:

Panel 1: Bilbo Baggins ponders, “After all… why should I care about the difference between int and String?

Panel 2: Bilbo Baggins is revealed to be an API developer. He continues, “JSON is always String, anyways…”

  • frezik@midwest.social
    link
    fedilink
    arrow-up
    1
    ·
    6 months ago

    What I’d like for a configuration language is a parser that can handle in-place editing while maintaining whitespace, comments, etc. That way, automatic updates don’t clobber stuff the user put there, or (alternatively) have sections of ### AUTOMATIC GENERATION DO NOT CHANGE###.

    You need a parser that handles changes on its own while maintaining an internal representation. Something like XML DOM (though not necessarily that exact API). There’s a handful out there, but they’re not widespread, and not on every language.

      • frezik@midwest.social
        link
        fedilink
        arrow-up
        2
        ·
        6 months ago

        Is a very good idea providing much needed fixes to the JSON spec, but isn’t really what I’m getting at. Handling automatic updates in place is a software issue, and could be done on the older spec.

        • bitfucker@programming.dev
          link
          fedilink
          arrow-up
          2
          ·
          6 months ago

          Hmm, maybe I am missing the point. What exactly do you mean by handling automatic updates in place? Like, the program that requires and parses the config file is watching for changes to the config file?

          • frezik@midwest.social
            link
            fedilink
            arrow-up
            2
            ·
            edit-2
            6 months ago

            As an example, Klipper (for running 3d printers) can update its configuration file directly when doing certain automatic calibration processes. The z-offset for between a BLtouch bed sensor and the head, for example. If you were to save it, you might end up with something like this:

            [bltouch]
            z_offset: 3.020
            ...
            #*# <---------------------- SAVE_CONFIG ---------------------->
            #*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
            #*#
            [bltouch]
            z_offset: 2.950
            

            Thus overriding the value that had been set before, but now you have two entries for the same thing. (IIRC, Klipper does comment out the original value, as well.)

            What I’d want is an interface where you can modify in place without these silly save blocks. For example:

            let conf = get_config()
            conf.set( 'bltouch.z_offset', 2.950 )
            conf.add_comment_after( 'bltouch.z_offset', 'Automatically generated' )
            conf.save_config()
            

            Since we’re declaratively telling the library what to modify, it can maintain the AST of the original with whitespace and comments. Only the new value changes when it’s written out again, with a comment for that specific line.

            Binary config formats, like the Windows Registry, almost have to use an interface like this. It’s their one advantage over text file configs, but it doesn’t have to be. We’re just too lazy to bother.