Skip to content
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

Add methods to JSON output #146

Open
kevinmpowell opened this issue Feb 17, 2020 · 4 comments
Open

Add methods to JSON output #146

kevinmpowell opened this issue Feb 17, 2020 · 4 comments

Comments

@kevinmpowell
Copy link

kevinmpowell commented Feb 17, 2020

I tried to do this myself, but quickly got out of my depth. I'd like to see support for JSDoc methods in the JSON format. It's already there in the markdown format.

image

Pideeeh pushed a commit to quatico-solutions/web-component-analyzer that referenced this issue Mar 3, 2020
@runem
Copy link
Owner

runem commented Mar 10, 2020

I agree that it would be valuable, but I will only implement it in the experimental JSON format when we agree on something at https://github.com/webcomponents/custom-elements-json. Please read those discussions and add your thoughts there if necessary :-)

@kevinmpowell
Copy link
Author

@runem what does agreement look like? Looks like it's already been discussed:

webcomponents/custom-elements-manifest#5 (comment)

Is there an official doc that I'm not seeing?

@runem
Copy link
Owner

runem commented Mar 10, 2020

There exists two PR's with concrete suggestions on how the format could look :-) The problem right now with the experimental JSON format that web-component-analyzer outputs, is that it becomes really difficult to output more complex structures such as custom types, modules, inheritance, methods, eg.

This PR opens up for a JSON structure that allows outputting more complex concepts. I intend to implement that structure as parallel experimental JSON format that will temporarily exist side by side with the existing experimental JSON format. This way we can experiment and play around with concrete outputs of the JSON format in order to better access the optimal output. This output format will include methods.

All in all, I think that there is consensus that methods should be included in the final JSON format. The question is however, how to model it in JSON.

@kevinmpowell
Copy link
Author

@runem thanks for the response. I'd love to use that experimental format in the interim. I understand the blocker that is the standardization conversation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants