בניית כלי CLI עם TypeScript

יצירת כלי Command-line Interface (CLI) עם TypeScript מספקת בטיחות סוג ותכונות JavaScript מודרניות. TypeScript משפר את חווית הפיתוח על ידי מתן הקלדה סטטית ותמיכה טובה יותר בכלים. מדריך זה מכסה את השלבים לבניית כלי CLI באמצעות 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: צור סקריפט CLI בסיסי

צור קובץ 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 חזקים וניתנים לתחזוקה.

כתב כתיבה cli שורת פקודה תוכנית מפקד בנייה התקנה תלות קומפילציה חבילה bin script