onivim/oni

Snippets: Create workspace snippets provider

Open

#1,736 opened on Mar 7, 2018

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

Repository metrics

Stars
 (11,389 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It'd be great to have a parallel snippets provider to the UserSnippetsProvider, that is per-workspace. It's often the case that each workspace has its own coding standards / boilerplate, and having per-workspace snippets makes a lot of sense.

The implementation would be very similiar to the UserSnippetsProvider - just the path is different, and we need to update it (or create a new instance) whenever the workspace changes: https://github.com/onivim/oni/blob/7ad938cbcfe8b25acd2d358e3e3cb94f4a00953c/browser/src/Services/Snippets/UserSnippetProvider.ts#L37

Contributor guide

Research direction
Examine the existing UserSnippetsProvider in detail, understand how it loads snippets from a user specific path, then create a parallel provider for workspace specific snippets. The workspace path can be obtained from the workspace state, and you need to update the provider when the workspace changes.
Tech stack
typescript
Domain
desktop
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.
Half day
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
TypeScriptUnderstanding of the existing UserSnippetsProvider
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65