typedoc-plugin-coverage
Advanced tools
Readme
A plugin for TypeDoc to generate a documentation coverage badge.
This plugin will write a coverage.svg badge to your output directory when generating HTML documentation that
includes the percentage of your API surface which is documented. It will respect TypeDoc's requiredToBeDocumented option,
and only report missing documentation if reflections covered by that option are undocumented.
coverageLabel - Define the label for the coverage badge. Defaults to 'document'.coverageColor - Define the define the color of the coverage badge background. Defaults to a dynamic color depending on coverage percentage.coverageOutputPath - Defines the path where the coverage badge will be written, defaults to <output directory>/coverage.svg.Default colors/icon sourced from esdoc-coverage-plugin
If the numbers don't match what you expected, or don't match what TypeDoc implies should be documented, set --logLevel Verbose to see
additional logging about what was considered documented/not documented.
FAQs
A plugin for TypeDoc to generate a documentation coverage badge.
The npm package typedoc-plugin-coverage receives a total of 8,742 weekly downloads. As such, typedoc-plugin-coverage popularity was classified as popular.
We found that typedoc-plugin-coverage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.