Skip to content

pantoken / deprecations

deprecations

Beta

@pantoken/plugin-deprecations — lebenszyklusbewusste Kompatibilitäts‑Shims für entfernte Upstream‑Tokens.

Wenn eine Upstream‑Version ein --instui-*‑Token entfernt, zeichnet ein handgeschriebenes DeprecationLedger seinen Lebenszyklus auf: wann es als veraltet markiert wurde, welches Upstream‑Minor es entfernen wird und wie man es in der Zwischenzeit funktionsfähig hält — entweder Weiterleitung an ein kanonisches Token (replacementvar(...)) oder Einfrieren seines zuletzt bekannten Literals (value). Dieses Plugin fügt pro Eintrag genau ein Shim‑Token hinzu. Da der Shim ein einzelnes var(...) oder ein einfacher Wert ist, dokumentiert defineToken seine refersTo/Syntax und toCss gibt es aus, sodass der Shim ohne zusätzliche Verkabelung in css/scss/less/stylus/wordpress/vanilla übernommen wird.

Das Ausmustern wird an anderer Stelle durchgesetzt (die Upgrade‑Pipeline schlägt einen Bump hart fehl, sobald das Upstream‑Minor des Eintrags removeIn erreicht ist und erzwingt, dass der Eintrag zurückgezogen und eine Consumer‑Minor‑Version erstellt wird). dueForRemoval ist die Prüfung, die das ermöglicht; describeLifecycle treibt die Dokumentation an.

Beispiel

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)] });

Schnittstellen

Funktionen

Referenzen

default

Benennt um und exportiert deprecationShims neu