Recent Major/Breaking Changes

[uncenter]

Hey all! Happy holidays! The staff team has been making a few major and/or breaking changes in the last few days, this issue serves as a summary of what users and maintainers each need to know.

User-facing Changes

We have recently made a change in #1544 that renamed all userstyle source files, which is not handled well by Stylus. To remedy this, we have created "stub" userstyles that will serve as an intermediary between the old filename and the new filename. If you update your userstyles in Stylus, or if they get auto-updated in the background, they will no longer work and will say [STUB | UPDATE REQUIRED] in the title. As indicated by the updated title, a second, additional update is required to restore the userstyles to a working state. You can bulk update them all at once by clicking the following button on the Stylus manage page:

Alternatively, it might be quicker to reinstall all userstyles using our generated Stylus import/export file: https://github.com/catppuccin/userstyles/blob/main/docs/USAGE.md#all-userstyles.

Our apologies for the breaking change, and thank you for your understanding!

Developer/Maintainer-facing Changes

As part of #1544, the Prettier formatter was completely removed from our tooling for this repository. Userstyles should now by formatted by Deno's built in formatter, deno fmt, as are all other files. Additionally, because of the source file renames, existing pull requests may need to be updated to edit the correct file and init pull requests will need to rename the new userstyle file and update metadata.

A smaller, quality-of-life change was recently merged as part of #1534/#1535 to switch the userstyle versioning system from "SemVer" to "CalVer". Contributors to this repository are no longer required to and should not update the version of modified userstyles in pull requests - this is now done automatically by GitHub Actions.

[uncenter]

I should note that we do not plan on making any other breaking changes! The mass rename was a one-time-thing and I can't imagine we will ever need to perform a similarly breaking change again.

That being said, we do have one last major - not breaking - change before the end of the year, for developers/maintainers in #1547. Aims to clean up numerous accumulated bugs, and simplify other areas of development. The @accent-color variable has been simplified to @accent, @lookup to @flavor, duplicate media queries were simplified, the recently documented @catppuccin-filters theming method for images was implemented, and some readability lints were added. Users should see no visible changes to userstyle-themed websites.