Skip to content

pantoken / deprecations

deprecations

بتا

@pantoken/plugin-deprecations — شیم‌های سازگاری آگاه از چرخهٔ عمر برای توکن‌های حذف‌شده در بالادست.

وقتی یک انتشار بالادستی یک توکن --instui-* را حذف می‌کند، یک DeprecationLedger دست‌نویس چرخهٔ عمر آن را ثبت می‌کند: چه زمانی منسوخ شد، کدام نسخهٔ خرد (minor) بالادست آن را حذف خواهد کرد، و چگونه در این بین آن را به کار نگه داشت — یا هدایت به توکنcanonical (replacementvar(...)) یا فریز کردن آخرین مقدار شناخته‌شده‌اش (value). این پلاگین برای هر ورودی یک توکن شیم اضافه می‌کند. چون شیم یک var(...) واحد یا یک مقدار ساده است، defineToken نوع/نحو آن را به‌عنوان refersTo ثبت می‌کند و toCss آن را منتشر می‌کند، بنابراین شیم بدون سیم‌کشی اضافی وارد css/scss/less/stylus/wordpress/vanilla می‌شود.

بازنشستگی در جای دیگری اعمال می‌شود (خط لولهٔ ارتقاء پس از رسیدن به نسخهٔ خرد بالادستِ removeIn یک ورودی، با خطا متوقف می‌شود و مجبور به بازنشسته‌شدن آن ورودی و برش یک نسخهٔ خرد برای مصرف‌کننده می‌شود). dueForRemoval بررسی‌ای است که این را تأمین می‌کند؛ describeLifecycle اسناد را تولید می‌کند.

نمونه

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

رابط‌ها

توابع

ارجاعات

default

تغییر نام و صادر مجدد deprecationShims