commander를 이용한 JS CLI 라이브러리 File Output 생성하기

종종 CLI 기능이 있는 라이브러리를 사용하면, 파일을 생성해주는 기능이 있는 경우를 종종 봤다.

 

이번에는 이를 어떻게 구현할 수 있을지 직접 만들어봤다.

 

작성한 colors-helper-tools 라이브러리의 cli 코드이다.

빨간색으로 테두리친 부분이 CLI 코드에서 실제로 file output을 생성하는 부분이다.

-f나 --file 옵션을 사용하면, 파일을 생성한다.

 

이때, 파일 이름은 중복이 일어나면 에러가 발생할 수 있다.

때문에 현재 시간을 이용하여 파일을 만듦으로써 중복을 방지한다.

/**
 *
 * @param prefix file name prefix
 * @param extension file_name.extension
 * @returns file name String
 */
const generateFileName = (prefix: string, extension: string): string => {
  const now = new Date();
  const timestamp = now.toISOString().replace(/[:.]/g, '-');
  return `${prefix}-${timestamp}.${extension}`;
};

 

이렇게 생성한 파일 이름으로 실제 코드를 파일로 생성하는 건 다음과 같이 구현할 수 있다.

/**
 *
 * @param filePath file output path
 * @param content String to output
 */
const writeStringToFile = (filePath: string, content: string): void => {
  fs.writeFile(filePath, content, err => {
    if (err) {
      console.error('Error writing to file:', err);
    } else {
      console.log('File has been written successfully.');
    }
  });
};

 

이렇게 구현이 완료된 코드는 다음과 같은 CLI 명령어로 실행해볼 수 있다.

npx cht random 100 -f

 

실제로 실행해보면, 100개의 hex 색상이 하나의 txt 파일에 쓰여진다.

 

🍎 참고 자료

https://www.npmjs.com/package/colors-helper-tools

colors-helper-tools