consola : console.logをカラフルにするnode.js用ライブラリ



console.log を綺麗に彩るnode.js用ライブラリ「consola」の紹介です。
 

consola で出来ること 

- コマンドライン上でカラーとアイコンが付いたアウトプットを出力できます

consola を使ってアウトプット


consola のインストール

 consola のインストールは ' npm ' 又は ' yarn ' コマンドを使っておこないます。node.jsの依存バージョンは指定されていませんが、' node.js v8.11.1 ' では問題なく動作しました。

# npm
npm i consola
# yarn
yarn add consola


consola の読み込み 

 consolaはライブラリを読み込みんだ後、通常の ' console.log ' と同じ使い勝手で使用することが出来ます。

* consola.METHOD名('メッセージ')

const consola = require('consola'); // ライブラリの読み込み

consola.success('success Method'); // successメソッド

 

緑色のアウトプット

' success ', ' ready ' メソッドを使えば緑色にアウトプットされます。

// green
consola.success('success Method')
consola.ready('ready Method')

success, ready メソッド


赤色のアウトプット

' error ' , ' fatal ' メソッドは赤色に表示されます。上の ' success ' に次いで使用する頻度が高そうなメソッドです。

// red
consola.error('error Method')
consola.fatal('fatal Method')

error, fatal メソッド


青色のアウトプット

 ' info ',  ' start ' メソッドは青色にアウトプットされます。

// blue
consola.info('info Method')
consola.start('start Method')

info, start メソッド


白色のアウトプット

 ' log ' メソッドは通常の console.logのように 白色にアウトプットされます。

// white
consola.log('log Method')

log メソッド


黄色のアウトプット

' warn ' メソッドを使うと、メッセージが黄色でアウトプットされます。何かの警告時に表示させると便利に使えそうです。

// yellow
consola.warn('warn Method')

warn メソッド


Summary

 consola の内部には ' figure ' という Unicodeシンボルライブラリが使われおり、Windows環境でも問題なく絵文字が描画されます。

 node.jsで書いた batchコマンド実行時アウトプットや コマンドラインアプリケーションを開発している時に役立ちそうなライブラリです。

GitHub : nuxt/consola

 

この記事のカテゴリ
プログラミング

この記事に付けられているタグ