【Node.js】util.styleTextでコンソール出力を装飾する

Node.jsのutil.styleText というのを知ったので調べた

nodejs.org

util.styleText は、Node.js の util モジュールに追加された関数で、コンソール出力のテキストに色や装飾を適用するために使用される

この機能により、外部ライブラリを使用せずに、テキストのスタイリングが可能となる

基本的な使用方法

const { styleText } = require('node:util');

const errorMessage = styleText('red', 'エラーが発生しました');
console.log(errorMessage);

上記のコードでは、styleText 関数を使用して、文字列 "エラーが発生しました" に赤色のスタイルを適用している

複数のスタイルの適用

styleText 関数では、複数のスタイルを組み合わせて適用することも可能

const { styleText } = require('node:util');

const styledMessage = styleText(['bold', 'underline', 'blue'], '重要なお知らせ');
console.log(styledMessage);

この例では、"重要なお知らせ" というテキストに、太字、下線、青色のスタイルを同時に適用している

利用可能なスタイル

styleText で使用できるスタイルは、大きく以下のカテゴリに分類されます。

• 修飾（Modifiers）:

  • reset: すべてのスタイルをリセット
  • bold: 太字
  • italic: イタリック体
  • underline: 下線
  • strikethrough: 取り消し線
  • hidden: テキストを隠す
  • dim: 薄い表示
  • overlined: 上線
  • blink: 点滅
  • inverse: 前景色と背景色を反転
  • doubleunderline: 二重下線
  • framed: 枠で囲む

• 前景色（Foreground Colors）:

  • black, red, green, yellow, blue, magenta, cyan, white
  • gray（エイリアス: grey, blackBright）
  • 明るい色: redBright, greenBright, yellowBright, blueBright, magentaBright, cyanBright, whiteBright

• 背景色（Background Colors）:

  • bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite
  • bgGray（エイリアス: bgGrey, bgBlackBright）
  • 明るい色: bgRedBright, bgGreenBright, bgYellowBright, bgBlueBright, bgMagentaBright, bgCyanBright, bgWhiteBright

これらのスタイルを組み合わせることで、コンソール出力をより視覚的に魅力的にすることができる

参考

Node.jsで待望（?）のコンソールの色を変えられるようになった #JavaScript - Qiita

www.npmjs.com