TypeScript ile bir CLI Aracı Oluşturma

TypeScript ile bir Komut Satırı Arayüzü (CLI) aracı oluşturmak, tür güvenliği ve modern JavaScript özellikleri sağlar. TypeScript, statik yazım ve daha iyi araç desteği sunarak geliştirme deneyimini geliştirir. Bu kılavuz, TypeScript kullanarak bir CLI aracı oluşturma adımlarını kapsar.

Adım 1: TypeScript Projenizi Kurun

Yeni bir TypeScript projesi kurarak başlayın. Yeni bir npm projesi başlatın ve TypeScript ile diğer bağımlılıkları yükleyin.

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

ts-node paketi TypeScript dosyalarının doğrudan çalıştırılmasına olanak tanırken, @types/node paketi Node.js için tür tanımları sağlar.

Adım 2: Temel bir CLI Komut Dosyası Oluşturun

CLI aracı için giriş noktası görevi görecek bir TypeScript dosyası oluşturun. Bu dosya komut satırı argümanlarını işleyecek ve çekirdek işlevselliği uygulayacaktır.

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

Burada, commander paketi komut satırı argümanlarını işlemek ve komutları ve seçenekleri tanımlamak için basit bir arayüz sağlamak amacıyla kullanılır.

Adım 3: CLI Bağımlılıklarını Ekleyin

CLI aracını oluşturmak için gereken ek bağımlılıkları yükleyin. Bu örnek için, argüman ayrıştırma için commander kullanılır.

npm install commander

Adım 4: TypeScript Kodunu Derleyin

TypeScript kodunu JavaScript'e derleyin. Bu adım CLI aracını dağıtmak için gereklidir.

npx tsc

Adım 5: Yürütülebilir Bir Komut Dosyası Oluşturun

package.json dosyasını bin bölümünü içerecek şekilde güncelleyin. Bu bölüm CLI komutunu derlenmiş JavaScript dosyasına eşler.

{
  "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"
  }
}

Adım 6: CLI Aracınızı Test Edin

Yayımlamadan önce test etmek için CLI aracını yerel olarak bağlayın. Küresel node_modules dizininde bir sembolik bağlantı oluşturmak için npm link kullanın.

npm link
my-cli-tool --name TypeScript

Çözüm

TypeScript ile bir CLI aracı oluşturmak, bir TypeScript projesi kurmayı, temel bir CLI betiği oluşturmayı, bağımlılıklar eklemeyi ve kodu derlemeyi içerir. TypeScript'in statik yazımından ve modern özelliklerinden yararlanarak, sağlam ve sürdürülebilir CLI araçları oluşturmak mümkündür.