<div id="readability-page-1" class="page"><div>
                                            <p><a href="/m/category/JavaScript">JavaScript</a></p><h2>[Node.js] cli(command-line interface) 프로그램 생성하기(commander.js)</h2>
                    <p><cite>
                        <span>JayLee</span>
                    </cite>
                </p></div><p><time>2021. 2. 18. 17:17</time>
                    <span>
                        
                                                    <a href="#comment" onclick="Utils.smoothScroll(this);return false">
                                
                            </a>
                        
                                                    <span id="title_daumlike">
                                
                                <span id="mobile-reaction"></span>
                                
                            </span>
                                            </span>
                </p><div>
                    <p>&nbsp;회사에서 신규 프로그램에 사용할 데이터를 자동으로 가공하는 프로그램을 만들고 있습니다. Node 기반으로 프로그램을 작성하고 있는데, cli를 이용하여 입력 값을 받아 동작하도록 구현했습니다.</p>

<p>이를 구현하기 위해 commander.js를 사용했습니다. 제가 사용한 방법 위주로 정리해보도록 하겠습니다.</p>

<p>commander.js를 사용하기 위해서는 아래와 같이 패키지를 설치해야합니다.</p>
<pre id="code_1613628335901" data-ke-language="javascript" data-ke-type="codeblock"><code>$ npm install --save commander</code></pre>

<h4 data-ke-size="size20"><b>Option</b></h4>
<p>일반적인 Option을 정의합니다. 옵션의 데이터가 올 수 도 있고, 옵션만 사용할 수도 있습니다.</p>

<p>app.js 를 아래와 같이 작성합니다.</p>
<pre id="code_1613628136786" data-ke-language="javascript" data-ke-type="codeblock"><code>const { Command } = require('commander');

const program = new Command();

program
    .option('-n, --name &lt;name&gt;', 'file name')
    .option('-c, --compress', 'compress')
    .parse();

console.log(program.opts().n);
console.log(program.opts().name);
console.log(program.opts().compress);</code></pre>

<p>작성이 완료되었으면 아래 명령어를 이용하여 테스트 해보도록겠습니다.</p>
<pre id="code_1613628656752" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js -n 'a.txt'
$ node app.js --name 'a.txt' -c</code></pre>

<p>결과는 아래와 같습니다.</p>
<pre id="code_1613628563204" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js -n 'a.txt'
undefined
a.txt
undefined

$ node app.js --name 'a.txt'
undefined
a.txt
true</code></pre>
<p>-n 또는 --name 으로 데이터를 입력 받을 수 있고, 내부에서 참조할 땐, name으로 참조해야합니다. option을 사용하고 데이터를 전달하지 않으면 true 값을 반환하게 됩니다.</p>

<p>이렇게 option을 정의했다면, -h, --help를 이용하여 help를 볼 수도 있습니다.</p>
<pre id="code_1613635322983" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js -h
Usage: app [options]

Options:
  -n, --name &lt;name&gt;  file name
  -c, --compress     compress
  -h, --help         display help for command</code></pre>
<p>option 함수를 이용하여 정의한대로 잘 나오는 것을 확인할 수 있습니다.</p>

<h4 data-ke-size="size20"><b>Default Value</b></h4>
<p>옵션에 사용할 기본 값도 정의할 수 있습니다. 해당 옵션을 사용하지 않으면 기본 값으로 할당되게 됩니다.</p>
<p>options <span>메서드</span>의 세번째 인자로 기본 값을 설정합니다. name의 기본값은 <span>'default file name'으로 compress의 기본값은 false로 설정했습니다.</span></p>
<pre id="code_1613635458540" data-ke-language="javascript" data-ke-type="codeblock"><code>const { Command } = require('commander');

const program = new Command();

program
    .option('-n, --name &lt;name&gt;', 'file name', 'default file name')
    .option('-c, --compress', 'compress', false)
    .parse();

