search

Shopify / vscode-shopify-ruby

An opinionated and auto-configured set of extensions for Ruby development
MIT License
176 stars 13 forks source link

Remove byesig and release v0.1.0 #367

Closed vinistock closed 1 year ago

vinistock commented 1 year ago

Now that we have custom highlighting for Sorbet annotations, we should remove byesig from the pack. I was never a big fan of making annotations transparent (no matter how subtle) because we want people to pay attention to them. With new semantic tokens for types, themes can now make the annotations standout from regular code.

Notice that we're not removing people's configuration of byesig or asking them uninstall like we did for Rebornix Ruby. This is mostly just a soft removal, where we no longer include it in the recommended set - people are still free to use it if they wish to do so.

This PR

andyw8 commented 1 year ago

For ease of discovery, perhaps we can keep CHANGELOG.md but just point it to the releases page?

vinistock commented 1 year ago

We previously agreed on removing CHANGELOG.md from all of our projects and just using the GitHub releases. My vote goes for removing it completely.

paracycle commented 1 year ago

With new semantic tokens for types, themes can now make the annotations standout from regular code.

Let's get this merged, but do we have any guidance on how a theme could replicate the basic behaviour of what byesig does?

vinistock commented 1 year ago

It's not documented yet. We should definitely document that in the Ruby LSP to create incentive for themes to better highlight Ruby.

That said, I wanna point out that themes can't change the opacity of code. Only the colour and font style (italic, strike, underline, bold). So you can't replicate exactly what byesig does, but IMO we shouldn't create incentive to change the opacity of annotations anyway.

I created an issue for documenting semantic highlighting with the available customizations https://github.com/Shopify/ruby-lsp/issues/534.

paracycle commented 1 year ago

That said, I wanna point out that themes can't change the opacity of code.

That's not exactly true, since the foreground color value can also supply an alpha part and it will be taken into account. But, it is true that you can't just change the opacity without repeating the color value.

vinistock commented 1 year ago

I didn't know you could include alpha in the hex colour. TIL! In that case, you can indeed match byesig's behaviour.