docs(style-guide)!: improve and define more highlights

[Jint-lzxy]

Sorry for the long wait. This PR is a continuation of catppuccin/nvim#481, aimed at defining (and updating) more syntax groups and drafting a table for LSP semantic tokens. List of modifications: catppuccin/nvim#481 (comment).

Let me know if I need to change anything :)

[preview style-guide.md]

[nullchilly]

+1 for using teal as delimiter (; / . / ,)

cc @catppuccin/core

[sgoudham]

Hi @Jint-lzxy, firstly I want to apologise for the length of time this PR has sat here. I've always ended up looking at this PR and thinking to myself "oh yeah, I should look at this" but failed to follow through with it. As I hope you'll be able to appreciate, we all volunteer our free time for this theme and I try not to work on Catppuccin if I don't have the motivation for it.

With regards to the PR... frankly, the syntax highlighting changes proposed in this PR does not align with the syntax highlighting that we hope to achieve for all editors. @nekowinston and I have spent the last year modifying and updating editors like VSCode and Intellij to be consistent and coherent with each other with neovim as a starting point, and have influenced the syntax highlighting of other editors from this. E.g. mauve keywords, green strings, yellow classes and we took that further for other editors.

While working on VSCode's syntax highlighting, winston implemented a build system with chromatic showing the syntax highlighting colours for a set of languages. This is more of a sanity check than anything else but it is a good resource to see the "vibe" of syntax highlighting that we're aiming for editors.

Ultimately, I think a few things need to happen for this PR to be merged:

1. Revert changes made in tables Language Defaults & General
2. Modify the LSP Semantic Highlights table to be more in line with the editors mentioned above. For example:
   • Parameters should be maroon
   • Builtins should be red
   • Regex should be pink but if it can be more in detail, it should inherit the other colour mappings (e.g. numbers in regex should be peach, lookaheads being blue since they act like a function taking values, etc) - See VSCode's PR on this (feat(regex): add dedicated syntax highlighting for regex vscode#263)
   • Enum Members should be teal
   • Macro should be blue

While this probably isn't the reply you were hoping for, hope this makes sense as a way to move forward 👍

[ruru-m07]

👍

[Jint-lzxy]

Hey @sgoudham, first off please allow me to apologize for my prolonged period of inactivity. I've been super busy during that time and couldn't get around to replying promptly to the notifications Catppuccin sent to my email. But now I've got it all sorted out and I'm actively catching up!

I've always ended up looking at this PR and thinking to myself "oh yeah, I should look at this" but failed to follow through with it.

No worries at all! Thanks a ton for taking the time to review my preliminary PR! I really appreciate it ❤️

As I hope you'll be able to appreciate, we all volunteer our free time for this theme and I try not to work on Catppuccin if I don't have the motivation for it.

Yeah! I really appreciate the tremendous effort put in by the core team. To be frank, I didn't mean to rush you at that time. I just wanted to know if there's any progress with this PR and if I should provide some explanations or participate in the discussion, as I'm sure there will be quite a few changes and discussions happening before this PR gets merged. Also, I really wanna express my gratitude to the staff team and all the ports maintained by Catppuccin. They are all so beautiful! I've been using Catppuccin everywhere I can and have introduced it to many of my friends. I genuinely hope Catppuccin continues to grow and gets more recognition. Plus, now that I have more free time, I feel like I can spend more time maintaining it (I slacked off too much before :laughing:).

With regards to the PR... frankly, the syntax highlighting changes proposed in this PR does not align with the syntax highlighting that we hope to achieve for all editors.

Oops, sorry for the misunderstanding on this! Initially, I actually had two motives for opening this PR. One was to refine the style guide, and the other was to propose some ideas regarding color combinations (hence the differences from the current implementation). I actually got inspired from versions way back (likely before the first treesitter.lua breaking change), but I agree this should have been discussed in a separate thread. Very sorry for my oversight here!

... have spent the last year modifying and updating editors like VSCode and Intellij to be consistent and coherent with each other with neovim as a starting point, and have influenced the syntax highlighting of other editors from this. E.g. mauve keywords, green strings, yellow classes and we took that further for other editors.

Wow, this looks like a lot of work! I'll definitely check them out and in the process, tidy up the current naming scheme, trying to catch the design motivation (the "vibe") behind them 😸

While working on VSCode's syntax highlighting, winston implemented a build system with chromatic showing the syntax highlighting colours for a set of languages. This is more of a sanity check than anything else but it is a good resource to see the "vibe" of syntax highlighting that we're aiming for editors.

Thanks for this extra resource; I'll be sure to take a look at it!

Ultimately, I think a few things need to happen for this PR to be merged:
...

Haha, I'm totally cool with any potential changes! I just wanna ask if there's a chance for another "major overhaul" of the current color scheme? Because personally, I feel like there are still some clashes between certain elements, and maybe discussing them could lead to a better solution. Perhaps we could start a new thread to talk about this? I could also create a draft style guide based on the current naming scheme and update my progress here.

By the way, I'm wondering if there's a chance for me to join Catppuccin? I'll have more free time in a month, and I'm really keen to pitch in and help maintain it!

[sgoudham]

No worries at all! Thanks a ton for taking the time to review my preliminary PR! I really appreciate it ❤️

No problem!

I genuinely hope Catppuccin continues to grow and gets more recognition.

Me too :D

Haha, I'm totally cool with any potential changes! I just wanna ask if there's a chance for another "major overhaul" of the current color scheme? Because personally, I feel like there are still some clashes between certain elements, and maybe discussing them could lead to a better solution. Perhaps we could start a new thread to talk about this? I could also create a draft style guide based on the current naming scheme and update my progress here.

I'm not entirely sure what you have in mind for "major overhaul" but if you're talking about the colour palette as a whole, then I can confirm that the staff team don't have plans to modify the existing hex codes for the v0.2 colours. However, we are constantly seeking to improve and standardise the application of the palette in code editors / terminals etc. I can confirm that the staff team are working away in the background to finally resolve #1961 and make our colour scheme much more suitable for terminals by default (which means defining new colours but not changing existing ones)

I'm not entirely too happy with the format of the style guide document at the moment as it's a huge pain to edit in the table format. I think the future vision would be to have a nice style guide section/page on catppuccin.com but that's definitely lower in priority than making sure the content of the style guide is clear, concise and descriptive. I'd be interested in hearing ideas on how else to display the style guide while restrained to GitHub's markdown format!

Besides GitHub, our primary platform for collaboration is our Discord server which I'd encourage you to join and start a thread there regarding style guide improvements.

By the way, I'm wondering if there's a chance for me to join Catppuccin? I'll have more free time in a month, and I'm really keen to pitch in and help maintain it!

If you mean joining the Catppuccin maintainers team, we usually invite people to the organisation if they have created a port and would like to transfer it under the Catppuccin namespace. Recently, we've documented the current maintainers for the ports in our ports.yml which people are encouraged to add/remove themselves from! I'm still in the progress of documenting/revamping our contributing guidelines to mention this.