Skip to content

Simplify VSCode settings examples in README #78

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

Merged
merged 3 commits into from
Jul 21, 2025

Conversation

br3ndonland
Copy link
Contributor

Description

The VSCode settings.json examples in the README show duplicate settings for [opentofu] and [opentofu-vars] language keys.

This is unnecessary because multiple language keys can be included together.

This:

{
  "[opentofu]": {
    "editor.defaultFormatter": "opentofu.opentofu",
    "editor.formatOnSave": true,
    "editor.formatOnSaveMode": "file"
  },
  "[opentofu-vars]": {
    "editor.defaultFormatter": "opentofu.opentofu",
    "editor.formatOnSave": true,
    "editor.formatOnSaveMode": "file"
  }
}

Can be written like this:

{
  "[opentofu][opentofu-vars]": {
    "editor.defaultFormatter": "opentofu.opentofu",
    "editor.formatOnSave": true,
    "editor.formatOnSaveMode": "file"
  }
}

Changes

This PR will remove the unnecessary code duplication in the VSCode settings.json examples in the README.

Related

@br3ndonland br3ndonland requested a review from a team as a code owner July 12, 2025 21:03
@br3ndonland br3ndonland force-pushed the simplify-vscode-settings branch from c4558f0 to fbc7d2f Compare July 12, 2025 21:04
@diofeher
Copy link
Member

Thanks for the pull request @br3ndonland !

I've added a small modification to make the name of the formatter valid. opentofu.opentofu would be used for Gamunu's repo, but since we're using a different name here, that's what we should use it.

Copy link
Member

@Gogotchuri Gogotchuri left a comment

Choose a reason for hiding this comment

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

Forgot another place @diofeher

@diofeher diofeher requested a review from Gogotchuri July 14, 2025 12:53
br3ndonland and others added 3 commits July 21, 2025 10:58
Signed-off-by: Diogenes Fernandes <[email protected]>

Signed-off-by: Diógenes Fernandes <[email protected]>
Co-authored-by: Ilia Gogotchuri <[email protected]>
Signed-off-by: Diógenes Fernandes <[email protected]>
@diofeher diofeher force-pushed the simplify-vscode-settings branch from 7dc6cdf to 2287302 Compare July 21, 2025 13:59
@diofeher diofeher merged commit f2a1213 into opentofu:main Jul 21, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants