-
Notifications
You must be signed in to change notification settings - Fork 182
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
Organize extension settings into Sections #1024
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - thank you for the UX improvement! 🙇🏻♂️ 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2074aea
to
9ed9ad4
Compare
It is supposed to be greyed out but still read the settings. It would be greyed out because it's technically not a setting anymore, but still read by VS Code because of the way JSON works. While this worked in testing, it's too much magic to put in a PR that's purpose is to not affect the user. I have walked this back to just organizing sections and we will work in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
This groups and orders the existing settings into VS Code Setting sections while preserving the exact keys for each setting.
The extension previously utilized different prefixes to indicate different areas like terraform-ls.rootModules or terraform-ls.terraformExecTimeout. This leaves settings in a seemingly random order in the Settings UI and makes it hard to autocomplete inside the json file.
We solve this by organizing the extension settings into sections in the
contribute
part of the package.json manifest. These sections provide a logical order to extension settings, especially if the extension has many settings or many settings that are nested.This also allows us to separate out configuration options, like a separate section for Experimental Options: