[번역] Commander.js와 Typescript를 이용하여 CLI 만들기

타입스크립트와 Commander.js를 활용하여 CLI를 만들어 봅니다.

ts+node

Node.js에서 CLI를 만드는 것은 Commander.js와 같은 강력한 라이브러리 덕분에 그리 복잡하지 않습니다.

Node.js를 TypeScript와 함께 사용하면 개발 프로세스 초기에 버그를 발견하여 보다 안정적이고 버그가 적은 CLI를 제공할 수 있습니다.

이 튜토리얼에서는 CLI와, Commander.js를 TypeScript와 함께 사용하는 방법에 대해 설명합니다.
그런 다음 사용자가 시스템 어디에서나 액세스할 수 있도록 CLI를 전역적으로 액세스할 수 있도록 합니다.

---

왜 Commander.js를 사용하나요?

Commander.js는 간결하게 CLI를 구축할 수 있는 많은 기능을 제공합니다. 또한

Node.js 커뮤니티는 Commander.js CLI를 보완하여 시각적으로 매력적으로 보이도록 하는 Chalk 및 Figlet과 같은 라이브러리를 제공합니다.

그리고 현재 가장 많이 쓰이는 CLI 빌드 도구입니다.

구체적으로는 다음 기능 때문에 Commander.js를 사용합니다.

• 계층적 명령 지원
  • 메인 명쳥과 서브 명령
• 가변형, 필수값, 선택값과 같은 다양한 명령줄 옵션 지원
• 커스텀 이벤트 리스너
• 자동으로 help 설명 생성

---

CLI 이해하기

CLI 구축을 시작하기 전에 기존 CLI가 어떻게 작동하는지 살펴보겠습니다.

Node.js는 터미널에 node를 입력하여 액세스할 수 있는 CLI를 제공합니다.

아래 명령을 입력하면 JavaScript 코드를 입력하고 실행할 수 있는 Node.js REPL(read-eval-print loop)에 액세스할 수 있습니다.

node

명령줄 플래그 또는 옵션을 사용하여 다른 작업을 수행하도록 Node.js CLI를 수정할 수 있습니다.
CTRL+D를 사용하여 REPL을 종료한 다음 -v 옵션을 사용하여 Node.js 버전을 확인합니다.

node -v
// v18.11.0

-v 옵션을 전달하면 Node.js 버전을 표시하도록 노드 CLI의 동작이 변경됩니다.

긴 형식 옵션을 사용할 수도 있습니다.

node --version
// v18.11.0

다른 Node.js CLI 옵션에는 옵션과 함께 인수를 전달해야 합니다.

예를 들어 --eval의 짧은 형식인 -e 옵션은

JavaScript 코드가 포함된 문자열 인수를 허용합니다.

node는 코드를 실행하고 결과를 터미널에 로깅합니다.

node -e "console.log(4 * 2)"
// 8​

-e 옵션은 인수가 전달되지 않으면 오류를 반환합니다.

node -e
// node: -e requires an argument​

이제 CLI가 작동하는 방식에 대한 통찰을 얻었습니다.

• 긴 형식 옵션, 짧은 형식 옵션
• 필수 인수

지금까지 본 Node CLI 옵션에 대한 Commander.js 용어를 살펴보겠습니다.

• Boolean 옵션:
  • 이 옵션에는 인수가 필요하지 않습니다.
  • -v는 부울 옵션의 예입니다.
  • 다른 친숙한 예는 ls -l 또는 sudo -i입니다.
• Required 옵션:
  • 이 옵션에는 인수가 반드시 필요합니다.
  • 예를 들어 node -e "console.log(4 * 2)" 인수가 전달되지 않으면 오류가 발생합니다.
•  Option 인수:
  • 옵션에 전달되는 인수입니다.
  • node -e "console.log(4 * 2)" 명령에서 "console.log(4 * 2)"는 옵션 인수입니다.
  • 또 다른 예는 git status -m "commit message"입니다.
  • 여기서 "commit message"는 -m 옵션에 대한 옵션 인수입니다.

이제 CLI가 무엇인지 이해했으므로 디렉터리를 만들고 TypeScript 및 Commander.js를 사용하도록 설정합니다.

---

Typescript 시작 및 설정하기 

프로젝트의 디렉터리를 만들고 npm 프로젝트를 초기화하고 필요한 모든 종속성을 설치하고 TypeScript를 설정합니다.

 

먼저 프로젝트의 디렉터리를 만듭니다.

mkdir directory_manager

디렉터리로 현재 경로를 변경합니다.

cd directory_manager

디렉터리를 npm 프로젝트로 초기화합니다.

npm init -y

이렇게 하면 프로젝트 및 종속성 추적을 위한 중요한 정보가 포함된 package.json 파일이 생성됩니다.

그 다음으로 다음 명령을 실행합니다.

npm install commander figlet

Commander.js는 CLI를 구축하기 위한 라이브러리이며

Figlet은 CLI 텍스트를 ASCII 아트로 변환하는 데 사용됩니다.

 

다음으로 TypeScript 및 ts-node 패키지를 다운로드합니다.

npm install @types/node typescript --save-dev

이제 텍스트 편집기에서 tsconfig.json 파일을 만들고 TypeScript에 대해 다음 config 설정을 추가합니다.

{
  "compilerOptions": {
    "rootDir": "src",
    "outDir": "dist",
    "strict": true,
    "target": "es6",
    "module": "commonjs",
    "sourceMap": true,
    "esModuleInterop": true,
    "moduleResolution": "node"
  }
}

compilerOptions의 몇 가지 서브 옵션을 살펴보겠습니다.

• rootDir: CLI용 TypeScript 파일(.ts 파일)을 포함할 디렉터리로, src 디렉터리에 보관합니다.
• outDir: TypeScript로 컴파일된 JavaScript 소스 코드를 포함할 디렉토리입니다. 우리는 dist 디렉토리를 사용할 것입니다
• strict: 선택적 타이핑을 비활성화하고 작성하는 모든 TypeScript 코드에 유형이 있는지 확인합니다.
• target: TypeScript가 JavaScript를 컴파일해야 하는 ECMAScript 버전

모든 옵션을 종합적으로 살펴보려면 TypeScript documentation를 참조하세요.

다음으로 package.json 파일에서 TypeScript를 컴파일하는 데 사용할 빌드 스크립트를 만듭니다.

