redhat-developer / redhat-developer/vscode-java

Flag machine specific configurations like paths as machine scoped

Open
#950 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

preferences
Dominant language
TypeScript
Stars
2.3k
Forks
547
Avg merge
20h 1m
Merged PRs (30d)
11

Description

I am developer from VS Code and we introduced Machine Scope for configurations in 1.34 which will help in remote set ups.

I would like to encourage extension authors to adopt to machine scope if you have any settings that you think they are scoped to machine like java.home

For example, If you have settings that allow users to customize an executable path that exists on the machine in which extension is running, then you can tag such settings as machine scoped. This will let VS Code to read this setting from the location where the extension is running.

  • When extension is running locally, VS Code reads this setting only from User settings on the same machine.
  • When extension is running remotely, VS Code reads this setting only from Remote settings on the remote machine.

If the extension is running remotely in a remote set up, then this will help the extension not to read paths configured in local machine user settings and bail as the paths not exist in the remote machine.

Note that machine scoped settings are overridable only in user or remote settings.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the extension's configuration declarations and identify settings containing machine-specific executable or filesystem paths, such as java.home. Compare their current scope metadata with VS Code's machine-scope behavior, then verify that local and remote settings resolve paths on the machine where the extension runs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript, vscode
Domain
developer-experience, devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.