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

Terraform Stacks Icons #1774

Merged
merged 1 commit into from
Jun 18, 2024
Merged

Terraform Stacks Icons #1774

merged 1 commit into from
Jun 18, 2024

Conversation

jpogran
Copy link
Contributor

@jpogran jpogran commented Jun 7, 2024

This adds a new file icon for the Stacks language which will apply to all tfstack.hcl and tfdeploy.hcl files.

This is a new icon for several reasons:

  • The existing icon is not provided by HashiCorp, it is from the default VS Code icon theme Seti and releases to it are delivered in VS Code releases.
  • We cannot reference it in our extension manifest, so we need to provide our own.
  • We cannot override the Seti theme, VS Code does not allow this and replace it.

Since this is not something we can control, we are providing our own icon to ensure we can deliver a consistent experience to our users.

To solve this a new icon was created that is similar in shape and size to the existing Seti Terraform icon and uses the Seti purple color. This ensures it is visually similar to the existing icon, which is important when the user is looking at Stack files and Terraform files in the same workspace. The one flaw is that the existing Terraform icon is slightly misaligned in the Seti theme, so any icon we provide looks slightly off. This is a known issue and is not something we can fix.

We could try to get the Seti icon updated, but that would require a PR to the Seti theme and a release of that theme. The Seti project does not accept new file icons lightly and does not release frequently. In addition to consume their release requires a VS Code release. There would be a long indeterminate time between submitting a new icon and a user finally seeing a correct Stacks icon.

@jpogran jpogran changed the title Tfstacks icons Terraform Stacks Icons Jun 7, 2024
@jpogran jpogran force-pushed the tfstacks branch 3 times, most recently from 9a6175d to f90eb97 Compare June 11, 2024 19:13
@jpogran jpogran marked this pull request as ready for review June 11, 2024 19:17
@jpogran jpogran requested a review from a team as a code owner June 11, 2024 19:17
@jpogran jpogran self-assigned this Jun 12, 2024
Copy link
Member

@ansgarm ansgarm left a comment

Choose a reason for hiding this comment

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

Looks good!

Base automatically changed from tfstacks to main June 18, 2024 15:29
This adds a new file icon for the Stacks language which will apply to all tfstack.hcl and tfdeploy.hcl files.

This is a new icon for several reasons:
- The existing icon is not provided by HashiCorp, it is from the default VS Code icon theme Seti and releases to it are delivered in VS Code releases.
- We cannot reference it in our extension manifest, so we need to provide our own.
- We cannot override the Seti theme, [VS Code does not allow this](https://code.visualstudio.com/api/extension-guides/file-icon-theme#language-default-icons) and replace it.

Since this is not something we can control, we are providing our own icon to ensure we can deliver a consistent experience to our users.

To solve this a new icon was created that is similar in shape and size to the existing Seti Terraform icon and uses the Seti purple color. This ensures it is visually similar to the existing icon, which is important when the user is looking at Stack files and Terraform files in the same workspace. The one flaw is that the existing Terraform icon is slightly misaligned in the Seti theme, so any icon we provide looks slightly off. This is a [known issue](microsoft/vscode#154492) and is not something we can fix.

We could try to get the Seti icon updated, but that would require a PR to the Seti theme and a release of that theme. The Seti project does not accept new file icons lightly and does not release frequently. In addition to consume their release requires a VS Code release. There would be a long indeterminate time between submitting a new icon and a user finally seeing a correct Stacks icon.
@jpogran jpogran merged commit 4b63a73 into main Jun 18, 2024
12 checks passed
@jpogran jpogran deleted the tfstacks_icons branch June 18, 2024 15:48
jpogran added a commit that referenced this pull request Jun 25, 2024
This adds a new file icon for the Stacks language which will apply to all tfstack.hcl and tfdeploy.hcl files.

This is a new icon for several reasons:
- The existing icon is not provided by HashiCorp, it is from the default VS Code icon theme Seti and releases to it are delivered in VS Code releases.
- We cannot reference it in our extension manifest, so we need to provide our own.
- We cannot override the Seti theme, [VS Code does not allow this](https://code.visualstudio.com/api/extension-guides/file-icon-theme#language-default-icons) and replace it.

Since this is not something we can control, we are providing our own icon to ensure we can deliver a consistent experience to our users.

To solve this a new icon was created that is similar in shape and size to the existing Seti Terraform icon and uses the Seti purple color. This ensures it is visually similar to the existing icon, which is important when the user is looking at Stack files and Terraform files in the same workspace. The one flaw is that the existing Terraform icon is slightly misaligned in the Seti theme, so any icon we provide looks slightly off. This is a [known issue](microsoft/vscode#154492) and is not something we can fix.

We could try to get the Seti icon updated, but that would require a PR to the Seti theme and a release of that theme. The Seti project does not accept new file icons lightly and does not release frequently. In addition to consume their release requires a VS Code release. There would be a long indeterminate time between submitting a new icon and a user finally seeing a correct Stacks icon.
Copy link

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.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants