TypeScript를 사용하여 CLI 도구 빌드

TypeScript로 명령줄 인터페이스(CLI) 도구를 만들면 유형 안전성과 최신 JavaScript 기능이 제공됩니다. TypeScript는 정적 타이핑과 더 나은 툴링 지원을 제공하여 개발 경험을 향상시킵니다. 이 가이드는 TypeScript를 사용하여 CLI 도구를 빌드하는 단계를 다룹니다.

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 스크립트 만들기

CLI 도구의 진입점으로 사용할 TypeScript 파일을 만듭니다. 이 파일은 명령줄 인수를 처리하고 핵심 기능을 구현합니다.

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

결론

TypeScript로 CLI 도구를 빌드하려면 TypeScript 프로젝트를 설정하고, 기본 CLI 스크립트를 만들고, 종속성을 추가하고, 코드를 컴파일해야 합니다. TypeScript의 정적 타이핑과 최신 기능을 활용하면 견고하고 유지 관리가 가능한 CLI 도구를 만들 수 있습니다.