The external JSON should be easy to read, which is currently not given, as the default

I ended up with a simple flat structure: <div class="snippet-clipboard-content not

Improve JSON encoding of names datatype about haskell-names HOT 5 CLOSED

meiersi commented on July 19, 2024

Improve JSON encoding of names datatype

from haskell-names.

Comments (5)

UnkindPartition commented on July 19, 2024

It'd be useful if someone could sketch a desired encoding...

from haskell-names.

meiersi commented on July 19, 2024

I meant to avoid encoding tuples as arrays, and use objects with named fields instead. Us is standard, the names of the individual fields should describe their content.

from haskell-names.

UnkindPartition commented on July 19, 2024

So, for example:

origName -> original-name
SymValue -> value, SymConstructor -> constructor etc.

Is this okay? Any better suggestions?

from haskell-names.

meiersi commented on July 19, 2024

I would suggest to only get rid of the top-level tuple and names the components values and types. That was all that prompted this issue on my side. Here's an example of the output I would expect.

{ values:
    [
        {
            "SymValue": {
                "fixity": null, 
                "origName": {
                    "module": "Data.List", 
                    "name": "words"
                }
            }
        }, 
        {
            "SymMethod": {
                "className": {
                    "module": "Data.String", 
                    "name": "IsString"
                }, 
                "fixity": null, 
                "origName": {
                    "module": "Data.String", 
                    "name": "fromString"
                }
            }
        }
    ], 
  types:
    [
        {
            "SymType": {
                "fixity": null, 
                "origName": {
                    "module": "GHC.Base", 
                    "name": "String"
                }
            }
        }, 
        {
            "SymClass": {
                "fixity": null, 
                "origName": {
                    "module": "Data.String", 
                    "name": "IsString"
                }
            }
        }
    ]
}

from haskell-names.

UnkindPartition commented on July 19, 2024

I ended up with a simple flat structure:

[
  {
    "fixity": null,
    "class": {
      "name": "Show",
      "module": "GHC.Show"
    },
    "origin": {
      "name": "show",
      "module": "GHC.Show"
    },
    "entity": "method"
  },
  {
    "fixity": null,
    "origin": {
      "name": "Show",
      "module": "GHC.Show"
    },
    "entity": "class"
  }
]

from haskell-names.

Recommend Projects