typedoc-plugin-missing-check v0.4.0

🤷‍♀️ Typedoc Plugin: Missing Check 🤷‍♂️

TypeDoc Plugin to check if typescript documentation is empty or missing.

A plugin for TypeDoc that check TypeScript API documentation actually exists and throws errors when it is accidentally forgotten.

Installation

npm install --save-dev typedoc typedoc-plugin-missing-check

Usage

Usage is the same as documented at TypeDoc.

typedoc src/

# Check only public or higher (default).
typedoc --missing-check-level public src/

# Check only protected and public.
typedoc --missing-check-level protected src/

# Check all.
typedoc --missing-check-level private src/

# Disable missingness checks.
typedoc --missing-check-disabled src/

# Enable more verbose error messages.
typedoc --missing-check-verbose src/

These options can also be configured in your typedoc.json or tsconfig.json like so:

typedoc.json

{
    "missing-check-disabled": false,
    "missing-check-verbose": false,
    "missing-check-level": "public"
}

tsconfig.json

{
    "compilerOptions": {
        ...
    },
    "typedocOptions": {
        "missing-check-disabled": false,
        "missing-check-verbose": false,
        "missing-check-level": "public"
    }    
}

Development

Get setup

git clone https://github.com/neozenith/typedoc-plugin-missing-check
cd typedoc-plugin-missing-check
npm ci

Run a self check since there are no tests just yet.

npm run build
npx typedoc --plugin . src/

Contributing

Report issues on Github, or more appreciated would be opening a pull request and we can collaborate on getting the needed change over the line.

Since you will need to create a fork to open up a new PR, you can also then immediately use your updated version with:

npm install --save-dev https://github.com/{USER}/typedoc-plugin-missing-check/tarball/{BRANCH}

See this Stackoverflow article "How to install an npm package from github directly?" for more details.

Then revert back to using this version once your PR is accepted and published:

npm install --save-dev typedoc-plugin-missing-check

TODO

Next

• Create jest test suite
• Handle missing class constructor docs
• Handle missing method docs

Later

• Automate process publishing of docs and to npm process after successful CI and merge to main.
• Automate Github Release page.