Output JSON format spec needed

[mik01aj]

I have already tried 2 tools based on react-docgen and they fail on my code, because the JSON produced by react-docgen is different that they expect (for my cases, it was because there was no defaultValue or because type.value was a string). In my opinion, these bugs happen because there is no spec of the ouptput JSON format, with some good examples to test in such styleguide tools. Help would be appreciated a lot.

[fkling]

There is a description of the output in the README: https://github.com/reactjs/react-docgen#result-data-structure (though granted it doesn't cover possible value types for props).

The second issue you linked to seems to be a bug in react-docgen. value should be empty in that case (raw should be set instead).

[mik01aj]

@fkling thanks, I missed this description, sorry!

[fkling]

Well, it could be more extensive maybe :)

I'd appreciate it if you could file a bug for the second issue you mentioned!

[mik01aj]

About extensiveness: I think JSON schema could help. Then you would be able to verify that the JSON you return is really what you specified, and tool debelopers could use json-schema-random to generate examples and thus make them more reliable.