Skip to content
A Visual Studio Code extension for cht.sh / cheat.sh
TypeScript Makefile
Branch: master
Clone or download

README.md

vscode-snippet

The MIT License GitHub Visual Studio Marketplace

A Visual Studio Code extension for cht.sh.

Features

  • Zero configuration: works out of the box.
  • Automatically detects programming language from current editor window.

Config options

  • openInNewEditor: open snippets or in new editor window (default) in line with current document.
  • verbose: add comments around code snippets.
  • baseUrl: base url of the cheat server (see cheat.sh documentation)
  • http.proxy: VS Code proxy setting. If set, requests made by vscode-snippet will be sent through provided proxy (see Visual Studio Code network settings)
  • defaultLanguage: Programming language name in lower case to use as default language when there is no open editor window.

Installation

Install this extension from the VSCode Marketplace

Usage

Search for a snippet

  1. Hit ⌘ Command + ⇧ Shift + p
  2. Run Snippet: Find.
  3. Type your query and hit enter.

Preview

Moving between answers

Sometimes the first answer is not what you're looking for.
In that case, use Snippet: Show next answer and Snippet: Show previous answer to show alternative snippets.

Search for snippet based on selected text

  1. Select some text in an editor window.
  2. Right click and choose "Find snippet from selected text"

Preview

Alternatively, you can also run the Snippet: Find Selected Text from the command menu:

Preview

You can configure a keyboard shortcut. By default this is ⌘ Command + ⇧ Shift + s:

Preview

Development

To get a list of all available commands, try make help.
To test your changes, go to the Debug panel in VSCode and click on the play button. This will start the extension in a new window where you can test it.

Contributing

This plugin is far from feature-complete.
If you want to improve it, feel free to pick one of the open issues and give it a shot.
In case you need any help, just add a comment to the issue to get a conversation started. 😃

You can’t perform that action at this time.