onivim/oni

Thoughts on the new global search

Open

#1,553 opened on Feb 14, 2018

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

Repository metrics

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

Description

Hi all, I just updated to 0.3.0 which has the new "VS Code" style sidebar with global search and I wanted to give my input about an alternative implementation (I sincerely hope that no one takes any offence to this).

I personally prefer the approach to global search that emacs-helm, atom-narrow and unite.vim take. The advantages of this style of approach include:

  • You get a consistent UI for narrowing lists of different types of data sources instead of a specific UI for just global line-wise search (i.e. ripgrep). For example, with the tools listed above you can use to same UI for local symbol search, global symbol search, global line-wise search, local line-wise search, local folds and more
  • It can be made to be extensible (just like how you can add your own custom sources with unite.vim)
  • Quicker to visually parse because the input text field is co-located with the results
  • This last point is quite opinionated, but I also feel that this approach is more "vim-like"

Looking forward to hearing your thoughts on this :)

Contributor guide

Research direction
Familiarize yourself with the current global search implementation in Oni (likely based on ripgrep), then propose a refactor to a unified narrowing UI similar to helm or unite.vim, ensuring extensibility and co located input/results.
Tech stack
typescript
Domain
developer experiencetooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptNeovim basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30