-
Notifications
You must be signed in to change notification settings - Fork 9
Add json
generator
#57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Closes #57 Signed-off-by: flakey5 <[email protected]>
Closes #57 Signed-off-by: flakey5 <[email protected]>
JSDoc or JSON schema? Also, starting some preliminary work on what the schema should look like here |
JSDoc schema :) like the properties of each object within the JSON match the properties that JSdoc schema supports. |
Notes here from downstream discussion: DefinitelyTyped/DefinitelyTyped#70298 |
Closes #57 Signed-off-by: flakey5 <[email protected]>
Closes #57 Signed-off-by: flakey5 <[email protected]>
This issue details the creation of the
json
generator. Unlike thejson-simple
generator that writes all content on a predefined single file, thejson
generator works like the other generators (i.e.,legacy-HTML
); it writes a JSON file for each module.The
json
generator follows a hierarchy of themodule
(being a nested JSON (a JSON tree, where eachdepth
level increases the nested-ness (as we have on the current https://nodejs.org/api/*.json format)We also need to parse a section entry API options (params, return types, etc.) similarly as it is done on the current JSON format; There's room for improvement here and an opportunity to better the format.
There are other little pieces. For example, the metadata within
node.updates
should be flattened out to be properties directly of the node entry instead of an array.I also believe the signature transformation (options) of methods/classes/constructors can be part of a centralized process until it can be reused or applied directly at the
ApiDocMetadataEntry
as a new property.I also believe we could follow the JSDoc schema, which would be completely different from the current one but completely easy for downstream users to consume. This is just an idea, but feels good.
The text was updated successfully, but these errors were encountered: