Skip to content

Serveny/ts-union-docs-vscode-extension

Repository files navigation

🟦 TypeScript Union Docs VSCode Extension

Open VSX Version Open VSX Downloads Open VSX Rating

Version Installs Rating

A VSCode TypeScript extension that displays JSDoc comments from union type members directly in your editor's quick info (hover) tooltips.

Quick Info Demo
JS Doc comment for union members in Quick Info
Completion Demo
Snippet Completions for template union members

Important

Issues please to the TS language plugin repository

💡 The Problem

By default, when you use a value from a union type, TypeScript's quick info just shows the literal value or the base union type. Documentation associated with that specific member of the union is ignored.

✨ The Solution

It wraps the TS compiler plugin ts-union-docs-plugin and acivates it for the VSCode internal TypeScript compiler. The real magic happens here: https://github.com/Serveny/ts-union-docs-plugin

Extension Settings

None

About

VSCode extension to show TS doc comments from union type entries in quick info.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors