# typedoc-plugin-missing-check

> TypeDoc plugin to check for missing or empty documentation.

Latest version **0.4.0** (published 2021-05-22) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install typedoc-plugin-missing-check
pnpm add typedoc-plugin-missing-check
yarn add typedoc-plugin-missing-check
bun add typedoc-plugin-missing-check
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2021-05-22 |
| First published | 2021-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Josh Peak |
| Maintainers | neozenith, cs-joshpeak |
| Keywords | typedocplugin, typedoc |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-missing-check
- Repository: https://github.com/neozenith/typedoc-plugin-missing-check
- Homepage: https://joshpeak.net/typedoc-plugin-missing-check/
- Issues: https://github.com/neozenith/typedoc-plugin-missing-check/issues
- npm.io page: https://npm.io/package/typedoc-plugin-missing-check

## Recent versions

- 0.4.0 (latest) — 2021-05-22
- 0.3.1 — 2021-05-17
- 0.3.0 — 2021-05-17
- 0.2.3 — 2021-05-17
- 0.2.2 — 2021-05-17
- 0.2.1 — 2021-05-17
- 0.2.0 — 2021-05-17

## README

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

[![CI](https://github.com/neozenith/typedoc-plugin-missing-check/actions/workflows/ci.yml/badge.svg)](https://github.com/neozenith/typedoc-plugin-missing-check/actions/workflows/ci.yml)

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

A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that check TypeScript API documentation actually exists and throws errors when _it is accidentally forgotten_.

## Installation

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

## Usage

Usage is the same as documented at [TypeDoc](https://typedoc.org/guides/installation/#command-line-interface).

```bash
typedoc src/
```

```bash
# 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`
```json
{
    "missing-check-disabled": false,
    "missing-check-verbose": false,
    "missing-check-level": "public"
}
```

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

## Development

Get setup

```bash
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.

```bash
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:

```bash
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?"](https://stackoverflow.com/questions/17509669/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:

```bash
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.

---
_Source: https://npm.io/package/typedoc-plugin-missing-check · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._