فهرست مستندات پروژه
نصب از آرشیو منبع
بسته منتشرنشده را محلی بسازید و نخستین تبدیل را اجرا کنید.
پیش از نصب، وضعیت انتشار را بررسی کنید
در بررسی ۹ اکتبر ۲۰۲۶، رجیستری npm پاسخ ۴۰۴ داد. انتشار v0.1.0 در GitHub منبع و این راهنماها را در دسترس میگذارد، اما بسته را در npm منتشر نمیکند. بنابراین npm install tiny-finglish برای این نسخه، دستور نصب معتبر از رجیستری نیست. مقدار 0.1.0 در مشخصات بسته با انتشار GitHub هماهنگ است، اما به معنی انتشار در npm نیست.
ساخت آرشیو از نسخه مشخص
برای این مراحل از Node 24 استفاده کنید؛ با نسخه 24.8.0 بررسی شدهاند. مشخصات بسته حداقل Node >=20.10 را اعلام میکند، اما دستور ساخت، اسکریپت تایپاسکریپت را با --experimental-strip-types اجرا میکند که در Node 20 وجود ندارد. جزئیات در نیازمندیهای اجرا آمده است.
git clone https://github.com/eramhq/tiny-finglish.git
cd tiny-finglish
git checkout v0.1.0
npm ci
npm run build
npm pack
دستور npm pack با اجرای prepack دوباره بسته را میسازد و فایل tiny-finglish-0.1.0.tgz را تولید میکند؛ چیزی منتشر نمیکند. شناسه کامیت منبع و هش آرشیو را در سوابق وابستگی برنامه نگه دارید. آرشیو شامل کد ESM، تعریف نوعها، وزنهای مدل، هر دو جدول، README، LICENSE و NOTICE است. جدول جفتواژهها و واژهنامه اختیاری در مخزن میمانند.
از پوشه برنامه خود، آرشیو ساختهشده را با مسیر واقعی نصب کنید:
npm install /absolute/path/to/tiny-finglish/tiny-finglish-0.1.0.tgz
برای تکرارپذیری ساخت برنامه، آرشیو بازبینیشده را در پوشه وابستگیهای محلی نگه دارید و فایل قفل وابستگی برنامه را ثبت کنید. ارم اکنون همین روش را با آرشیوی به نام کامیت منبع به کار میبرد.
نخستین اجرا بدون داده خارجی
کد زیر را در برنامه با نام quick-start.mjs ذخیره و با node quick-start.mjs اجرا کنید:
import { transliterate } from "tiny-finglish";
console.log(transliterate("salam, emrooz miram shiraz").text);
سلم، امروز میرم شیرز
این خروجی ناقص، نتیجه واقعی روش فقط قواعد است. هیچ مدل یا جدول واژهای بارگذاری نشده است. برای رسیدن به خروجی سلام، امروز میرم شیراز با همین ورودی، از بارگذار ترکیبی Node.js یا بارگذار مرورگر استفاده کنید. فراخوانی ساده با دموی وبسایت یکسان نیست.
توسعه در این مخزن
پس از npm ci، دستورهای npm test، npm run typecheck و npm run build را اجرا کنید. npm run playground محیط آزمایش Vite را راه میاندازد و npm run playground:build آن را میسازد. گزینه «rules» در محیط آزمایش، در صورت وجود فایلها همچنان جدول فراوانی و واکه را بارگذاری میکند. برای بررسی قواعد بدون داده، مانند مثال بالا موتور را بدون تنظیم بسازید.