Readme
lwlは、 __L__og __W__ith __L__ineNumber の略です。
lwlの各種メソッド(error、alert、warnなど)を実行したファイル名と行番号、関数名が付加されたログがファイルに出力されます。また、coffee-scriptで実行した場合も.coffee上の行番号が出力されます(いくつか条件があります。後述)。
運用中に発生したエラーの箇所を簡単に特定できるので、問題解決の助けになると思います。
01 var lwl = require('lwl');
02
03 lwl.error('test');
04 function test() {
05 lwl.alert('テスト', 0.0005);
06 }
07 test();
08 var x = (function () {
09 lwl.warn([1, 2, 3, 4, 5]);
10 })();
上記JSファイルを実行すると、以下のようなログファイルが出力されます。
2013-06-20 15:36:02 <anonymous>@sample.js:3 [error] test
2013-06-20 15:36:02 test@sample.js:5 [alert] テスト 0.0005
2013-06-20 15:36:02 <anonymous>@sample.js:9 [warn] [ 1, 2, 3, 4, 5 ]
デフォルトのログ出力フォーマットは
タイムスタンプ 関数名@ファイル名:行番号 [出力レベル] メッセージ
です。
関数外で実行された場合や無名関数内で実行された場合は関数名に<anonymous>が、
test()関数内で実行された場合は関数名にtestと入っているのが確認できます。
npm install lwl
var lwl = require('lwl');
で、lwlモジュールをロードします。ロードした変数lwlから各種ログ出力メソッドを実行できます。
メソッド名には以下の8つが利用できます。呼び出したメソッド名がログに付加されます。数字が大きくなるにつれて重要度が増していきます。
lwl.debug(...);
console.log()と同じような感覚で自由に何でもいくつでもセットできます。ArrayやObjectは展開して出力されます。
出力されたログと同じ内容の文字列です。なお、引数がnullもしくはundefinedの場合はログは出力されず、戻り値もundefinedになります。したがって、以下のようにコールバックのエラー変数の内容をチェックせず、無条件にlwlメソッドを呼び出すようにしておけば、エラーがある場合はエラーメッセージがログに出力され、エラーがない場合は何も出力しない、といった利用ができます。
例)
hogehoge(function (err, result) {
lwl.error(err);
・
・
・
});
もっとも、エラーがある場合に処理を中断させたい時には使用できない方法ですが・・・
デフォルトではwarn未満のメソッドを実行してもログは出力されません。lwl.logLevelを変更するとログに出力する基準となるログレベルを設定できます。
設定する値は、ログ出力メソッドの8つの内のいずれかを指定してください。指定したレベル未満のログは実行しても出力されなくなります。運用時にデバッグメッセージを表示させたくない場合などに使用してください。
例)
lwl.logLevel = 'info';
lwl.debug('hogehoge'); // 出力されない
lwl.logLevel = 'debug';
lwl.debug('hogehoge'); // 出力される
デフォルトでは./lwl.logにログが出力されます。この値を変更すると変更したファイル名にログが出力されます。
例)
lwl.error('hogehoge'); // デフォルトのlwl.logにログが出力される
lwl.logFile = '/path/to/logfile.txt';
lwl.error('hogehoge'); // /path/to/logfile.txtにログが出力される
また、logFileには特殊な指定方法が2つあります。
ログファイル名に-を指定するとファイルではなく標準出力(stdout)にログが出力されます。
lwl.logFile = '-';
lwl.warn('hogehoge'); // 標準出力に表示される
ログファイル名にnullもしくはundefinedを指定するとファイルにも標準出力にもログは出力されず、メソッドの戻り値にログ文字列を返すだけになります。発生したエラー情報を呼び出し元に返し、何かしらの加工をした後でconsole.log()などで出力するといった使い方ができます。
lwl.logFile = null;
var log = lwl.warn('hogehoge'); // 変数logにログメッセージが入る
・
・
・
console.log('エラーだよ!! -> ' + log); // ここで改めてログを出力
以下の6つを引数として受けて文字列を返す関数を指定します。ここで指定した関数で返される文字列がログファイルに出力されます。nullもしくはundefinedを指定するとデフォルトのログフォーマットで出力します。
YYYY-MM-DD hh:mm:ss形式のタイムスタンプ<anonymous>)例)
lwl.logFormatFunc = function (timestamp, level, func, file, line, message) {
return '[' + level + ']' + timestamp + ' ' + file + ':' + line + '(' + func + ') -> ' + message;
};
※普通にログの出力だけを行う分には必要のない情報です。
このプロパティを記述した位置の 拡張 スタックトレース情報および呼び出し元の 拡張 スタックトレース情報を大元まで配列で返します。意味が良く分からないかもしれませんが、スクリプトでエラーが発生した時に出るアレの元情報を取得できるわけです。
例)
$ node
> a.x()
ReferenceError: a is not defined
at repl:1:2 ← StackTrace[0]
at REPLServer.self.eval (repl.js:109:21) ← StackTrace[1]
at Interface.<anonymous> (repl.js:248:12) ← StackTrace[2]
at Interface.EventEmitter.emit (events.js:96:17) ← StackTrace[3]
at Interface._onLine (readline.js:200:10) ← StackTrace[4]
at Interface._line (readline.js:518:8) ← StackTrace[5]
at Interface._ttyWrite (readline.js:736:14) ← StackTrace[6]
at ReadStream.onkeypress (readline.js:97:10) ← StackTrace[7]
at ReadStream.EventEmitter.emit (events.js:126:20) ← StackTrace[8]
at emitKey (readline.js:1058:12) ← StackTrace[9]
何が 拡張 かというと、lwl.__stackで取得したスタックトレース情報には特別なプロパティが用意されています。
<anonymous>)ログ出力以外のデバッグ目的などでこれらのプロパティを使用する場合などにどうぞ。
例)
var stack = lwl.__stack;
console.log(stack[0].file + 'の' + stack[0].line + '行目 (関数名: ' + stack[0].func + ')です');
// この例の場合console.log()の1行上の行番号が表示されますが・・・
coffee-scriptで.coffee上の行番号を出力させるにはcoffee-scriptのバージョンが 1.6.2以上 である必要があります。
また、coffee-scriptがスタックトレースに.coffee上の行番号を付加するのはcoffeeコマンドで実行されたときのみなので、下記のように.jsファイル内から.coffeeファイルをrequireした場合は.coffeeがJavaScriptにコンパイルされて展開された後の行番号になってしまいます。
※今後のcoffee-scriptのバージョンアップによって自動的に直る可能性があります。
01 lwl = require 'lwl'
02
03 lwl.error 'hoge'
require('coffee-script');
require('./test');
2013-06-20 16:09:43 <anonymous>@test.coffee:6 [error] hoge
~ JavaScriptに展開された後の行番号になってしまう
lwl.logFormatFunc)lwl.__stackプロパティの追加MIT licenseで配布します。
© 2013 ktty1220
FAQs
Output log with line-number library for Node.js (support js & coffee)
The npm package lwl receives a total of 16 weekly downloads. As such, lwl popularity was classified as not popular.
We found that lwl demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.