# eslint-plugin-tsdoc

> An ESLint plugin that validates TypeScript doc comments

Latest version **0.5.4** (published 2026-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-tsdoc
pnpm add eslint-plugin-tsdoc
yarn add eslint-plugin-tsdoc
bun add eslint-plugin-tsdoc
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.5.4 |
| Published | 2026-09-29 |
| First published | 2019-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 57.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4968 |
| Maintainers | rushstack-admin, odspnpm, octogonz, microsoft1es |
| Keywords | TypeScript, documentation, doc, comments, JSDoc, TSDoc, ESLint, plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-tsdoc
- Repository: https://github.com/microsoft/tsdoc
- Homepage: https://tsdoc.org/
- Issues: https://github.com/microsoft/tsdoc/issues
- npm.io page: https://npm.io/package/eslint-plugin-tsdoc

## Dependencies (3)

- [@microsoft/tsdoc](https://npm.io/package/@microsoft/tsdoc.md) 0.17.1
- [@microsoft/tsdoc-config](https://npm.io/package/@microsoft/tsdoc-config.md) 0.18.3
- [@typescript-eslint/utils](https://npm.io/package/@typescript-eslint/utils.md) ~8.56.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.5.4 (latest) — 2026-09-29
- 0.5.3 — 2026-09-16
- 0.5.2 — 2026-02-25
- 0.5.1 — 2026-02-25
- 0.5.0 — 2025-11-11
- 0.4.0 — 2024-11-23
- 0.3.0 — 2024-05-28
- 0.2.17 — 2022-09-14
- 0.2.16 — 2022-04-09
- 0.2.15 — 2022-04-07
- 0.2.14 — 2021-04-20
- 0.2.13 — 2021-04-19
- 0.2.12 — 2021-04-16
- 0.2.11 — 2021-01-22
- 0.2.10 — 2020-12-03
- … 14 more at https://npm.io/package/eslint-plugin-tsdoc/versions

## README

# eslint-plugin-tsdoc

This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the
[TSDoc specification](https://tsdoc.org/).

## Usage

1.  Configure ESLint for your TypeScript project.  See the instructions provided by the
    [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) project.
    You will end up with some dependencies like this:

    **my-project/package.json**  (example)
    ```ts
    {
      "name": "my-project",
      "version": "1.0.0",
      "dependencies": {},
      "devDependencies": {
        "@typescript-eslint/eslint-plugin": "~2.6.1",
        "@typescript-eslint/parser": "~2.6.1",
        "eslint": "~6.6.0",
        "typescript": "~3.7.2"
      },
      "scripts": {
        "lint": "eslint -f unix \"src/**/*.{ts,tsx}\""
      }
    }
    ```

2.  Add the `eslint-plugin-tsdoc` dependency to your project:

    ```bash
    $ cd my-project
    $ npm install --save-dev eslint-plugin-tsdoc
    ```

3.  In your ESLint config file, add the `"eslint-plugin-tsdoc"` package to your `plugins` field,
    and enable the `"tsdoc/syntax"` rule.  For example:

    **my-project/.eslintrc.js** (example)
    ```ts
    module.exports =  {
      plugins: [
        "@typescript-eslint/eslint-plugin",
        "eslint-plugin-tsdoc"
      ],
      extends:  [
        'plugin:@typescript-eslint/recommended'
      ],
      parser:  '@typescript-eslint/parser',
      parserOptions: {
        project: "./tsconfig.json",
        tsconfigRootDir: __dirname,
        ecmaVersion: 2018,
        sourceType: "module"
      },
      rules: {
        "tsdoc/syntax": "warn"
      }
    };
    ```

This package is maintained by the TSDoc project.  If you have questions or feedback, please
[let us know](https://tsdoc.org/pages/resources/help)!

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