Skip to content

mrconter1/SnippetDepot

Repository files navigation

Real-time retrieving of snippets from our online repository

This git contains code for a proof of concept extension to VS Code that enables real-time retrieving of code snippets from a community-driven online repository. It also acts as for portal for the online snippet repository project. The project combines the principles of Google Instant Search, StackOverflow and Wikipedia into one service. The online repository can be found here. Please check out our Wiki were you can find information on how to add snippets and other information about this project.

Demo Typical use-case of SnippetDepot where a function is suggested in real-time and fetched into the project.

Features

  • Plugin
    • Support for fetching Python3 snippets
    • Support for extending to other languages
  • Repository
    • Adding, searching and viewing Snippets
    • Communication with an API

Navigation

  • Official Website
  • Submit and browse existing snippets on our Repository
  • Request features and view the roadmap on Trello
  • Discuss the project on our Subreddit
  • Installation Guide
  • Find more information on our Wiki

Detailed Description

A lot of time during development goes into searching after small pieces of code. This can be a search after things as easy as removing the last character from a string to removing each file in a folder that has a filename starting on the letter 'a'. The usual practice of finding a solution to a problem consists of searching on Google, finding a suitable solution from StackOverflow and making it work with the code. The problem with this approach is that this procedure has to be done all over again each time a new developer encounters the problem. One of the primary goals of this project is to remove this repetition. If the community could work together in a fashion similar to StackOverflow and Wikipedia it would be possible to create reliable instant search and retrieve functionalities for different IDEs.

This extension works together with the online snippet repository and has two key functionalities. One is the search feature which gives suggestions of snippets which it predicts is needed and the second functionality fetches a chosen snippet. The fetched code is then put in a separate dependency file. The idea is in theory applicable to different types of programming languages and IDEs which means that there is a lot of potential for growth.

Getting Started

Installation for Windows and Linux

  1. Download the .vsix plugin file.
  2. Open Visual Studio Code and select View->Extensions from the menu to display the Extensions panel.
  3. Click the ... at the top-right corner of the Extensions panel and select "Install from VSIX..." on the menu that appears.
  4. Locate the .vsix file you downloaded and click "Open".
  5. Enable the Snippet functionality by pressing Ctrl+Shift+P and searching for 'Enable Snippets'.

*Note that the snippet functionality is currently only supporting Python files.

Release Notes

0.1.0

The initial release of a Snippets extension for VS Code. It contains functionality to show the proof of concept for an online snippet repository.


For further questions feel free to contact us.

About

This git contains the code for a proof of concept extension to VS Code that enables real-time retrieving of code snippets from an online repository.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published