FracturedJson

(github.com)

124 points | by PretzelFisch 2 hours ago

9 comments

  • simonw 39 minutes ago
    It looks like there are two maintained implementations of this at the moment - one in C# https://github.com/j-brooke/FracturedJson/wiki/.NET-Library and another in TypeScript/JavaScript https://github.com/j-brooke/FracturedJsonJs. They each have their own test suite.

    There's an older pure Python version but it's no longer maintained - the author of that recently replaced it with a Python library wrapping the C# code.

    This looks to me like the perfect opportunity for a language-independent conformance suite - a set of tests defined as data files that can be shared across multiple implementations.

    This would not only guarantee that the existing C# and TypeScript implementations behaved exactly the same way, but would also make it much easier to build and then maintain more implementations across other languages.

    Interestingly the now-deprecated Python library does actually use a data-driven test suite in the kind of shape I'm describing: https://github.com/masaccio/compact-json/tree/main/tests/dat...

    That new Python library is https://pypi.org/project/fractured-json/ but it's a wrapper around the C# library and says "You must install a valid .NET runtime" - that makes it mostly a non-starter as a dependency for other Python projects because it breaks the ability to "pip install" them without a significant extra step.

  • DJBunnies 10 minutes ago
    While I wish JSON formally supported comments, it seems more sensible (compatible) to just nest them inside of a keyed list or object as strings.

      {
        foo: "bar",
        ans: 42,
        comments: {
          ans: "Douglas Adams"
        }
      }
  • polshaw 1 hour ago
    Is there an option for it to read the contents from a pipe? that's by far my biggest use for the jq app.
    • simonw 46 minutes ago
      There's a C# CLI app in the repo: https://github.com/j-brooke/FracturedJson/blob/main/Fracture...

        Output is to standard out, or a file specified by the --outfile switch.  Input is from either standard in, or from a file if using the --file switch
      
      It looks like both the JavaScript version and the new Python C# wrapper have equivalent CLI tools as well.
    • tuetuopay 56 minutes ago
      this would be amazing to be chained with jq, that was my first thought as well.
  • barishnamazov 1 hour ago
    This is pretty cool, but I hope it isn't used for human-readable config files. TOML/YAML are better options for that. Git diff also can be tricky with realignment, etc.

    I can see potential usefulness of this is in debug mode APIs, where somehow comments are sent as well and are rendered nicely. Especially useful in game dev jsons.

    • actionfromafar 32 minutes ago
      Yaml is the worst. Humans and LLMs alike get it wrong. I used to laugh at XML but Yaml made me look at XML wistfully.

      Yaml - just say Norway

      • airstrike 16 minutes ago
        The Norway issue is a bit blown out of proportion seeing as the country should really be a string `"no"` rather than the `no` value
    • silvestrov 50 minutes ago
      Just say Norway to YAML.
      • merelysounds 34 minutes ago
        This is a reference to YAML parsing the two letter ISO country code for Norway:

            country: no
        
        As equivalent to a boolean falsy value:

            country: false
        
        It is a relatively common source of problems. One solution is to escape the value:

            country: “no”
        
        More context: https://www.bram.us/2022/01/11/yaml-the-norway-problem/
        • Y-bar 11 minutes ago
          We stopped having this problem over ten years ago when spec 1.1 was implemented. Why are people still harking on about it?
          • actionfromafar 6 minutes ago
            Now add brackets and end-tags, I'll reconsider. ;)
  • shiandow 52 minutes ago
    This looks very readable. The one example I didn't like is the expanded one where it expanded all but 1 of the elements. I feel like that should be an all or norhing thing, but there's bound to be edge cases.
  • frizlab 1 hour ago
    This is interesting. I’d very much like to see a code formatter do that kind of thing; currently formatters are pretty much inflexible, which makes getting structure out of a formatted code sometimes hard.
    • thechao 50 minutes ago
      I just built a C++ formatter that does this (owned by my employee, unfortunately). There's really only two formatting objects: tab-aligned tables, and single line rows. Both objects also support a right-floating column/tab aligned "//" comment.

      Both objects desugar to a sequence of segments (lines).

      The result is that you can freely mix expression/assignment blocks & statements. Things like switch-case blocks & macro tables are suddenly trivial to format in 2d.

      Because comments are handled as right floating, all comments nicely align.

      I vibe coded the base layer in an hour. I'm using with autogenerated code, so output is manually coded based on my input. The tricky bit would be "discovering" tables & block. I'd jus use a combo of an LSP and direct observation of sequential statements.

    • barishnamazov 1 hour ago
      Right. In my previous work, I wrote a custom XML formatter for making it look table-like which was our use case. Of course, an ideal solution would have been to move away from XML, but can't run away from legacy.
  • damnitbuilds 1 hour ago
    Nice.

    And BTW, thanks for supporting comments - the reason given for keeping comments out of standard Json is silly ( "they would be used for parsing directives" ).

    • Xymist 1 hour ago
      It's a pretty sensible policy, really. Corollary to Hyrum's Law - do not permit your API to have any behaviours, useful or otherwise, which someone might depend on but which aren't part of your design goals. For programmers in particular, who are sodding munchkins and cannot be trusted not to do something clever but unintended just because it solves a problem for them, that means aggressively hamstringing everything.

      A flathead screwdriver should bend like rubber if someone tries to use it as a prybar.

      • mystifyingpoi 25 minutes ago
        > A flathead screwdriver should bend like rubber if someone tries to use it as a prybar.

        While I admire his design goals, people will just work around it in a pinch by adding a "comment" or "_comment" or "_comment_${random_uuid}", simply because they want to do the job they need.

        If your screwdriver bends like a rubber when prying, damn it, I'll just put a screw next to it, so it thinks it is used for driving screws and thus behaves correctly.

      • nodja 32 minutes ago
        On one hand, it has made json more ubiquitous due to it's frozen state. On another hand, it forces everyone to move to something else and fragments progress. It would be much easier for people to move to json 2.0 rather than having hundreds of json + x standards. Everyone is just reinventing json with their own little twist that I feel sad that we haven't standardized to a single solution that doesn't go super crazy like xml.

        I don't disagree with the choice, but seeing how things turned out I can't just help but look at the greener grass on the other side.

      • libria 26 minutes ago
        > A flathead screwdriver should bend like rubber if someone tries to use it as a prybar.

        Better not let me near your JSON files then. I pound in wall anchors with the bottom of my drill if my hammer is not within arms reach.

    • patates 1 hour ago
      XML people were doing crazy things in the Java/.NET world and "<!--[if IE 6]>" was still a thing in HTML when JSON was being designed.

      I also would have wanted comments, but I see why Crockford must have been skeptical. He just didn't want JSON to be the next XML.

    • frizlab 1 hour ago
      Unrelated: why spaces inside the parentheses? It’s not the first time I see this, but this is incorrect!
      • cromulent 10 minutes ago
        JSON doesn't have parentheses, but it does have braces and brackets. The JSON spec specifically allows spaces.

        > Insignificant whitespace is allowed before or after any token.

        • frizlab 3 minutes ago
          I was talking about the parent comment, which has spaces inside the parenthesis (I do prefer no spaces inside brackets and braces in my JSONs, but that’s another story).
  • londons_explore 40 minutes ago
    Great. Now integrate this into every JSON library and tool so I get to see it's output more often
    • tomtomtom777 17 minutes ago
      I think integration into jq would be both powerful and sufficient.