Skip to content

Add local time zone & time formatting configuration #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
friedbunny wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add local time zone & time formatting configuration #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f786b7a
Add local time zone & time formatting configuration
friedbunny Nov 10, 2014
52ee95b
Add moment.js dependency; cleanup
friedbunny Nov 10, 2014
d4784b7
Add options section
friedbunny Nov 10, 2014
1ca794b
Update prettystream.js
friedbunny Nov 11, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/prettystream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ var util = require('util');
var format = util.format;
var http = require('http');

var moment = require('moment');
moment().format();

var colors = {
'bold' : [1, 22],
'italic' : [3, 23],
Expand All @@ -23,7 +26,9 @@ var colors = {

var defaultOptions = {
mode: 'long', //short, long, dev
useColor: true
useColor: true,
UTC: true,
timeFormat: moment.defaultFormat
};

var levelFromName = {
Expand Down Expand Up @@ -101,9 +106,12 @@ function PrettyStream(opts){
}

function extractTime(rec){
var time = (typeof rec.time === 'object') ? rec.time.toISOString() : rec.time;

if ((config.mode === 'short' || config.mode === 'dev') && time[10] == 'T') {
var time = (config.UTC) ? moment(time).utc() : moment(time);

if (time.isValid()) time = time.format(config.timeFormat);
else time = (typeof rec.time === 'object') ? rec.time.toISOString() : rec.time;

if ((config.mode === 'short' || config.mode === 'dev') && time[10] == 'T' && config.timeFormat == defaultOptions.timeFormat) {
return stylize(time.substr(11));
}
return stylize(time);
Expand Down
12 changes: 8 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@
"type": "git",
"url": "git://github.com/mrrama/node-bunyan-prettystream.git"
},
"engines": ["node >=0.8.0"],
"engines": { "node": ">=0.8.0" },
"keywords": ["log", "logging", "console", "bunyan", "development", "stream"],

"dependencies": {
"moment": "~2.8"
},

"devDependencies": {
"mocha": "1.11.0",
"blanket" : "1.1.5",
"mocha-lcov-reporter" : "0.0.1",
"blanket": "1.1.5",
"mocha-lcov-reporter": "0.0.1",
"coveralls": "2.0.13",
"travis-cov": "0.2.4",
"should": "1.2.2"
Expand All @@ -25,4 +29,4 @@
"test": "make test",
"travis-cov": { "threshold": 70 }
}
}
}
24 changes: 24 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,30 @@ This library is only really meant for development and should not be used on prod
});
```

# Options

```javascript
var prettyStdOut = new PrettyStream({
mode: 'long', //short, long, dev
useColor: true,
UTC: true,
timeFormat: moment.defaultFormat // "2014-11-10T23:35:25+00:00" (ISO 8601)
});
```

`UTC` defaults to `true`, while setting `false` will use the machine's local time zone.

`timeFormat` uses [moment.js conventions](http://momentjs.com/docs/#/displaying/format/) and defaults to ISO 8601 format.

Custom time formatting example:

```javascript
var prettyStdOut = new PrettyStream({
UTC: false,
timeFormat: 'YYYY-MM-DD HH:mm:ssZZ' // "2014-11-10 14:47:32-0800"
});
```

# Tests

Running unit tests requires `mocha` installed.
Expand Down