microsoft / microsoft/TypeScript

Support auto-completion for TSDoc

Open
#61,592 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

### 🔍 Search Terms

tsdoc complete

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

TypeScript currently only supports auto-completion for JSDoc, not TSDoc. For example, there is no intelligent suggestion for [@defaultValue](https://tsdoc.org/pages/tags/defaultvalue/).

![Image](https://github.com/user-attachments/assets/9b8fa791-41b4-4364-9421-555032e3c896)

### 📃 Motivating Example

If [TSDoc](https://tsdoc.org/) is the recommended commenting standard for TypeScript, then it should natively support intelligent suggestions and syntax highlighting for TSDoc.

### 💻 Use Cases

Writing comments using TSDoc syntax in VSCode.

Contributor guide

Open the contributing guide

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.

Research direction

Start by investigating how TypeScript currently provides JSDoc auto-completion and how VSCode consumes those language-service results. Compare that behavior with TSDoc tags such as @defaultValue and determine the expected syntax-highlighting and completion behavior; done means TSDoc comments receive intelligent suggestions without changing emitted JavaScript.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.