onivim/oni

Snippets: Create UltiSnips snippet provider

Open

#1,735 opened on Mar 7, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
enhancementhelp wantedinsider

Description

For snippets, it'd be helpful and convenient to automatically import users UltiSnips snippets. We'd need to parse and convert them into our snippet format, and then implement a SnippetProvider for them. UltiSnips is extremely popular and having integration out-of-the-box would be awesome.

Some info on the API here: https://github.com/onivim/oni-api/blob/90bc638bc598f7ba0175abb68f5313a9da1280df/src/index.ts#L66

We have a snippet provider that loads user-defined snippets here: https://github.com/onivim/oni/blob/7ad938cbcfe8b25acd2d358e3e3cb94f4a00953c/browser/src/Services/Snippets/UserSnippetProvider.ts#L37

This would be a good example to follow - the trickiest part will be in implementing the parsing / conversion logic to go from the UltiSnips.

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptSnippet provider APIUltiSnips snippet format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by reading the existing UserSnippetProvider.ts (browser/src/Services/Snippets/UserSnippetProvider.ts) to understand the snippet provider interface. Then, examine the oni api snippet type definition at the provided link. The main task is implementing a parser and converter from UltiSnips snippet format (see UltiSnips documentation) to the Oni snippet format. Follow the pattern of the UserSnippetProvider but handle the conversion logic.