إنتقل إلى المحتوى الرئيسي

التثبيت

المتطلبات​

  • Node.js: >= 22.12.0 (محدد في حقل engines الخاص بالحزمة).
  • مدير حزم: npm أو yarn أو pnpm.

تتضمن الحزمة بنيتي ESM (dist/index.js) وCommonJS (dist/index.cjs)، مع تعريفات TypeScript (dist/index.d.ts). لا تحتاج إلى حزم @types إضافية.

التثبيت على مستوى النظام (موصى به لسطر الأوامر)​

يتيح التثبيت على مستوى النظام الوصول إلى الملف التنفيذي openapi-cli عبر PATH:

npm install -g @powerduck/openapi-cli

تحقق من الملف التنفيذي:

openapi-cli --help

التثبيت داخل المشروع (موصى به للتكامل المستمر)​

ثبّت الإصدار داخل المشروع ليستخدم التكامل المستمر إصدارًا معروفًا:

npm install --save-dev @powerduck/openapi-cli

ثم شغّل الأمر عبر مدير الحزم:

npx openapi-cli --spec openapi.json
# or
pnpm exec openapi-cli --spec openapi.json

تشغيل لمرة واحدة باستخدام npx​

دون تثبيت مسبق:

npx @powerduck/openapi-cli --spec openapi.json

بنية الحزمة​

نقطة الدخولالمسار
نقطة دخول ESMdist/index.js
نقطة دخول CommonJSdist/index.cjs
تعريفات الأنواعdist/index.d.ts
نقطة دخول CLI (bin)dist/cli.js
اسم الملف التنفيذيopenapi-cli

تعلن الحزمة "type": "module" وتتيح فقط المسارين الفرعيين . و./package.json.

الاستيراد في الشيفرة​

// ESM
import { runTests, resolveConfig } from "@powerduck/openapi-cli";

// CommonJS
const { runTests, resolveConfig } = require("@powerduck/openapi-cli");

اعتماديات وقت التشغيل​

تعتمد الحزمة المنشورة على:

  • @powerduck/openapi-parser (^0.3.12) — حل مراجع $ref الداخلية.
  • @powerduck/openapi-request (0.2.22) — تنفيذ طلبات البروتوكولات.
  • commander (^12.1.0) — تحليل وسيطات سطر الأوامر.
  • https-proxy-agent (^5.0.1) — دعم الوكيل لنقل HTTP.

الخطوات التالية​