eclipse-theia/theia

Support workspaceSuffix argument in the ResourceLabelFormatter plugin API

Open

#8,321 opened on Aug 6, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (18,676 stars) (2,478 forks)batch import
help wantedplug-in systemvscode

Description

Since the ResourceLabelFormatter plugin API was introduced by https://github.com/eclipse-theia/theia/pull/8187, it doesn't support workspaceSuffix argument.

Feature Description:

Proposal: Handle this argument in the getName() function of the WorkspaceUriLabelProviderContribution in the vscode way: https://github.com/microsoft/vscode/blob/1.47.3/src/vs/workbench/services/label/common/labelService.ts#L292-L296

Contributor guide

Tech stack
typescript
Domain
apifrontend
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
TypeScriptTheia plugin API basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the `getName()` function in `packages/workspace/src/browser/workspace uri contribution.ts` (L45 L47) and the type definition in `packages/plugin/src/theia proposed.d.ts` (L390). Look at how VS Code handles the `workspaceSuffix` argument in `labelService.ts` (L292 L296). Implement the argument handling in the Theia `ResourceLabelFormatter` plugin API by modifying the `getName` method and updating the plugin type definitions.