onivim/oni

Snippets: Create UltiSnips snippet provider

Open

#1,735 opened on 2018年3月7日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
enhancementhelp wantedinsider

説明

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.

コントリビューターガイド

技術スタック
typescript
領域
developer experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScriptSnippet provider APIUltiSnips snippet format
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
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.