Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello to the maintainers of this repo 👋
(@shivani-sharechat @sachan-sharechat @sanjeevyadavIT)
I know this library has been marked as deprecated, but recently, I was tasked to write a report for how 'documented' our React app was, and I resorted to using this tool as I thought it was most fit for our use-case.
I'm making this pull request to hopefully resolve the following issues for getting coverage for React:
Component's name being a required definition in prop types
For example, we have a simple Component defined as:
doc-coverage apparently says
MyTestProp
is missing from the definedpropTypes
. I'm not sure we want to define an unnecessary prop type with the component's name everytime, so I thought we should remove it instead.Please let me know if my understanding is wrong in any way 🙇
Components with no props are not being considered "covered"
When a component has no props (say the same component as above, except it's defined as something like
const MyTestProp = (props: Props)
), doc-coverage will say that it has 0% coverage, and is not included in the count forcomponentsWithStoriesOrPropTypes
.