onivim/oni

Allow wildcards in bookmarks

Open

#2562 opened on Sep 10, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
Feature-requestgood first issueinsider

Description

Currently, Oni bookmarks are defined as an array like so:

"oni.bookmarks": ["/home/ryan/git/oni", "/home/ryan/git/uni", "/home/ryan/git/dotfiles"...]

What would be nice is some form of wildcard expansion/globbing such that instead a user could do:

"oni.bookmarks": ["/home/ryan/git/*"]

And then add every git project say, or all projects in a folder and so on.

I think this would just be a case of hooking up some logic over in BookmarksSearch.ts to expand the wildcard in the constructor where we grab all bookmarks. There is some discussion of this over in #2554, including a package we could use.

We'd most likely want to restrict this to absolute paths only, so a users home dir isn't used etc.

Contributor guide

Tech stack
typescript
Domain
frontendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
TypeScriptNode.jsglobbing patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by examining the file 'BookmarksSearch.ts' to understand how bookmarks are currently loaded and stored. Look at the discussion in issue #2554 for suggested packages like 'glob' or 'minimatch'. Implement wildcard expansion in the constructor where bookmarks are gathered, ensuring only absolute paths are expanded.