search

tinted-theming / home

Style systems and smart build tooling for crafting high fidelity color schemes and easily using them in all your favorite apps.
MIT License
254 stars 12 forks source link

Reword the specification, relax builders requirements #23

Closed Misterio77 closed 2 years ago

Misterio77 commented 2 years ago

Hey friends <3

This update is an attempt to make the specification more consistent and clear, as well as relaxing the requirements related to automatic template/scheme fetching by the builders (making simpler builders possible).

This reworked specification (spec.md) replaces builder.md and file.md. I've also (slightly) tweaked the relevant README section to account for this change.

I tried my best to make the specification as clear and complete as possible, while avoiding new restrictions. This should not be a breaking change! I bumped the minor version, but please let me know if it would make sense for this to be a patch update instead. Or perhaps 1.0.0 if we have everyone's blessing to mark base16 as stable :))

I did not include the new variables we discussed (underscored, light/dark) just yet, so that we can discuss these separetely.

Please let me know what you think!

PS: I plan on following up (on another PR, of course) later with my proposal of a minimal reference builder specification.

Misterio77 commented 2 years ago

Oh and a quick question.

As templates (repositories) can include multiple templates (mustache files), I propose we call them template sets (what a template repository has) and templates (the individual mustache files).

What do you folks think? Should we keep calling both templates, or maybe template/subtemplate?

Misterio77 commented 2 years ago

And quick note:

I mentioned I relaxed builder specifications, but they were always kind of relaxed (as they were called guidelines). This PR should cleanly split what is a requirement for the spec (the specific template variables), and what is a guideline (how to output it, fetching stuff from git, etc).

The repository specifications were converted into a "repositories and ecossystem" section, as a kind of documentation on where things are located now :)

belak commented 2 years ago

I tried to take as many of the changes which were backwards compatible and merged them in via #29. If you think there's anything which still needs to be added, please feel free to reopen or resubmit this.