runem / web-component-analyzer

CLI that analyzes web components and emits documentation
https://runem.github.io/web-component-analyzer
MIT License
501 stars 63 forks source link

Request Support for LWC Components #150

Open Digadadave opened 4 years ago

Digadadave commented 4 years ago

I would love to see support for Lightning Web Components (LWC).

LWC Repo: https://github.com/salesforce/lwc

runem commented 4 years ago

Hi, thanks for opening this issue :-)

I think I need some more information. What specifically isn't supported?

I'm just guessing, but currently there are some issues analyzing dependencies that don't ship typings. However, I have a plan for how to add the support for that, I just haven't yet come around to do it.

Is that what you are experiencing?

priandsf commented 4 years ago

@runem Hi Rune, I'm currently looking at integrating LWC with Storybook and wca. I created a sample project here https://github.com/priandsf/lwc-storybook to conduct the experiment.

I'm getting some decent results after adding the JSDoc. I'll figure out what is missing, if any.

To answer your question above, LWC is a bit different from native web component:

Also, Salesforce could use an XML meta-data file, describing the component, in particular when it is consumed by a GUI builder. This file can provide useful information.

I'll be happy to collaborate.