npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typedoc-plugin-coverage

v3.1.1

Published

A plugin for TypeDoc to generate a documentation coverage badge.

Downloads

34,847

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

gerrit0gerrit0

Keywords

typedoc-plugin

Readme

typedoc-plugin-coverage

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.

Options

  • 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.