【Node.js24.x】Object::parseArgs()メソッドの使い方

parseArgsメソッドは、Node.jsアプリケーションにおいて、コマンドラインから与えられた引数を解析し、扱いやすい形式で取得するためのメソッドです。

このメソッドはNode.js 24バージョンで利用可能なutilモジュールの一部として提供されており、コマンドラインインターフェース（CLI）アプリケーションの引数処理を標準的かつ効率的に行うために設計されています。アプリケーションがコマンドラインから受け取るprocess.argvの生データを、開発者が事前に定義したルール（オプション名、データ型、エイリアスなど）に基づいて構造化されたオブジェクトに変換します。これにより、開発者は複雑な引数解析ロジックを自作することなく、簡単にコマンドライン引数にアクセスできるようになります。

具体的には、--file <path>のようなオプション引数や、--verboseのような真偽値フラグ、あるいはcommand <arg1> <arg2>のような位置引数などを明確に区別し、それぞれを整理された形で返します。システムエンジニアが開発するツールやスクリプトでは、ユーザーからの入力としてコマンドライン引数を受け取ることが頻繁にあります。parseArgsメソッドは、これらの引数を誤りなく、かつプログラム内で利用しやすい形でアプリケーションに渡すための基盤を提供します。これにより、開発者は引数処理にかかる手間を削減し、アプリケーションの主要な機能実装に集中できるようになるため、開発効率の向上に貢献します。

Copy
1const { values, positionals } = process.parseArgs({
2  options: {
3    config: {
4      type: 'string',
5      short: 'c'
6    },
7    dryRun: {
8      type: 'boolean'
9    }
10  },
11  allowPositionals: true
12});

config = {}

• config: object = {}: コマンドライン引数を解析するための設定オブジェクト。省略可能で、デフォルトは空オブジェクトです。

{ values: Record<string, string | boolean | string[] | undefined>, positionals: string[] }

parseArgs() メソッドは、コマンドライン引数を解析した結果をオブジェクトで返します。このオブジェクトは values プロパティと positionals プロパティを持ちます。values プロパティは、コマンドライン引数で指定されたオプションとその値を格納し、positionals プロパティは、オプション以外の位置引数を格納します。