tennox/vscode-snippet

🐤 A Visual Studio Code extension for cheat.sh. Quickly and easily find code snippets for any language right inside your IDE.

vscode-snippet

A Visual Studio Code extension for cht.sh.
Watch this lightning talk to learn more.

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.
• title: Template string of a snippet title. You can use the following variables:
  • ${language} - the programming language
  • ${query} - the snippet query (search text)
  • ${index} - the index of the snippet (e.g. 2 for the third answer)
• insertWithDoubleClick: insert snippet with double click.

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.

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"

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

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

Saving a snippet

1. Select some text in an editor window.
2. Right click and choose "Save snippet"
3. Select a folder for the snippet
4. Enter a name of the snippet
5. Press Enter

Inserting a snippet

1. Open the Explorer by clicking Ctrl + Shift + E
2. Open the Snippets section
3. Click on the snippet that you want to insert

Creating a folder for the snippets

1. Open the Snippets section
2. Click on the + icon (alternatively, you can right click on any snippet or a folder and select "New Folder")
3. Enter a name of the folder
4. Press Enter

Renaming a snippet or a folder

1. Open the Snippets section
2. Right click on the snippet or a folder that you want to rename
3. Select "Rename"
4. Enter a new name
5. Press Enter

Deleting a snippet or a folder

1. Open the Snippets section
2. Right click on the snippet or a folder that you want to delete
3. Select "Delete"
4. Confirm your choice

Moving a snippet or a folder

You can move snippets or folders in the Snippets view by dragging and dropping them

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. 😃