Raw sassdoc data is not valid JSON

[alademann]

@hugogiraudel According to this section in the readme, the raw data is made available.

However - I am unable to easily create a JSON file out of this, because the output is not valid JSON. Some key values are single-quoted, some have no quotes at all.

For instance - nothing happens when I try this:

sassdoc.parse('./sass').then(function (items) {
    console.log(JSON.stringify(items));
});

And the raw data itself - looks like this: (Which even the syntax highlighter github is using recognizes as invalid JSON)

{ 
    variable: { 
        'breakpoint-no-query-fallbacks': { 
            description: '',
            context: [Object],
            type: [Object],
            since: [Object],
            requires: [Object],
            link: [Object],
            access: [Object],
            group: [Object],
            file: [Object] 
        },
        'font-size-xs': { 
            description: '',
            context: [Object],
            type: [Object],
            since: [Object],
            requires: [Object],
            access: [Object],
            group: [Object],
            file: [Object] 
        },
        modules: { 
            description: '',
            context: [Object],
            ignore: [],
            access: [Object],
            group: [Object],
            file: [Object] 
        } 
    },
    mixin: { 
        'triangle-direction': { 
            description: '...',
            context: [Object],
            since: [Object],
            requires: [Object],
            parameters: [Object],
            throws: [Object],
            access: [Object],
            group: [Object],
            file: [Object],
            usedBy: [Object] 
        },
        triangles: { 
            description: '...',
            context: [Object],
            since: [Object],
            requires: [Object],
            parameters: [Object],
            access: [Object],
            group: [Object],
            file: [Object] 
        },
        'btn-reset': { 
            description: '...',
            context: [Object],
            since: [Object],
            requires: [Object],
            access: [Object],
            group: [Object],
            file: [Object],
            usedBy: [Object] 
        },
        'hide-text': { 
            description: '...',
            context: [Object],
            since: [Object],
            access: [Object],
            group: [Object],
            file: [Object] 
        } 
    },
    function: { 
        color: { 
            description: '...',
            context: [Object],
            access: [Object],
            since: [Object],
            requires: [Object],
            parameters: [Object],
            returns: [Object],
            group: [Object],
            file: [Object],
            usedBy: [Object] 
        },
        'state-variation-text': { 
            description: '...',
            context: [Object],
            since: [Object],
            requires: [Object],
            parameters: [Object],
            throws: [Object],
            returns: [Object],
            access: [Object],
            group: [Object],
            file: [Object] 
        } 
    } 
}

Note that keys containing - are quoted (using single quotes) - and those that do not have dashes, have no quotes. (It all should be double-quoted for valid JSON). I'm not sure if there are other reasons why the JSON is invalid, possibly quotes within the descriptions / other fields or something... but at a minimum, I would expect the raw data to return the ACTUAL objects within objects - not [Object].

As a consumer, I shouldn't have to write my own parser for the parser :)

[KittyGiraudel]

As a consumer, I shouldn't have to write my own parser for the parser :)

Agreed, it's obviously a bug. We'll see what we can do. :)

[alademann]

For the sake of clarity - here is that same example data, in a valid JSON format (excluding the contents of each [Object] - which should still be there, obviously.

{ 
    "variable": { 
        "breakpoint-no-query-fallbacks": { 
            "description": "...",
            "context": {},
            "type": {},
            "since": {},
            "requires": {},
            "link": {},
            "access": {},
            "group": {},
            "file": {} 
        },
        "font-size-xs": { 
            "description": "...",
            "context": {},
            "type": {},
            "since": {},
            "requires": {},
            "access": {},
            "group": {},
            "file": {} 
        },
        "modules": { 
            "description": "...",
            "context": {},
            "ignore": [],
            "access": {},
            "group": {},
            "file": {} 
        } 
    },
    "mixin": { 
        "triangle-direction": { 
            "description": "...",
            "context": {},
            "since": {},
            "requires": {},
            "parameters": {},
            "throws": {},
            "access": {},
            "group": {},
            "file": {},
            "usedBy": {} 
        },
        "triangles": { 
            "description": "...",
            "context": {},
            "since": {},
            "requires": {},
            "parameters": {},
            "access": {},
            "group": {},
            "file": {} 
        },
        "btn-reset": { 
            "description": "...",
            "context": {},
            "since": {},
            "requires": {},
            "access": {},
            "group": {},
            "file": {},
            "usedBy": {} 
        },
        "hide-text": { 
            "description": "...",
            "context": {},
            "since": {},
            "access": {},
            "group": {},
            "file": {} 
        } 
    },
    "function": { 
        "color": { 
            "description": "...",
            "context": {},
            "access": {},
            "since": {},
            "requires": {},
            "parameters": {},
            "returns": {},
            "group": {},
            "file": {},
            "usedBy": {} 
        },
        "state-variation-text": { 
            "description": "...",
            "context": {},
            "since": {},
            "requires": {},
            "parameters": {},
            "throws": {},
            "returns": {},
            "access": {},
            "group": {},
            "file": {} 
        } 
    } 
}

[alademann]

Thanks for taking a look @hugogiraudel !

[valeriangalliat]

Are you sure you didn't execute console.log(items)?

Because I never saw JSON.stringify output single quoted (or not even quoted) keys, and the [object Object] strings is typically what console.log outputs at a limit nesting level when you log an object.

[alademann]

That output is for console.log(items) @valeriangalliat. I get no output of any kind when executing console.log(JSON.stringify(items)).

[valeriangalliat]

Oh okay. You don't even get an exception?

[alademann]

nope

[alademann]

Also - if console.log(items) doesn't give you access to the raw data - then the README in this repo shouldn't instruct people to use it.

[KittyGiraudel]

Also - if console.log(items) doesn't give you access to the raw data - then the README in this repo shouldn't instruct people to use it.

It does.

[valeriangalliat]

The function don't return undefined nor null? It means JSON.stringify is still running then. It means the data contains circular references.

[alademann]

@hugogiraudel not if it cannot access the nested objects as @valeriangalliat said. It doesn't do me any good if I can't have all the data.

[KittyGiraudel]

Also - if console.log(items) doesn't give you access to the raw data - then the README in this repo shouldn't instruct people to use it.

The data does contain some circular references.

[valeriangalliat]

@alademann You can have all the data but you can't serialize it for now.

[KittyGiraudel]

@hugogiraudel not if it cannot access the nested objects as @valeriangalliat said. It doesn't do me any good if I can't have all the data.

You do have all the data. You just can't serialize it because of circular dependencies. That doesn't prevent you from doing things with the data. Hence the SassDoc default theme.