Add APIs to support serializable lookup table

theKashey / used-styles

📝All the critical styles you've used to render a page.

MIT License

137 stars 9 forks source link

Closed AlexandrHoroshih closed 2 months ago

AlexandrHoroshih commented 2 months ago

Closes #66 and also probably closes #40

This PR adds two new APIs to properly allow for a serialization of the styles lookup

serializeStylesLookup(def: StyleDef): SerializedStyleDef - creates a serializable object from original styles lookup. Result can be then stringified with JSON.stringify
loadSerializedLookup(def: SerializedStyleDef): StyleDef - transforms serialized style definition back to normal StyleDef, which can be used with any Scanner API

AlexandrHoroshih commented 2 months ago

Hello @theKashey !

I could not explicitly add you to reviewers of this PR (Github won't allow that for some reason), so i will just tag you then 😅

theKashey commented 2 months ago

Great job👍 I'll handle the release during weekend.

The only missing moment is to put fs-based discovery into separate entrypoint and that would handle case for #40

theKashey commented 1 month ago

Published, but as a part of v3 with a breaking change - discoverProjectStyles should be now imported from used-styles/node