[Node.js] 14장 CLI 프로그램 만들기

🔍 CLI (Command Line Interface)

콘솔 창을 통해 프로그램을 수행하는 환경

그래픽 사용자 인터페이스와 반대되는 개념

• 대표적인 CLI 방식 소프트웨어 : 리눅스의 셸, 브라우저의 콘솔, 명령 프롬프트
• 대표적인 GUI 방식 소프트웨어 : 윈도와 맥 운영체제, 웹 애플리케이션

 

✅ 콘솔 명령어

node나 npm, nodemon처럼 콘솔에 입력하여 어떤 동작을 수행하는 문장

패키지명과 콘솔 명령어는 다르게 만들 수 있다

//package.json
{
	...
    "license": "ISC",
    "bin": {
    	"cli": "./index.js"
    }

bin : 콘솔 명령어와 해당 명령어를 호출할 때 실행 파일을 설정하는 객체

현재 콘솔 명령어는 cli, 실행 파일은 index.js로 지정

$ npm i -g   //콘솔에서 현재 패키지 전역 설치 
$ cli     //index.js 실행

 

📌 사용자로부터 입력 받기

노드의 내장 모듈 readline 사용

//index.js
const readline = require('readline');

const rl = readline.createInterface({
	input: process.stdin,
    output: process.stdout,
});

rl.question('밥 먹었나요? (y/n) ', (answer) => {
	if (answer === 'y') {
    	console.log('맛있었겠어요');
    } else if (answer === 'n') {
    	console.log('얼른 드세요');
    } else {
    	console.log('y 또는 n만 입력하세요');
    }
    rl.close();  // 입출력 과정 후 메서드 종료
});

process.stdin 과 process.stdout : 콘솔 입력과 출력을 담당하는 스트림

readline 모듈 : 사용자로부터 입력 받고 그에 따른 결과 출력

console.clear 메서드 : 콘솔 내용을 지움

 

🔍 commander와 inquirer

CLI 프로그램을 위한 라이브러리

commander는 사용 방법이 좀 더 직관적이며, inquirer은 CLI 프로그램과 사용자 간의 상호작용을 도움

 

📌 commander 사용법

• version : 프로그램의 버전 설정, node -v로 프로그램 버전 확인 가능
• usage : 명령어의 사용법 설정
• name : 명령어의 이름을 적음
• command : 명령어 설정하는 메서드
• description : 명령어에 대한 설명을 설정하는 메서드
• alias : 명령어의 별칭 설정
• option : 명령어에 대한 부가적인 옵션 설정
• requiredOption : 필수로 입력해야 하는 옵션 지정
• action : 명령어에 대한 실제 동작 정의
• help : 설명서를 보여주는 옵션
• parse : process.argv를 인수로 받아 명령어와 옵션 파싱

 

📌 commander에서 알아두어야 할 것

기본 명령어(cli)는 * 명령어에 해당하지 않는다

이 명령어에 동작을 추가하려면 * 명령어를 없애고 일반 action에서 매개변수에 따라 분기 처리를 해야 함

 

📌 inquirer 사용법

inquirer 객체는 prompt 메서드를 가지는데, 해당 메서드는 인수로 질문 목록을 받고 프로미스를 통해 답변을 반환한다

 

✅ 질문 객체의 속성

• type : 질문의 종류
• name : 질문의 이름
• message : 사용자에게 표시되는 문자열
• choices : type이 checkbox, list 등인 경우 선택지를 넣는 곳
• default : 답을 적지 않았을 경우 적용되는 기본값

 

🔍 chalk 패키지

콘솔 텍스트에 스타일을 추가할 때 사용

• 배경색 지정 : bgGreen, bgYellow, bgRgb, bgHex
• 텍스트 스타일 지정 : bold, underline

chalk.rgb(12, 34, 56)(텍스트) 또는 chalk.hex('#123456')(텍스트) 처럼 사용 가능

chalk.red.bgBlue.bold(텍스트) 처럼 글자색, 배경색, 스타일 동시 지정 가능

 

 

 

---

Node.js 

Editor : dori