Skip to content

pantoken / deprecations

deprecations

Beta

@pantoken/plugin-deprecations — livssyklusbevisste kompatibilitetsshims for upstream-tokens som er fjerna.

Når ei upstream-utgåve introduserer ein --instui-*-token, registrerer ein handskrive DeprecationLedger livssyklusen hennar: når ho blei markert som deprecated, hvilken upstream minor som kjem til å fjerne ho, og korleis ho heldast i gang i mellomtida — anten videresendt til ein kanonisk token (replacementvar(...)) eller fryse den sist kjende literalen (value). Denne pluginen legg til éin shim-token per oppføring. Sidan shim-en er ein enkel var(...) eller ein rein verdi, registrerer defineToken hennar refersTo/syntaks og toCss emitterer ho, så shim-en følgjer med inn i css/scss/less/stylus/wordpress/vanilla utan ekstra kopling.

Utfasinga blir handheva andre stader (oppgraderingspipeline feilar hardt på eit bump når ein oppføring når upstream-minor-versjonen sett i removeIn, og tvinger oppføringa til å bli utfasa og at det blir laga ein ny minorversjon for forbrukarar). dueForRemoval er sjekken som driv dette; describeLifecycle driv dokumentasjonen.

Døme

ts
import { buildTokens } from "@pantoken/core/build";
import { deprecationShims } from "@pantoken/plugin-deprecations";
import ledger from "@pantoken/tokens/deprecations.json" with { type: "json" };

buildTokens({ theme: "rebrand", plugins: [deprecationShims(ledger)] });

Grensesnitt

Funksjonar

Referansar

default

Omdøyper og re-eksporterer deprecationShims