Repository files navigation

Get useful type information where you need it

Prettify TS is a Visual Studio Code extension that enhances your TypeScript development experience. It provides hover information for TypeScript types, classes, interfaces, and more, formatted in a more readable and configurable way.

Install via the VSCode Marketplace:

• Prettify TS on VSCode Marketplace
• Prettify TS on Open VSX

This README is for developing Prettify TS. The extension README (shown on the Marketplace) ishere.

Note:pnpm is required.Install it here.

pnpm install# Installs all dependenciespnpmtest# Builds and runs the extension test suitepnpm build# Compiles the codebasepnpm package# Builds + prepares the VSIX package for publishing

You donot need to build manually —test andpackage handles build steps automatically.

The full integration test suite lives intest/. For more info on the test layout, debugging instructions, and hover validation strategy, see theTest README.

This repo usespnpm workspaces to manage multiple packages:

.├── packages/│   ├── typescript-plugin/     # TypeScript language service plugin│   └── vscode-extension/      # VSCode extension host + UI└── test/                      # Full integration test suite└── scripts/                   # Utility scripts for development, building, or CI

During development, pnpm automatically symlinks the plugin into the extension’snode_modules for live debugging.

To prepare for publishing:

1. Prepackage:

   • Copies actual plugin files into the extension
   • Rewritesworkspace:* to* forvsce compatibility

2. Package:

   • Runsvsce package to produce.vsix

3. Postpackage:

   • Reverts everything back for dev (restoresworkspace:* and symlinks)

Defined in.vscode/launch.json:

• Run Extension: Launches VSCode with the extension loaded for manual debugging
• Attach to TSServer: Debug the TypeScript language service plugin

Use the VSCode Run panel (Ctrl+Shift+D / Cmd+Shift+D) to start these sessions.

MIT

Happy coding! 🎉