Validate invalid params through tsdoc eslint plugin

Open
#353 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
eslint, typescript
Domain
documentation, tooling

Research direction

Start by reproducing the reported behavior in the TSDoc ESLint plugin using the example shown in the issue. Trace how parameter declarations are checked; done means the linter reports parameters that do not exist in the documented signature.

Written by the indexing model from the issue text.

Description

Hi. I installed the tsdoc plugin and while it works well, its unable to detect invalid params like the one you see below. Kindly let me know how to validate such param. Thanks

image

As you see 2 params doesn't exist but the linter doesn't pick it up

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/tsdoc

All issues in microsoft/tsdoc

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.