Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: winstonjs/winston
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v3.3.0
Choose a base ref
...
head repository: winstonjs/winston
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v3.3.1
Choose a head ref
  • 8 commits
  • 7 files changed
  • 6 contributors

Commits on Jun 21, 2020

  1. remove emitErrs note from README (its no longer supported) (#1810)

    Co-authored-by: Reece Daniels <reece.daniels@kwiff.com>
    rubengmurray and Reece Daniels authored Jun 21, 2020

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    6545a7e View commit details

Commits on Jun 22, 2020

  1. 7
    Copy the full SHA
    67cd9b5 View commit details
  2. Copy the full SHA
    9e7bd71 View commit details
  3. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    0e1c812 View commit details
  4. Fix bugs in createLogger type (#1807)

    * fix createLogger type
    
    * fix to follow master
    Mizumaki authored Jun 22, 2020

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    ef97171 View commit details
  5. Add space between info.message and meta.message (#1740)

    * Update logger.js
    
    * fix tests
    rap2hpoutre authored Jun 22, 2020

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    227ca0a View commit details
  6. Prep for 3.3.1

    DABH committed Jun 22, 2020
    Copy the full SHA
    faac066 View commit details
  7. 3.3.1

    DABH committed Jun 22, 2020
    Copy the full SHA
    e364ddc View commit details
Showing with 49 additions and 61 deletions.
  1. +7 −0 CHANGELOG.md
  2. +2 −7 README.md
  3. +29 −27 index.d.ts
  4. +1 −1 lib/winston/logger.js
  5. +4 −20 package-lock.json
  6. +2 −2 package.json
  7. +4 −4 test/formats/errors.test.js
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# CHANGELOG

## v3.3.1 / 2020-06-21

- [#1803], [#1807] Fix TypeScript bugs.
- [#1740] Add space between `info.message` and `meta.message`.
- [#1813] Avoid indirect storage-engine dependency.
- [#1810] README updates.

## v3.3.0 / 2020-06-21

- [#1779] Fix property name in rejection handler.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -627,8 +627,8 @@ const myCustomLevels = {
}
};

const customLevelLogger = winston.createLogger({
levels: myCustomLevels.levels
const customLevelLogger = winston.createLogger({
levels: myCustomLevels.levels
});

customLevelLogger.foobar('some foobar level-ed message');
@@ -1098,11 +1098,6 @@ you should handle or suppress if you don't want unhandled exceptions:
// Handle errors
//
logger.on('error', function (err) { /* Do Something */ });

//
// Or just suppress them.
//
logger.emitErrs = false;
```

### Working with multiple Loggers in winston
56 changes: 29 additions & 27 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ declare namespace winston {

interface Profiler {
logger: Logger;
start: Date;
start: Number;
done(info?: any): boolean;
}

@@ -58,7 +58,7 @@ declare namespace winston {
[optionName: string]: any;
}

interface LogMethod {
interface LogMethod {
(level: string, message: string, callback: LogCallback): Logger;
(level: string, message: string, meta: any, callback: LogCallback): Logger;
(level: string, message: string, ...meta: any[]): Logger;
@@ -74,8 +74,8 @@ declare namespace winston {
(infoObject: object): Logger;
}

interface LoggerOptions {
levels?: Config.AbstractConfigSetLevels;
interface LoggerOptions<T extends Config.AbstractConfigSetLevels = Config.AbstractConfigSetLevels> {
levels?: T;
silent?: boolean;
format?: logform.Format;
level?: string;
@@ -86,7 +86,29 @@ declare namespace winston {
exceptionHandlers?: any;
}

interface Logger extends NodeJSStream.Transform {
type DefaulLevels = {
// for cli and npm levels
error: number;
warn: number;
help: number;
data: number;
info: number;
debug: number;
prompt: number;
http: number;
verbose: number;
input: number;
silly: number;

// for syslog levels only
emerg: number;
alert: number;
crit: number;
warning: number;
notice: number;
}

type Logger<T extends Config.AbstractConfigSetLevels = DefaulLevels> = NodeJSStream.Transform & {
silent: boolean;
format: logform.Format;
levels: Config.AbstractConfigSetLevels;
@@ -103,26 +125,6 @@ declare namespace winston {
clear(): Logger;
close(): Logger;

// for cli and npm levels
error: LeveledLogMethod;
warn: LeveledLogMethod;
help: LeveledLogMethod;
data: LeveledLogMethod;
info: LeveledLogMethod;
debug: LeveledLogMethod;
prompt: LeveledLogMethod;
http: LeveledLogMethod;
verbose: LeveledLogMethod;
input: LeveledLogMethod;
silly: LeveledLogMethod;

// for syslog levels only
emerg: LeveledLogMethod;
alert: LeveledLogMethod;
crit: LeveledLogMethod;
warning: LeveledLogMethod;
notice: LeveledLogMethod;

query(options?: QueryOptions, callback?: (err: Error, results: any) => void): any;
stream(options?: any): NodeJS.ReadableStream;

@@ -142,7 +144,7 @@ declare namespace winston {
isSillyEnabled(): boolean;

new(options?: LoggerOptions): Logger;
}
} & {[K in keyof T]: LeveledLogMethod;}

interface Container {
loggers: Map<string, Logger>;
@@ -162,7 +164,7 @@ declare namespace winston {
let loggers: Container;

let addColors: (target: Config.AbstractConfigSetColors) => any;
let createLogger: (options?: LoggerOptions) => Logger;
let createLogger: <T extends Config.AbstractConfigSetLevels = DefaulLevels>(options?: LoggerOptions<T>) => Logger<T>;

// Pass-through npm level methods routed to the default logger.
let error: LeveledLogMethod;
2 changes: 1 addition & 1 deletion lib/winston/logger.js
Original file line number Diff line number Diff line change
@@ -238,7 +238,7 @@ class Logger extends Transform {
message: msg
});

if (meta.message) info.message += `${meta.message}`;
if (meta.message) info.message = `${info.message} ${meta.message}`;
if (meta.stack) info.stack = meta.stack;

this.write(info);
24 changes: 4 additions & 20 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "winston",
"description": "A logger for just about everything.",
"version": "3.3.0",
"version": "3.3.1",
"author": "Charlie Robbins <charlie.robbins@gmail.com>",
"maintainers": [
"Jarrett Cruger <jcrugzz@gmail.com>",
@@ -27,7 +27,7 @@
],
"dependencies": {
"async": "^3.1.0",
"diagnostics": "^2.0.2",
"diagnostics": "DABH/diagnostics#master",
"is-stream": "^2.0.0",
"logform": "^2.2.0",
"one-time": "^1.0.0",
8 changes: 4 additions & 4 deletions test/formats/errors.test.js
Original file line number Diff line number Diff line change
@@ -110,7 +110,7 @@ describe('format.errors (integration)', function () {
format.printf(info => info.message)
));

logger.log('info', 'Caught error: ', new Error('Errors lack .toJSON() lulz'));
logger.log('info', 'Caught error:', new Error('Errors lack .toJSON() lulz'));
});

it('logger.log(level, msg, meta<error>) [custom error properties]', (done) => {
@@ -132,7 +132,7 @@ describe('format.errors (integration)', function () {
format.printf(info => info.message)
));

logger.log('info', 'Caught error: ', err);
logger.log('info', 'Caught error:', err);
});

it('logger.<level>(error)', (done) => {
@@ -209,7 +209,7 @@ describe('format.errors (integration)', function () {
format.printf(info => info.message)
));

logger.info('Caught error: ', new Error('Errors lack .toJSON() lulz'));
logger.info('Caught error:', new Error('Errors lack .toJSON() lulz'));
});

it('logger.<level>(msg, meta<error>) [custom error properties]', (done) => {
@@ -231,7 +231,7 @@ describe('format.errors (integration)', function () {
format.printf(info => info.message)
));

logger.info('Caught error: ', err);
logger.info('Caught error:', err);
});

it(`Promise.reject().catch(logger.<level>)`, (done) => {