npmpackage.info

Gathering detailed insights and metrics for eslint-plugin-tsdoc

Other packages similar to eslint-plugin-tsdoc

eslint-plugin-verify-tsdoc

1.0.20

A plugin for ESLint that verifies tsDoc information.

@guardian/eslint-plugin-tsdoc-required

0.1.3

Require exported members to have a TSDoc comment.

@anolilab/eslint-config

15.0.3

ESLint shareable config for the Anolilab JavaScript style guide.

eslint-plugin-tsdoc-require

0.0.3

Ensures that all typescript exported types and classes have TSDoc comments

Gathering detailed insights and metrics for eslint-plugin-tsdoc

eslint-plugin-tsdoc - 0.4.0 | npmpackage.info

eslint-plugin-tsdoc

A doc comment standard for TypeScript

0.4.0

4,828

MIT

TypeScript

47.77 kB

66,436,889 7.7

Installations

npm install eslint-plugin-tsdoc

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.20.5

NPM Version

10.8.2 Pull Requests

Open

9

Total

210

Closed

14

Merged

187

Issues

Open

135

Total

196

Closed

61

Releases

Languages

TypeScript

JavaScript

CSS

Shell

Handlebars

SCSS

TypeScript (97.39%)

JavaScript (1.94%)

CSS (0.28%)

Shell (0.21%)

Handlebars (0.14%)

SCSS (0.03%)

Developer

microsoft

Download Statistics

Total Downloads

66,436,889

Last Day

115,989

Last Week

659,815

Last Month

2,757,050

Last Year

31,299,787

GitHub Statistics

MIT License

4,828 Stars

1,144 Commits

137 Forks

47 Watchers

4 Branches

10,000 Contributors

Updated on May 08, 2025

Maintainers

View All 10,000 Contributors

Package Meta Information

Latest Version

0.4.0

Package Id

eslint-plugin-tsdoc@0.4.0

Unpacked Size

47.77 kB

Size

11.74 kB

File Count

NPM Version

10.8.2

Node Version

18.20.5

Published on

Nov 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

66,436,889

Last Day

37.4%

115,989

Compared to previous day

Last Week

7.8%

659,815

Compared to previous week

Last Month

-3.9%

2,757,050

Compared to previous month

Last Year

82.4%

31,299,787

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@microsoft/tsdoc @microsoft/tsdoc-config

Dev Dependencies

@rushstack/heft-node-rig @rushstack/heft @types/eslint @types/estree @types/heft-jest @types/node eslint eslint-plugin-header

eslint-plugin-tsdoc

This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the TSDoc specification.

Usage

Configure ESLint for your TypeScript project. See the instructions provided by the typescript-eslint project. You will end up with some dependencies like this:

my-project/package.json (example)

1{
2  "name": "my-project",
3  "version": "1.0.0",
4  "dependencies": {},
5  "devDependencies": {
6    "@typescript-eslint/eslint-plugin": "~2.6.1",
7    "@typescript-eslint/parser": "~2.6.1",
8    "eslint": "~6.6.0",
9    "typescript": "~3.7.2"
10  },
11  "scripts": {
12    "lint": "eslint -f unix \"src/**/*.{ts,tsx}\""
13  }
14}

Add the eslint-plugin-tsdoc dependency to your project:

1$ cd my-project
2$ npm install --save-dev eslint-plugin-tsdoc

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)

1module.exports =  {
2  plugins: [
3    "@typescript-eslint/eslint-plugin",
4    "eslint-plugin-tsdoc"
5  ],
6  extends:  [
7    'plugin:@typescript-eslint/recommended'
8  ],
9  parser:  '@typescript-eslint/parser',
10  parserOptions: {
11    project: "./tsconfig.json",
12    tsconfigRootDir: __dirname,
13    ecmaVersion: 2018,
14    sourceType: "module"
15  },
16  rules: {
17    "tsdoc/syntax": "warn"
18  }
19};

This package is maintained by the TSDoc project. If you have questions or feedback, please let us know!

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

License

Determines if the project has defined a license.

10

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

8

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

7

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.7

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More