console.log(program.opts().name);
console.log(program.opts().compress);</code></pre>
<p>그럼 실행해보겠습니다.</p>
<pre id="code_1613635524648" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js
default file name
false</code></pre>
<p>옵션을 지정하지 않았지만 문제없이 출력되는 것을 확인할 수 있습니다.</p>

<h4 data-ke-size="size20"><b>Required option</b></h4>
<p>필수 옵션을 지정할 수 있습니다. name을 필수 옵션으로 지정해보도록 하겠습니다. option 메서드 대신 requiredOption <span>메서드</span>를 사용하면 됩니다. 기본값도 제거 했습니다.</p>
<pre id="code_1613635691109" data-ke-language="javascript" data-ke-type="codeblock"><code>const { Command } = require('commander');

const program = new Command();

program
    .requiredOption('-n, --name &lt;name&gt;', 'file name')
    .option('-c, --compress', 'compress', false)
    .parse();

console.log(program.opts().name);
console.log(program.opts().compress);</code></pre>
<p>실행 결과는 아래와 같습니다.</p>
<pre id="code_1613635721080" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js
error: required option '-n, --name &lt;name&gt;' not specified</code></pre>
<p>name 옵션이 입력되지 않아 error를 발생시키며 프로그램이 종료된 것을 확인할 수 있습니다.</p>

<h4 data-ke-size="size20"><b>Version</b></h4>
<p>마지막으로 프로그램의 버전을 확인하는 version 메서드를 추가해보겠습니다. 저는 package.json에 있는 옵션을 사용하여 출력했습니다.</p>
<pre id="code_1613635858798" data-ke-language="javascript" data-ke-type="codeblock"><code>const { Command } = require('commander');
const packageJson = require('./package.json');

const program = new Command();

program
    .requiredOption('-n, --name &lt;name&gt;', 'file name')
    .option('-c, --compress', 'compress', false)
    .version(packageJson.version)
    .parse();

console.log(program.opts().name);
console.log(program.opts().compress);</code></pre>
<p>버전을 출력하기 위해 -V 혹은 --version 옵션을 사용할 수 있습니다.</p>
<pre id="code_1613635919111" data-ke-language="javascript" data-ke-type="codeblock"><code>$ node app.js --version
1.0.0</code></pre>
<p>잘 출력된 것을 확인 할 수 있습니다.</p>


<p>소스는 아래 링크에서 확인 가능합니다.</p>

<figure id="og_1613636222464" contenteditable="false" data-ke-type="opengraph" data-og-type="object" data-og-title="hjleesm/commanderTest" data-og-description="Contribute to hjleesm/commanderTest development by creating an account on GitHub." data-og-host="github.com" data-og-source-url="https://github.com/hjleesm/commanderTest" data-og-url="https://github.com/hjleesm/commanderTest" data-og-image="https://scrap.kakaocdn.net/dn/bb1vPQ/hyJjWFU4IA/DvQUez93f73d0FqoKDBYm0/img.jpg?width=400&amp;height=400&amp;face=89_82_130_126"><a href="https://github.com/hjleesm/commanderTest" target="_blank" rel="noopener" data-source-url="https://github.com/hjleesm/commanderTest">

<div>
<p>hjleesm/commanderTest</p>
<p>Contribute to hjleesm/commanderTest development by creating an account on GitHub.</p>
<p>github.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bb1vPQ/hyJjWFU4IA/DvQUez93f73d0FqoKDBYm0/img.jpg?width=400&amp;height=400&amp;face=89_82_130_126"></figure>

                                                            
                                
											
					
                    
                    
                </div></div>

Hello Jay's Programming World!

회사에서 신규 프로그램에 사용할 데이터를 자동으로 가공하는 프로그램을 만들고 있습니다. Node 기반으로 프로그램을 작성하고 있는데, cli를 이용하여 입력 값을 받아 동작하도록 구현했습니다.
 
