【完全網羅】Node.jsでchild_process.spawnを使ってカラー出力を取得する：サンプルコード付き

2024-06-28

Node.jsにおけるchild_process.spawnで色を保持する方法

しかし、カラー情報を含む出力が必要な場合もあります。そのような場合は、以下の方法で色を保持することができます。

stdio: 'inherit'オプションを使用する

最も簡単な方法は、stdio: 'inherit'オプションをspawnオプションに渡すことです。これにより、子プロセスの標準入力、標準出力、標準エラーストリームが親プロセスに継承され、カラー情報を含む出力がそのまま出力されます。

const { spawn } = require('child_process');

const child = spawn('ls', ['-l'], { stdio: 'inherit' });

cross-spawnモジュールは、プラットフォームに依存せずに子プロセスの出力をカラーで出力するのに役立ちます。

const crossSpawn = require('cross-spawn');

const child = crossSpawn('ls', ['-l']);
child.stdout.on('data', (data) => {
  console.log(data.toString());
});

child_process.exec関数は、spawnよりもシンプルで、カラー出力をサポートしています。

const { exec } = require('child_process');

exec('ls -l', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stdout);
});

chalkライブラリを使用して、プログラム内でカラーテキストを出力することができます。これにより、子プロセスの出力に色を追加することができます。

const chalk = require('chalk');
const { spawn } = require('child_process');

const child = spawn('ls', ['-l']);
child.stdout.on('data', (data) => {
  console.log(chalk.green(data.toString()));
});

これらの方法は、それぞれ異なる利点と欠点があります。状況に応じて適切な方法を選択してください。

補足:

上記の例では、lsコマンドを使用していますが、他のコマンドにも同様に適用できます。
カラー出力がサポートされないターミナルエミュレータを使用している場合は、色が表示されない場合があります。

サンプルコード：Node.jsにおけるchild_process.spawnで色を保持する方法

stdio: 'inherit'オプションを使用する

const { spawn } = require('child_process');

const child = spawn('ls', ['-l'], { stdio: 'inherit' });

このコードは、lsコマンドを実行し、その出力をカラーでコンソールに出力します。

cross-spawnモジュールを使用する

const crossSpawn = require('cross-spawn');

const child = crossSpawn('ls', ['-l']);
child.stdout.on('data', (data) => {
  console.log(data.toString());
});

child_process.execを使用する

const { exec } = require('child_process');

exec('ls -l', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stdout);
});

Chalkライブラリを使用する

const chalk = require('chalk');
const { spawn } = require('child_process');

const child = spawn('ls', ['-l']);
child.stdout.on('data', (data) => {
  console.log(chalk.green(data.toString()));
});

上記のサンプルコードは、あくまでも例であり、状況に合わせて変更する必要があります。

Node.jsにおけるchild_process.spawnで色を保持するその他の方法

環境変数を使用する

以下の環境変数を設定することで、子プロセスがカラー出力を出力するようにすることができます。

FORCE_COLOR=1

この方法は、すべてのchild_process.spawn呼び出しに影響を与えるため、他の方法よりも影響範囲が大きくなります。

const colors = require('colors');
const { spawn } = require('child_process');

const child = spawn('ls', ['-l']);
child.stdout.on('data', (data) => {
  console.log(colors.green(data.toString()));
});

この方法は、chalkライブラリと似ていますが、colorsモジュールはより軽量でシンプルなライブラリとなっています。

node-stream-tuiモジュールは、Node.js用のTUI（Text User Interface）ライブラリであり、カラー出力を含むストリームデータを処理する機能を提供します。

const tui = require('node-stream-tui');
const { spawn } = require('child_process');

const child = spawn('ls', ['-l']);
const stream = child.stdout;

const ui = tui.create({
  style: 'monospaced',
});

stream.pipe(ui);