إنشاء أداة CLI باستخدام TypeScript

يوفر إنشاء أداة واجهة سطر الأوامر (CLI) باستخدام TypeScript أمانًا للأنواع وميزات JavaScript الحديثة. يعمل TypeScript على تحسين تجربة التطوير من خلال تقديم الكتابة الثابتة ودعم أفضل للأدوات. يغطي هذا الدليل الخطوات اللازمة لإنشاء أداة واجهة سطر الأوامر باستخدام TypeScript.

الخطوة 1: إعداد مشروع TypeScript الخاص بك

ابدأ بإعداد مشروع TypeScript جديد. قم بتشغيل مشروع npm جديد وقم بتثبيت TypeScript والتبعيات الأخرى.

npm init -y
npm install typescript ts-node @types/node --save-dev
npx tsc --init

تتيح لك الحزمة ts-node تشغيل ملفات TypeScript مباشرة، بينما توفر @types/node تعريفات النوع لـ Node.js.

الخطوة 2: إنشاء نص برمجي أساسي لواجهة سطر الأوامر

قم بإنشاء ملف TypeScript ليكون بمثابة نقطة الدخول لأداة CLI. سيتولى هذا الملف التعامل مع وسيطات سطر الأوامر وتنفيذ الوظائف الأساسية.

import { Command } from 'commander';

const program = new Command();

program
  .version('1.0.0')
  .description('A simple CLI tool')
  .option('-n, --name <name>', 'Specify the name')
  .action((options) => {
    console.log(`Hello, ${options.name || 'World'}!`);
  });

program.parse(process.argv);

هنا، يتم استخدام الحزمة commander للتعامل مع وسيطات سطر الأوامر وتوفير واجهة بسيطة لتحديد الأوامر والخيارات.

الخطوة 3: إضافة تبعيات CLI

قم بتثبيت التبعيات الإضافية المطلوبة لبناء أداة CLI. في هذا المثال، يتم استخدام commander لتحليل الوسيطات.

npm install commander

الخطوة 4: تجميع كود TypeScript

قم بتجميع كود TypeScript إلى JavaScript. هذه الخطوة ضرورية لتوزيع أداة CLI.

npx tsc

الخطوة 5: إنشاء نص برمجي قابل للتنفيذ

قم بتحديث ملف package.json ليشمل قسم bin. يقوم هذا القسم بربط أمر CLI بملف JavaScript المجمّع.

{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "bin": {
    "my-cli-tool": "./dist/index.js"
  },
  "scripts": {
    "build": "tsc",
    "start": "ts-node src/index.ts"
  },
  "dependencies": {
    "commander": "^8.3.0"
  },
  "devDependencies": {
    "@types/node": "^14.14.31",
    "typescript": "^4.3.5",
    "ts-node": "^10.2.1"
  }
}

الخطوة 6: اختبار أداة CLI الخاصة بك

قم بربط أداة CLI محليًا لاختبارها قبل النشر. استخدم npm link لإنشاء ارتباط رمزي في الدليل العالمي node_modules.

npm link
my-cli-tool --name TypeScript

خاتمة

يتضمن إنشاء أداة CLI باستخدام TypeScript إعداد مشروع TypeScript وإنشاء نص برمجي CLI أساسي وإضافة التبعيات وتجميع التعليمات البرمجية. من خلال الاستفادة من الكتابة الثابتة والميزات الحديثة في TypeScript، من الممكن إنشاء أدوات CLI قوية وقابلة للصيانة.

TypeScript سطر الأوامر برنامج قائد بناء تثبيت تبعية تجميع حزمة صندوق نص برمجي