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

Proposal: deprecate "slugify" and require color schemes to specify a slug #94

Open
belak opened this issue Mar 27, 2024 · 1 comment
Open

Comments

@belak
Copy link
Member

belak commented Mar 27, 2024

This came up in tinted-theming/schemes#8.

Essentially, we should drop the definition of "slugify" from the builder because it's relatively hard to understand and requires Unicode case folding to properly be implemented, meaning it's relatively easy to implement incorrectly as well.

We can do this by making "slug" a required field in the metadata.

I'm not certain if this would count as a breaking change or not, because if a builder properly implements spec-0.11, it would also support this new format. However, if a spec-0.11 scheme without a slug was passed to a builder which removed support for slugify, it would fail.

@JamyGolden
Copy link
Member

I'd say it's a breaking change for the builder.md spec because it's making an optional property required. A scheme missing a slug property should be allowed after this change.

I like the idea of requiring a slug though. We should have a basic github actions test on the schemes repo to ensure that all schemes match the required schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants