MIGRATION GUIDE (follow if your config magically broke!)

[pocco81]

Heya! After #169 was opened a bunch of changes have taken place. Some of them have arrived earlier to the main branch, however most still live under the dev branch. Not all of the interfaces were changed but the ones that were might break your config if not updated.

So, here is this issue to aid in those situations. In the meantime, while I finish reworking the whole plugin you may stay in the main branch and follow this issue to be up-to-date with everything.

Note 1: the dev branch can be merged into main at any time! beware!
Note 2: some new features are subject to change while they are still under development

Heads-ups!

1. invalid key: bold,italic #177: a commit was amended and because of that I had force push it to the repo. If your plugin fails to update (because most plugin managers mishandle this kind of thing): delete the plugin's directory and reinstall it.
2. refactor(performance): Improve nvim_set_hl #176: the way highlights are handled changed, most notably the style property of the highlights. Instead of using commas to separate them (e.g. style = "italic,bold,underline"), please use a Lua table. Note that if you don't want any highlights just pass an empty table {}. For the average user's conf this would mean that:

	styles = {
		comments = { "italic" },
		conditionals = { "italic" },
		loops = {},
	},

This also applies to custom highlights. (Note: in this case you may either pass an empty table to style for none, or not pass style in the first place)

custom_highlights = {
        TSConstBuiltin = { fg = cp.peach, style = {} },
        TSConstant = { fg = cp.sky },
        TSComment = { fg = cp.surface2, style = { "italic" } }
    }

3. c41a627: the code-base was refactored and now:

• palettes: holds the palettes and the interface to fetch them
• utils: general utilities for handling data and color properties
• groups: holds the highlights groups and integrations
• lib: main code. Holds the compiler, highlighter, mapper, ui and hsluv

So please don't forget to change your calls to any of Catppuccin's modules!

4. This ain't much of a breaking feature but since the new update users are now able to pre-compile their configs to improve startup speed. Check it out!

• Startuptime stat: 0.7ms

012.793  000.096  000.096: require('catppuccin')
012.835  000.035  000.035: require('catppuccin.config')
013.356  000.005  000.005: require('vim.F')
014.246  000.669  000.669: sourcing /home/nullchilly/.local/share/nvim/site/pack/packer/start/theme/colors/catppuccin.lua

[Icy-Thought]

README.md contains incorrect information regarding integrations.
Example: the following points to a non-existent file.

components = require('catppuccin.core.integrations.feline'),

[rewhile]

@Icy-Thought Fixed, thanks you :)

[Icy-Thought]

@nullchilly glad to help out! :)
(Link points to main repo and not groups/integtation btw)

[Icy-Thought]

Don't know if I am the only one, but using the newer version of feline integration results in an empty Feline bar.

My Catppuccin and Feline configurations can be found in their resp. links.

[pocco81]

My bad @Icy-Thought! I forgot to update the doc for feline. It should be:

"catppuccin.groups.integrations.feline".get()

I also added a feature to further customize its components:

"catppuccin.groups.integrations.feline".setup(<customize here>)

I'll update the doc ASAP :)