An open API service indexing awesome lists of open source software.

https://github.com/daniguardiola/vscode-typeskip

A VS Code extension that hides TypeScript types in place.
https://github.com/daniguardiola/vscode-typeskip

javascript ts-blank-space typescript vscode vscode-extension

Last synced: 9 months ago
JSON representation

A VS Code extension that hides TypeScript types in place.

Awesome Lists containing this project

README

          


TypeSkip logo

TypeSkip

Focus on your runtime code by hiding TypeScript types.

![An example of how the code looks with the extension enabled](images/code.gif)

TypeSkip lets you hide all **type-specific** code (type aliases, interfaces, type annotations...) in place when editing `.ts` and `.tsx` files in Visual Studio Code.

Some projects (like libraries) often combine complex types with complex runtime logic, making code hard to understand. With TypeSkip, you can temporarily forget about types and focus on your runtime code instead.

## Installation

[TypeSkip](https://marketplace.visualstudio.com/items?itemName=diola.typeskip) is available in the Extensions Marketplace.

It can also be installed by launching Quick Open (Ctrl+P or ⌘P) from VS Code, pasting the following command, and pressing enter.

```
ext install diola.typeskip
```

## Features

The opacity of the hidden code can be customized (`typeskip.opacity` setting).

![A demo of the opacity setting](images/opacity.gif)

Use commands to hide (and show) TypeScript types in the current workspace or globally.

![A demo of the commands](images/commands.gif)

In the status bar, you can see the current state, toggle it, and quickly adjust the opacity.

![A demo of the status bar](images/status-bar.gif)

## Release Notes

### 1.2.0

- Added opacity controls to the status bar.
- Added commands to increase and decrease opacity.

### 1.1.0

- Notifications now go away automatically after 5 seconds.

### 1.0.0

Initial release.

## Acknowledgements

TypeSkip is inspired and powered by [ts-blank-space](https://bloomberg.github.io/ts-blank-space/), a type-stripping TypeScript compiler. It replaces type-specific code with spaces ("blank space"), leaving valid JavaScript code behind.

Under the hood, this extension compares the original code with the "blanked" code to find the ranges to hide.