vscode-twoslash-queries - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #go #rust #deep-learning #nodejs #windows #cli #kubernetes #vue #pytorch #openai

vscode-twoslash-queries

(★ 460)

VS Code extension which adds support for twoslash queries into typescript projects

File Explorer

Download Latest Version (.zip)

- extensions.json
- launch.json
- settings.json
- tasks.json
- - runTest.ts
- extension.ts
- helpers.ts
- queries.ts
.eslintrc.json
.gitignore
.vscodeignore
.yarnrc
icon.png
LICENSE
package.json
README.md
tsconfig.json
vsc-extension-quickstart.md
vscode-twoslash.png
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/orta/vscode-twoslash-queries

Downloads the entire project code from GitHub to your computer.

cd vscode-twoslash-queries

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vscode-twoslash-queries

A tiny extension for VS Code that lets you use `// ^?` inside your editor to inline highlight types. Re-uses the existing TypeScript tooling infra in `*.ts`, `*.tsx`, `*.js`, and `*.jsx` files, simply adding inline info.

Useful for keyboard warriors or folks working on complex types and want to see how changes propagate throughout other types.

## Features

**Key: You write `// ^?` anywhere in a source file (with whitespace before, between and middle being whatever) all that matters is the alignment of the `^`.**

In addition:

- End a line with `//=>` to highlight the leftmost named type.
- Use the `"TwoSlash Query: Insert Below"` command from the Command Palette or assign a keyboard shortcut to it (default: `Ctrl+K 6` on Windows, `Cmd+K 6` on Mac).

You can see here it in use a few times:

<img src="./vscode-twoslash.png" />

## Debugging

**Ensure that inlay hints are enabled [`editor.inlayHints.enabled`](vscode://settings/editor.inlayHints.enabled) in your VS Code settings.**

If the inlay hints are truncated, you may need to increase the inlay hints maximum length [`editor.inlayHints.maximumLength`](vscode://settings/editor.inlayHints.maximumLength). This overrides the maxLength of this plugin [`orta.vscode-twoslash-queries.maxLength` (default 120)](vscode://settings/orta.vscode-twoslash-queries.maxLength).

This would look like:

```json
{
  "editor.inlayHints.enabled": true,
  "editor.inlayHints.maximumLength": 120,
  "orta.vscode-twoslash-queries.maxLength": 120
}
```

## Deployment

Bump version number.

VS Code:

1. `npx vsce publish`

OSVX:
1. `npx vsce package`
2. `ovsx publish vscode-twoslash-queries-*.vsix -p [token]`
3. `rm vscode-twoslash-queries-*.vsix`