{
  ...
  "scripts": {
    // add the following line
    "build": "npx tsc",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  ...
}

TypeScript를 컴파일 하는 방법 : 

npm run build로 빌드 스크립트를 실행하면 TypeScript를 JavaScript로 컴파일하는 npx tsc 명령이 실행됩니다.

 

이제 TypeScript를 설정 완료하였고, TypeScript를 컴파일하기 위한 스크립트를 추가했습니다.
다음으로 CLI 구축을 시작합니다.

---

타입스크립트로 CLI 만들기

이 섹션에서는 TypeScript와 Commander.js를 사용하여 CLI 구축을 시작합니다. 
우리가 만들 CLI는 다음과 같습니다.

CLI 출력 이미지

우리가 만들 CLI는 디렉토리를 관리하는 데 사용됩니다.

• 디렉토리 내용을 테이블 형식으로 나열하는 -l 옵션이 있습니다.
• 각 항목에 대해 이름, 크기 및 생성 날짜가 표시됩니다.
• 또한 디렉토리를 생성하기 위한 -m과 빈 파일을 생성하기 위한 -t 옵션도 있습니다.

 

CLI를 더 작은 청크로 나누고 각 부분을 구축하기 시작해 봅시다.

---

CLI로 프로젝트 이름 출력하기

이 섹션에서는 CLI의 이름을 만들고 Figlet 패키지를 사용하여 ASCII 아트 텍스트로 변환합니다.

변환이 완료되면 다음과 같이 표시됩니다.

ASCII 출력 결과

프로젝트 디렉토리에서 src 디렉토리를 만들고 그 디렉토리로 이동합니다.

mkdir src && cd src

이 디렉토리에는 TypeScript 파일이 포함됩니다.
이전 자습서에서 tsconfig.js 파일로 TypeScript를 설정할 때
rootDir 옵션에 이 디렉터리를 지정했다는 것을 떠올립니다.

 

다음으로 index.ts 파일을 만들고 다음 콘텐츠를 추가합니다.

const figlet = require("figlet");

console.log(figlet.textSync("Dir Manager"));

첫 번째 줄에서 Figlet 모듈을 임포트 합니다.
다음으로 문자열 Dir Manager를 인수로 사용하여 figlet.textSync() 메서드를 호출하여 텍스트를 ASCII Art로 바꿉니다.
마지막으로 콘솔에 텍스트를 기록합니다.

변경 사항이 작동하는지 확인하려면 파일을 저장하십시오.

다음 명령을 사용하여 TypeScript 파일을 JavaScript로 컴파일합니다.

npm run build

TypeScript가 컴파일을 완료하면 다음과 같은 출력이 표시됩니다.

// output
> typescript_app@1.0.0 build
> npx tsc

성공하면 여기에 오류가 표시되지 않습니다.

outDir 옵션을 추가하고 tsconfig.json 파일의 dist 디렉토리로 설정한 것을 기억하시죠?
TypeScript를 컴파일하면 루트 디렉터리에 디렉터리가 자동으로 생성됩니다.

 

dist 디렉토리로 이동합니다.

cd ../dist

디렉터리 내용을 나열합니다.

ls

// output
index.js  index.js.map

index.js 파일이 생성된 것을 확인할 수 있습니다. 다음과 같이 Node.js로 파일을 실행할 수 있습니다.

node index.js

해당 명령을 실행하면 ASCII 아트로 CLI 이름이 표시됩니다.

ASCII Art

 

이제 루트 디렉토리로 되돌아갑니다.

cd ..

앞으로 파일을 실행하기 위해 dist 디렉토리로 이동하지 않을 것입니다.
node dist/index.js로 루트 디렉터리에서 이 작업을 수행합니다.

---

CLI로 프로젝트 이름 출력하기

이 섹션에서는 Commander.js를 사용하여 CLI 및 해당 옵션에 대한 설명을 생성합니다.
다음 옵션을 생성합니다.

생성된 옵션 모습

-V 옵션은 Commander.js version() 메서드를 호출하고 -h는 기본적으로 제공됩니다.

이제 세 가지 옵션을 정의해야 합니다.

• -l / --ls : 테이블의 디렉터리 내용을 나열하도록 CLI를 수정합니다. 옵셔널한 디렉터리 경로 인수도 허용합니다.
• -m / --mkdir: 디렉토리를 생성하는 데 사용됩니다. 생성할 디렉토리의 이름 옵션 인수가 필수입니다.
• -t / --touch: 빈 파일을 생성하도록 CLI를 수정합니다. 파일 이름 옵션 인수가 필수입니다.

이제 생성할 옵션을 알았으므로 Commander.js를 사용하여 해당 옵션을 정의합니다.

Commander.js를 사용하여 옵션 정의

텍스트 편집기에서 index.ts 파일을 열고 다음 코드를 추가하여 Commander.js를 임포트 및 초기화 합니다.

const { Command } = require("commander"); // add this line
const figlet = require("figlet");

//add the following line
const program = new Command();

console.log(figlet.textSync("Dir Manager"));

첫 번째 줄에서 Commander.js 모듈을 가져오고 Command 클래스를 추출합니다.

그런 다음 program 변수에 Command 클래스의 인스턴스를 할당합니다.

이 클래스는 버전, 설명 및 CLI 옵션을 설정하는 데 사용할 수 있는 여러 메서드를 제공합니다.

 

다음으로 index.ts 파일에서 CLI 옵션을 정의합니다.

...

program
  .version("1.0.0")
  .description("An example CLI for managing a directory")
  .option("-l, --ls  [value]", "List directory contents")
  .option("-m, --mkdir <value>", "Create a directory")
  .option("-t, --touch <value>", "Create a file")
  .parse(process.argv);

const options = program.opts();

 

Commander 인스턴스를 포함하는 program 변수를 사용하여 version() 메서드를 호출합니다.
version() 메서드는 CLI 버전이 포함된 문자열을 사용하고

Commander는 -V 옵션을 자동으로 생성합니다.

 

다음으로 CLI 프로그램을 설명하는 텍스트와 함께 description() 메서드 호출을 연결합니다.

그런 다음 Commander 패키지의 option() 메서드에 대한 호출을 연결합니다.

이 메서드는 option과 description이라는 두 가지 인수를 사용합니다.

• 첫 번째 인수는 -l 옵션과 긴 이름 --ls를 지정하는 문자열입니다.
  • 그 다음 옵션이 선택적 인수를 허용할 수 있도록 값을 []로 래핑합니다.
• 두 번째 인수는 사용자가 -h 플래그를 사용할 때 표시되는 도움말 텍스트입니다.

 

다음으로 다른 option() 메서드 호출을 연결하여 -m / --mkdir 옵션을 정의합니다.

<value>의 <>는 인수가 필수임을 나타냅니다.

그런 다음 또 다른 option()을 연결하여 -t 옵션과 인수가 필요한 긴 이름 --touch를 정의합니다.

다음으로 사용자가 전달한 인수를 포함하는 배열인 process.argv의 인수를 처리하는 parse() 메서드 호출을 연결합니다.

첫 번째 인수는 노드이고 두 번째 인수는 프로그램 파일 이름이며 나머지는 추가 인수입니다.

node index.js

마지막으로 옵션 변수를 객체를 반환하는 program.opts() 호출로 설정합니다.
객체에는 속성으로 CLI 옵션이 있으며 해당 값은 사용자가 전달한 인수입니다.

 

이 시점에서 index.ts 파일은 다음과 같습니다.

const { Command } = require("commander");
const figlet = require("figlet");

const program = new Command();

console.log(figlet.textSync("Dir Manager"));

program
  .version("1.0.0")
  .description("An example CLI for managing a directory")
  .option("-l, --ls  [value]", "List directory contents")
  .option("-m, --mkdir <value>", "Create a directory")
  .option("-t, --touch <value>", "Create a file")
  .parse(process.argv);

const options = program.opts();

변경을 마쳤으면 파일을 저장한 다음 TypeScript를 컴파일합니다.

npm run build

CLI 도움말 페이지를 보려면 -h 옵션과 함께 index.js를 실행하십시오.

node dist/index.js -h

command을 실행하면 페이지가 다음과 같이 표시됩니다.

command 실행 결과

-V 옵션도 사용해 봅시다.

node dist/index.js -V
// 1.0.0

지금까지 -h 및 -V 옵션은 문제 없이 동작합니다. 정의한 다른 옵션을 시도하면 CLI 이름만 표시됩니다.

node dist/index.js -l

정의한 옵션을 사용할 경우

이는 다른 옵션에 대한 작업(액션)을 정의하지 않았기 때문에 발생합니다.

---

CLI를 위한 액션 정의하기

지금까지 CLI에 대한 옵션을 정의했지만 해당 옵션과 연관된 액션이 없습니다.
이 섹션에서는 사용자가 옵션을 사용할 때 CLI가 관련 액션을 수행하도록 액션을 정의합니다.

-l 옵션부터 시작하겠습니다. CLI가 다음 필드가 있는 테이블에 디렉터리 내용을 표시하기를 원합니다.

• Filename
• Size(KB)
• created_at

사용자는 옵셔널 인수인 디렉터리 경로를 제공할 수도 있습니다.

node dist/index.js -l /home/username/Documents

사용자가 옵션 인수를 전달하지 않으면 CLI는 실행 중인 index.js 파일 위치의 콘텐츠만 표시합니다.

node dist/index.js -l

index.ts 파일에서 fs 및 path 모듈을 임포트 합니다.

const { Command } = require("commander");
// import fs and path modules
const fs = require("fs");
const path = require("path");
const figlet = require("figlet");

파일 끝에 exception handler가 있는 listDirContents() 함수를 정의합니다.

const { Command } = require("commander");
...
const options = program.opts();

//define the following function
async function listDirContents(filepath: string) {
  try {

  } catch (error) {
    console.error("Error occurred while reading the directory!", error);
  }
}

listDirContents() 비동기 함수는 문자열의 TypeScript 타입 선언이 있는 filepath 매개변수를 사용합니다.

이 타입은 함수가 문자열만 인수로 허용하며, 접두사로 사용하는 async 키워드가 함수를 비동기식으로 만듭니다.

 

함수 내에 지금은 비어 있는 try 블록을 정의합니다.

여기에는 디렉토리 내용을 나열하고 결과를 표로 포매팅하는 기능이 포함됩니다.

그런 다음 try 블록에 포함된 코드에 예외가 있는 경우 콘솔에 메시지를 기록할 catch 블록을 정의합니다.

 

listDirContents() 함수에 디렉토리 컨텐츠 항목을 나열하는 코드를 추가해 보겠습니다.

async function listDirContents(filepath: string) {
  try {
    // add the following
    const files = await fs.promises.readdir(filepath);
    const detailedFilesPromises = files.map(async (file: string) => {
      let fileDetails = await fs.promises.lstat(path.resolve(filepath, file));
      const { size, birthtime } = fileDetails;
      return { filename: file, "size(KB)": size, created_at: birthtime };
    });
  } catch (error) {
    console.error("Error occurred while reading the directory!", error);
  }
}​

먼저 filepath 매개변수의 값으로 fs.promises.readdir()을 호출하여 디렉토리 내용을 읽습니다.

• 이 함수는 Promise을 반환하므로 resolved 될 때까지 기다리기 위해 앞에 await 키워드를 붙입니다.
• resolved되면 file이 스트링 배열이 됩니다.

둘째, files 배열의 각 요소를 반복하고 비동기 콜백을 사용하는 map() 메서드를 사용하여 새 배열을 반환합니다.

콜백은 파일 매개변수를 허용합니다.

콜백에서 파일의 전체 경로와 함께 fs.promises.lstat()를 호출하여

size, birthtime 및 info와 같은 파일에 대한 자세한 정보를 가져옵니다.

 

그런 다음 size 및 birthtime 속성을 추출하고

filename, size(KB) 및 created_at 속성이 있는 객체를 map() 메서드가 반환하는 배열로 반환하여 detailFilesPromise 변수로 반환합니다.

 

try 블록의 끝에 다음 코드를 추가하여 디렉터리 내용을 표시하는 테이블을 만듭니다.

async function listDirContents(filepath: string) {
  try {
    const files = await fs.promises.readdir(filepath);
    const detailedFilesPromises = files.map(async (file: string) => {
      let fileDetails = await fs.promises.lstat(path.resolve(filepath, file));
      const { size, birthtime } = fileDetails;
      return { filename: file, "size(KB)": size, created_at: birthtime };
    });
    // add the following
    const detailedFiles = await Promise.all(detailedFilesPromises);
    console.table(detailedFiles);
  } catch (error) {
    console.error("Error occurred while reading the directory!", error);
  }
}

DetailedFilesPromise의 각 요소는 Promise를 반환하고 해결되면 객체로 평가됩니다.
모두 resolve될 때까지 기다리기 위해 Promise.all() 메서드를 호출합니다.

마지막으로, 데이터를 콘솔에 기록하기 위해 detailFiles 배열과 함께 console.table()을 호출합니다.

이제 -m 옵션에 대한 작업을 정의해 보겠습니다.
listDirContents() 함수 아래에 createDir() 함수를 정의합니다.

 

CreateDir() 함수에서 주어진 디렉토리 경로가 존재하는지 확인합니다.
존재하지 않는 경우 fs.mkdirSync()를 호출하여 디렉토리를 생성한 다음 성공 메시지를 기록합니다.

async function listDirContents(filepath: string) {
  ...
}

// create the following function
function createDir(filepath: string) {
  if (!fs.existsSync(filepath)) {
    fs.mkdirSync(filepath);
    console.log("The directory has been created successfully");
  }
}

이 함수를 호출하기 전에 -t 플래그에 대한 createFile() 함수를 정의합니다.

async function listDirContents(filepath: string) {
  ...
}

function createDir(filepath: string) {
  ...
}
// create the following function
function createFile(filepath: string) {
  fs.openSync(filepath, "w");
  console.log("An empty file has been created");
}

createFile() 함수에서 fs.openSync()를 호출하여 주어진 경로에 빈 파일을 생성합니다.
그런 다음 터미널에 확인 메시지를 기록합니다.

 

지금까지 3개의 함수를 만들었지만 아직 호출하지는 않았습니다.
이를 위해서는 사용자가 옵션을 사용했는지 확인하여 적절한 함수를 호출할 수 있어야 합니다.

 

사용자가 -l 또는 --ls 옵션을 사용했는지 확인하려면 index.ts에 다음을 추가합니다.

...
function createFile(filepath: string) {
  ...
}
// check if the option has been used the user
if (options.ls) {
  const filepath = typeof options.ls === "string" ? options.ls : __dirname;
  listDirContents(filepath);
}

options.ls 값이 설정된 경우, option.ls가 문자열인 경우 filepath 변수를 사용자가 제공한 경로로 설정합니다.

그렇지 않으면 dist 디렉터리에 있는 index.js 파일의 파일 경로로 설정됩니다.

그런 다음 filepath 변수를 사용하여 listDirContents()를 호출합니다.

이제 사용자가 적절한 옵션을 사용할 때 createDir() 및 createFile() 함수를 호출해 보겠습니다.

if (options.ls) {
  ...
}

// add the following code
if (options.mkdir) {
  createDir(path.resolve(__dirname, options.mkdir));
}
if (options.touch) {
  createFile(path.resolve(__dirname, options.touch));
}

• 사용자가 -m 플래그를 사용하고 인수를 전달하면 index.js 파일의 전체 경로와 함께 createDir()을 호출하여 디렉토리를 생성합니다.
• 사용자가 -t 플래그를 사용하고 인수를 전달하면 index.js 위치에 대한 전체 경로와 함께 createFile() 함수를 호출합니다.

전체 index.ts 파일은 다음과 같습니다.

const fs = require("fs");
const path = require("path");
const figlet = require("figlet");

const program = new Command();

console.log(figlet.textSync("Dir Manager"));

program
  .version("1.0.0")
  .description("An example CLI for managing a directory")
  .option("-l, --ls  [value]", "List directory contents")
  .option("-m, --mkdir <value>", "Create a directory")
  .option("-t, --touch <value>", "Create a file")
  .parse(process.argv);

const options = program.opts();

async function listDirContents(filepath: string) {
  try {
    const files = await fs.promises.readdir(filepath);
    const detailedFilesPromises = files.map(async (file: string) => {
      let fileDetails = await fs.promises.lstat(path.resolve(filepath, file));
      const { size, birthtime } = fileDetails;
      return { filename: file, "size(KB)": size, created_at: birthtime };
    });
    const detailedFiles = await Promise.all(detailedFilesPromises);
    console.table(detailedFiles);
  } catch (error) {
    console.error("Error occurred while reading the directory!", error);
  }
}
function createDir(filepath: string) {
  if (!fs.existsSync(filepath)) {
    fs.mkdirSync(filepath);
    console.log("The directory has been created successfully");
  }
}

function createFile(filepath: string) {
  fs.openSync(filepath, "w");
  console.log("An empty file has been created");
}

if (options.ls) {
  const filepath = typeof options.ls === "string" ? options.ls : __dirname;
  listDirContents(filepath);
}
if (options.mkdir) {
  createDir(path.resolve(__dirname, options.mkdir));
}
if (options.touch) {
  createFile(path.resolve(__dirname, options.touch));
}

파일을 저장하고 TypeScript를 컴파일합니다.

npm run build

옵션이 동작하는지 확인합시다. 터미널에서 다음을 입력하여 -l 옵션을 시도합니다.

node dist/index.js -l

다음과 유사한 테이블에 디렉터리 내용이 표시됩니다.

디렉터리 내용을 표시하는 테이블

다음으로 선택한 디렉터리 경로를 인수로 전달합니다.

node dist/index.js -l /home/node-user/

출력에서 선택한 경로의 디렉터리 내용을 볼 수 있습니다.

디렉터리 내용

-m 옵션을 사용하여 원하는 이름으로 새 디렉터리를 만듭니다.

node dist/index.js -m new_directory
// The directory has been created successfully

-t 옵션을 사용하여 빈 파일을 생성해 보겠습니다.

node dist/index.js -t empty_file.txt
// An empty file has been created

디렉토리와 빈 파일이 생성되었는지 다음과 같이 확인봅시다.

node dist/index.js -l

출력에는 new_directory 및 empty_file.txt 파일이 표시됩니다.

출력에는 new_directory 및 empty_file.txt 파일이 표시되었으므로, 해당 폴더, 파일이 생성되었음을 확인합니다.

옵션 없이 node dist/index.js 명령을 사용하면 CLI 이름이 표시됩니다.

node dist/index.js

옵션 없이 node dist/index.js 명령을 사용하면 CLI 이름이 표시됩니다.

---

help 페이지 보여주기

옵션이 전달되지 않았을 때 도움말 페이지를 표시하는 것이 좋습니다.
index.ts 파일에서 파일 끝에 다음을 추가합니다.

// ...
if (!process.argv.slice(2).length) {
  program.outputHelp();
}

전달된 인수의 수가 2인 경우(즉, process.argv에 node와 파일 이름만 인수로 포함됨)
outputHelp()를 호출하여 출력을 표시할 수 있습니다.

 

모든 변경 사항과 마찬가지로 TypeScript를 JavaScript로 컴파일합니다.

npm run build

다음 명령을 실행합니다.

node dist/index.js

옵션이 전달되지 않았을 때 도움말 페이지를 표시하는 모습

---

CLI를 전역에서 사용할 수 있도록 하기

이제 CLI가 완성되었습니다만,

CLI를 사용하는 것이 지루하다는 것을 알 수 있습니다.

매번 디렉터리를 CLI 프로젝트 디렉터리로 변경한 다음 index.js를 호출하여 사용해야 합니다.

다음과 같이 시스템 어디에서나 작동하는 dirmanager와 같은 이름을 지정할 수 있다면 더 쉬울 것입니다.

dirmanager -l​

이렇게 하려면 package.json 파일을 열고 다음을 추가합니다.

{
  ...
  "main": "dist/index.js",
  "bin": {
    "dirmanager": "./dist/index.js"
  },
  ...
}​

이전 코드에서 컴파일된 index.js 파일로 main을 업데이트합니다.

그런 다음 값으로 객체가 있는 bin을 추가합니다.

객체에서 dirmanager를 컴파일된 스크립트의 위치인 ./dist/index.js로 설정합니다.

dirmanager를 사용하여 CLI에 액세스하지만 원하는 이름을 사용할 수 있습니다.

다음으로 index.ts 파일을 열고 파일 맨 위에 다음 줄을 추가합니다.

#! /usr/bin/env node

const { Command } = require("commander");
const fs = require("fs");

이 행은 노드 인터프리터로 파일을 실행하도록 OS에 지시하는 shebang line이라고 합니다.

파일을 저장하고 TypeScript를 한 번 더 컴파일합니다.

npm run build

다음 명령을 실행합니다.

npm install -g .

 

-g 옵션은 npm에게 패키지를 전역적으로 설치하도록 지시합니다.
이제 새 터미널을 열거나 현재 터미널을 사용한 후 다음 명령을 입력할 수 있습니다.

 

dirmanager

전역 설치된 dirmanager 실행 성공!

다른 옵션을 시도해 볼 수도 있으며 정상적으로 작동합니다.

dirmanager -l

성공적으로 시스템 어디에서나 동작하는 TypeScript CLI를 만들었습니다.

---

원문 링크

https://blog.logrocket.com/building-typescript-cli-node-js-commander/

Building a TypeScript CLI with Node.js and Commander - LogRocket Blog

참고

Commander documentation

commander