eclipse-theia/theia

Implement registerFileSearchProvider/registerTextSearchProvider vscode proposed APIs

Open

#9,146 opened on Mar 2, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (18,676 stars) (2,478 forks)batch import
help wantedvscode

Description

As I mentioned at the dev meeting- this is one example of a feature I'd use due to having a large repo with a customised VCS

Feature Description:

Support for custom URI schemes, specifically for file search (Quick Open) and text search (Find in Files)

https://github.com/Microsoft/vscode/blob/main/src/vs/vscode.proposed.d.ts#L249-L538 registerFileSearchProvider/registerTextSearchProvider

This can help for large repos, or to avoid checking out a repo/dependency but still add it to your workspace to navigate it.

One example of an extension supporting this, that can be used to test the implementation - https://github.com/eamodio/vscode-remotehub

Theia's current implementation uses ripgrep- this would be limited to file: URIs only and the code changed to match the interface TextSearchProvider. https://github.com/eclipse-theia/theia/blob/b74355fd3c133f8b2fe826b756b6a4851bc17961/packages/file-search/src/node/file-search-service-impl.ts

Or this could be swapped out for the MS implementation as it already matches the apis - subject to license- https://github.com/microsoft/vscode/blob/a699ffaee62010c4634d301da2bbdb7646b8d1da/src/vs/workbench/services/search/node/ripgrepSearchProvider.ts

Contributor guide

Tech stack
typescript
Domain
backenddeveloper 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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScriptSearch provider APIsRipgrep integrationTheia architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the existing file search implementation in packages/file search/src/node/file search service impl.ts and compare with VS Code's proposed registerFileSearchProvider/registerTextSearchProvider APIs from the linked definition. Determine how to adapt or replace the current ripgrep based approach to support custom URI schemes, potentially leveraging the Microsoft implementation as a reference for interface compliance.