Check for missing documentation?

[simonwjackson]

I'd like to setup a build script / githook that stops me from committing a change if there is any missing documentation.

Is there a way to trigger this with the current API?

[rafaesc]

Hi @simonwjackson,

Interesting!,

It's something that it should be created. If I develop it, I would use vue-docgen-api to find all components that don't have a basic documentation.

Actually, I don't sure if it should be in vue-styleguidist or should be in another repository because if only validate, it would be faster, and it will be useful for other projects that only need that the team does good parts.

I would like to know other opinions, but if you want work in this new repository, I can create another repository in this organization and give you permission to contribute.

Regards!

[simonwjackson]

Thanks for the info, this should be enough to get me started on something

[elevatebart]

@simonwjackson , are you still working on this?

If it were me, I would create a globby to get all component files, maybe use docgen.config.js or styleguide.config.js to determine where the components are. Then would docgen on each of them and check that for each prop, slot, event and public method there there is a description field. The errors would be returned as an array that would contain all references, probably grouped by file, one would simply need to render this in console.log.

A new package?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.

[elevatebart]

I will be working on it soon. If you are still interested @simonwjackson please contact me and we can collaborate if only to see if what I make is relevant for you ?