이를 구현하기 위해 commander.js를 사용했습니다. 제가 사용한 방법 위주로 정리해보도록 하겠습니다.
 
commander.js를 사용하기 위해서는 아래와 같이 패키지를 설치해야합니다.
$ npm install --save commander
 
Option
일반적인 Option을 정의합니다. 옵션의 데이터가 올 수 도 있고, 옵션만 사용할 수도 있습니다.
 
app.js 를 아래와 같이 작성합니다.
const { Command } = require('commander');
const program = new Command();
program
    .option('-n, --name <name>', 'file name')
    .option('-c, --compress', 'compress')
    .parse();
console.log(program.opts().n);
console.log(program.opts().name);
console.log(program.opts().compress);
 
작성이 완료되었으면 아래 명령어를 이용하여 테스트 해보도록겠습니다.
$ node app.js -n 'a.txt'
$ node app.js --name 'a.txt' -c
 
결과는 아래와 같습니다.
$ node app.js -n 'a.txt'
undefined
a.txt
undefined
$ node app.js --name 'a.txt'
undefined
a.txt
true
-n 또는 --name 으로 데이터를 입력 받을 수 있고, 내부에서 참조할 땐, name으로 참조해야합니다. option을 사용하고 데이터를 전달하지 않으면 true 값을 반환하게 됩니다.
 
이렇게 option을 정의했다면, -h, --help를 이용하여 help를 볼 수도 있습니다.
$ node app.js -h
Usage: app [options]
Options:
  -n, --name <name>  file name
  -c, --compress     compress
  -h, --help         display help for command
option 함수를 이용하여 정의한대로 잘 나오는 것을 확인할 수 있습니다.
 
Default Value
옵션에 사용할 기본 값도 정의할 수 있습니다. 해당 옵션을 사용하지 않으면 기본 값으로 할당되게 됩니다.
options 메서드의 세번째 인자로 기본 값을 설정합니다. name의 기본값은 'default file name'으로 compress의 기본값은 false로 설정했습니다.
const { Command } = require('commander');
const program = new Command();
program
    .option('-n, --name <name>', 'file name', 'default file name')
    .option('-c, --compress', 'compress', false)
    .parse();
console.log(program.opts().name);
console.log(program.opts().compress);
그럼 실행해보겠습니다.
$ node app.js
default file name
false
옵션을 지정하지 않았지만 문제없이 출력되는 것을 확인할 수 있습니다.
 
Required option
필수 옵션을 지정할 수 있습니다. name을 필수 옵션으로 지정해보도록 하겠습니다. option 메서드 대신 requiredOption 메서드를 사용하면 됩니다. 기본값도 제거 했습니다.
const { Command } = require('commander');
const program = new Command();
program
    .requiredOption('-n, --name <name>', 'file name')
    .option('-c, --compress', 'compress', false)
    .parse();
console.log(program.opts().name);
console.log(program.opts().compress);
실행 결과는 아래와 같습니다.
$ node app.js
error: required option '-n, --name <name>' not specified
name 옵션이 입력되지 않아 error를 발생시키며 프로그램이 종료된 것을 확인할 수 있습니다.
 
Version
마지막으로 프로그램의 버전을 확인하는 version 메서드를 추가해보겠습니다. 저는 package.json에 있는 옵션을 사용하여 출력했습니다.
const { Command } = require('commander');
const packageJson = require('./package.json');
const program = new Command();
program
    .requiredOption('-n, --name <name>', 'file name')
    .option('-c, --compress', 'compress', false)
    .version(packageJson.version)
    .parse();
console.log(program.opts().name);
console.log(program.opts().compress);
버전을 출력하기 위해 -V 혹은 --version 옵션을 사용할 수 있습니다.
$ node app.js --version
1.0.0
잘 출력된 것을 확인 할 수 있습니다.
 
 
소스는 아래 링크에서 확인 가능합니다.

[Node.js] cli(command-line interface) 프로그램 생성하기(commander.js)

댓글