Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't show deprecated preferences in the UI #11246

Conversation

colin-grant-work
Copy link
Contributor

What it does

Fixes #11242 by hiding deprecated settings in the preferences UI.

How to test

  1. Open the preferences UI
  2. Search for a deprecated preference (e.g. editor.gotoLocation.multiple)
  3. Observe that it does not appear in the UI.
  4. Open a settings.json file.
  5. Add a setting for a deprecated preference (e.g. "editor.gotoLocation.multiple" : null)
  6. Observe that the line is marked with a warning decoration and on hover a message is displayed about the setting's deprecation.

Review checklist

Reminder for reviewers

@colin-grant-work colin-grant-work added the preferences issues related to preferences label Jun 2, 2022
Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

I confirmed it works well, preferences that are marked as disabled (ex: json.colorDecorators.enable) do not show up in the view. If such a preference is actually added manually in the settings.json then it is correctly marked as deprecated.

@colin-grant-work colin-grant-work merged commit 96a3950 into eclipse-theia:master Jun 6, 2022
@colin-grant-work colin-grant-work deleted the feature/no-deprecated-preferences branch June 6, 2022 14:29
@colin-grant-work colin-grant-work added this to the 1.27.0 milestone Jun 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preferences issues related to preferences
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Theia should respect the deprecationMessage attached to a setting
2 participants