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 (11,389 stars) (336 forks)batch import
enhancementhelp wantedinsider

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

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
TypeScriptOni codebaseSnippets concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the UserSnippetsProvider implementation at browser/src/Services/Snippets/UserSnippetProvider.ts to understand the pattern. Then create a new WorkspaceSnippetProvider that mirrors its logic but uses a workspace relative path. Determine how to listen to workspace changes to update the provider instance. There are no existing PRs or comments, so this is a clean starting point.
Snippets: Create workspace snippets provider · onivim/oni#1736 | Good First Issue