CHANGELOG.md 28 KB

CHANGELOG

v3.1.0 / 2018-08-22

RELEASES ON A PLANE EDITION

  • Minor TypeScript fixes [#1362], [#1395], [#1440]
  • Fix minor typos [#1359], [#1363], [#1372], [#1378], [#1390]
  • [#1373], (@revik): Add consoleWarnLevels property to console transport options for console.warn browser support.
  • [#1394], (@bzoz): Fix tests on Windows.
  • [#1447], (@dboshardy): Support transport name option to override default names for built-in transports.
  • [#1420], (@ledbit): Fix file rotation with tailing: true (Fixes [#1450], [#1194]).
  • [#1352], (@lutovich): Add isLevelEnabled(string) & isXXXEnabled() to Logger class.
  • Dependency management
    • Regenerate package-lock.json.
    • Upgrade to colors@^1.3.2 (Fixes [#1439]).
    • Upgrade to logform@^1.9.1.
    • Upgrade to diagnostics@^1.1.1.
    • Upgrade to @types/node@^10.9.3.
    • Upgrade to assume@^2.1.0.
    • Upgrade to hock@^1.3.3.
    • Upgrade to mocha@^5.2.0.
    • Upgrade to nyc@^13.0.1.
    • Upgrade to split2@^3.0.0.

v3.0.0 / 2018-06-12

GET IN THE CHOPPA EDITION

  • [#1332], (@DABH): logger.debug is sent to stderr (Fixed [#1024])
  • [#1328], (@ChrisAlderson): Logger level doesn't update transports level (Fixes [#1191]).
  • [#1356], (@indexzero) Move splat functionality into logform. (Fixes [#1298]).
  • [#1340], (@indexzero): Check log.length when evaluating "legacyness" of transports (Fixes [#1280]).
  • [#1346], (@indexzero): Implement _final from Node.js streams. (Related to winston-transport#24, Fixes [#1250]).
  • [#1347], (@indexzero): Wrap calls to format.transform with try / catch (Fixes [#1261]).
  • [#1357], (@indexzero): Remove paddings as we have no use for it in the current API.
  • [TODO]: REMAINS OPEN, NO PR (Fixes [#1289])
  • Documentation
    • [#1301], (@westonpace) Cleaned up some of the documentation on colorize to address concerns in [#1095].
    • First pass at a heavy refactor of docs/transports.md.
  • Dependency management
    • Regenerate package-lock.json.
    • Upgrade to logform@^1.9.0.

v3.0.0-rc6 / 2018-05-30

T-MINUS 6-DAY TO WINSTON@3 EDITION

  • Document that we are pushing for a June 5th, 2018 release of winston@3.0.0
  • [#1287], (@DABH) Added types for Typescript.
    • [#1335] Typescript: silent is boolean.
    • [#1323] Add level method to default logger.
  • [#1286], (@ChrisAlderson) Migrate codebase to ES6
  • [#1291], [#1294], [#1318], (@indexzero, @ChrisAlderson, @mempf) Improvements to File transport core functionality. Fixes [#1194].
  • [#1311], (@ChrisAlderson) Add eol option to Stream transport.
  • [#1297], (@ChrisAlderson) Move winston.config to triple-beam. Expose for backwards compatibility.
  • [#1320], (@ChrisAlderson) Enhance tests to run on Windows.
  • Internal project maintenance
    • Bump to winston-transport@4.0.0 which may cause incompatibilities if your custom transport does not explicitly require winston-transport itself.
    • [#1292], (@ChrisAlderson) Add node v10 to TravisCI build matrix.
    • [#1296], (@indexzero) Improve UPGRADE-3.0.md. Add Github Issue Template.
    • Remove "npm run report" in favor of reports being automatically generate.
    • Update logform, triple-beam, and winston-transport to latest.

Special thanks to our newest winston core team member – @ChrisAlderson for helping make winston@3.0.0 a reality next week!

v3.0.0-rc5 / 2018-04-20

UNOFFICIAL NATIONAL HOLIDAY EDITION

  • [#1281] Use Buffer.alloc and Buffer.from instead of new Buffer.
  • Better browser support
    • [#1142] Move common tailFile to a separate file
    • [#1279] Use feature detection to be safer for browser usage.
  • MOAR Docs!
    • Document that we are pushing for a May 29th, 2018 release of winston@3.0.0
    • Add David Hyde as official contributor.
    • [#1278] Final Draft of Upgrade Guide in UPGRADE-3.0.md
    • Merge Roadmap from 3.0.0.md into CONTRIBUTING.md and other improvements to CONTRIBUTING.md
  • Improve & expand examples
    • [#1175] Add more copy about printf formats based on issue feedback.
    • [#1134] Add sampleto document timestamps more clearly as an example.
    • [#1273] Add example using multiple formats.
    • [#1250] Add an example illustrating the "finish" event for AWS Lambda scenarios.
    • Use simple format to better show that humanReadableUnhandledException is now the default message format.
    • Add example to illustrate that example code from winston-transport README.md is correct.
  • Update devDependencies
    • Bump assume to ^2.0.1.
    • Bump winston-compat to ^0.1.1.

v3.0.0-rc4 / 2018-04-06

IF A TREE FALLS IN THE FORREST DOES IT MAKE A LOG EDITION

  • (@indexzero, @dabh) Add support for { silent } option to

    require('winston').Logger;
    require('winston-transport').TransportStream;
    
    • Better browser support
    • [#1145], (@Jasu) Replace isstream with is-stream to make stream detection work in browser.
    • [#1146], (@Jasu) Rename query to different than function name, to support Babel 6.26.
    • Better Typescript support in all supporting libraries
    • logform@1.4.1
    • Update documentation
    • (@indexzero) Correct link to upgrade guide. Fixes #1255.
    • [#1258], (@morenoh149) Document how to colorize levels. Fixes #1135.
    • [#1246], (@KlemenPlazar) Update colors argument when adding custom colors
    • Update CONTRIBUTING.md
    • [#1239], (@dabh) Add changelog entries for v3.0.0-rc3
    • Add example showing that { level } can be deleted from info objects because Symbol.for('level') is what winston uses internally. Fixes #1184.

    v3.0.0-rc3 / 2018-03-16

    I GOT NOTHING EDITION

    • [#1195], (@Nilegfx) Fix type error when creating new stream.Stream()
    • [#1109], (@vsetka) Fix file transprot bug where self.filename was not being updated on ENOENT
    • [#1153], (@wizardnet972) Make prototype methods return like the original method
    • [#1234], (@guiguan, @indexzero) Add tests for properly handling logging of undefined, null and Error values
    • [#1235], (@indexzero) Add example demonstrating how meta objects BECOME the info object
    • Minor fixes to docs & examples: [#1232], [#1185]

    v3.0.0-rc2 / 2018-03-09

    MAINTENANCE RESUMES EDITION

    v3.0.0-rc1 / 2017-10-19

    OMG THEY FORGOT TO NAME IT EDITION

    • Fix file transport improper binding of _onDrain and _onError #1104

    v3.0.0-rc0 / 2017-10-02

    IT'S-DONE.GIF EDITION

    See UPGRADE-3.0.md for a complete & living upgrade guide.

    See 3.0.0.md for a list of remaining RC tasks.

    • Rewrite of core logging internals: Logger & Transport are now implemented using Node.js objectMode streams.
    • Your transports should not break: Special attention has been given to ensure backwards compatibility with existing transports. You will likely see this: ```

YourTransport is a legacy winston transport. Consider upgrading to winston@3:

  • Upgrade docs: https://github.com/winstonjs/winston/tree/master/UPGRADE.md

    - **`filters`, `rewriters`, and `common.log` are now _formats_:** `winston.format` offers a simple mechanism for user-land formatting & style features. The organic & frankly messy growth of `common.log` is of the past; these feature requests can be implemented entirely outside of `winston` itself.
    ``` js
    const { createLogger, format, transports } = require('winston');
    const { combine, timestamp, label, printf } = format;
    
    const myFormat = printf(info => {
    return `${info.timestamp} [${info.label}] ${info.level}: ${info.message}`;
    });
    
    const logger = createLogger({
    combine(
    label({ label: 'right meow!' }),
    timestamp(),
    myFormat
    ),
    transports: [new transports.Console()]
    });
    
  • Increased modularity: several subsystems are now stand-alone packages:

    • [logform] exposed as winston.format
    • [winston-transport] exposed as winston.Transport
    • [abstract-winston-transport] used for reusable unit test suites for transport authors.
  • 2.x branch will get little to no maintenance: no feature requests will be accepted – only a limited number of open PRs will be merged. Hoping the [significant performance benefits][perf-bench] incentivizes folks to upgrade quickly. Don't agree? Say something!

  • No guaranteed support for node@4 or below: all code will be migrated to ES6 over time. This release was started when ES5 was still a hard requirement due to the current LTS needs.

v2.4.0 / 2017-10-01

ZOMFG WINSTON@3.0.0-RC0 EDITION

  • [#1036] Container.add() 'filters' and 'rewriters' option passing to logger.
  • [#1066] Fixed working of "humanReadableUnhandledException" parameter when additional data is added in meta.
  • [#1040] Added filtering by log level
  • [#1042] Fix regressions brought by 2.3.1.
    • Fix regression on array printing.
    • Fix regression on falsy value.
  • [#977] Always decycle objects before cloning.
  • [57af38a] Missing context in .lazyDrain of File transport.
  • [178935f] Suppress excessive Node warning from fs.unlink.
  • [fcf04e1] Add label option to File transport docs.
  • [7e736b4], [24300e2] Added more info about undocumented winston.startTimer() method.
  • [#1076], [#1082], [#1029], [#989], [e1e7188] Minor grammatical & style updates to README.md.

v2.3.1 / 2017-01-20

WELCOME TO THE APOCALYPSE EDITION

  • #868, Fix 'Maximum call stack size exceeded' error with custom formatter.

v2.3.0 / 2016-11-02

ZOMG WHY WOULD YOU ASK EDITION

v2.2.0 / 2016-02-25

LEAVING CALIFORNIA EDITION

v2.1.1 / 2015-11-18

COLOR ME IMPRESSED EDITION

  • #751, Fix colors not appearing in non-tty environments. Fixes #609, #616, #669, #648 (fiznool).
  • #752 Correct syslog RFC number. 5424 instead of 524. (jbenoit2011)

v2.1.0 / 2015-11-03

TEST ALL THE ECOSYSTEM EDITION

  • #742, 32d52b7 Distribute common test files used by transports in the winston ecosystem.

v2.0.1 / 2015-11-02

BUGS ALWAYS HAPPEN OK EDITION

  • #739, 1f16861 Ensure that logger.log("info", undefined) does not throw.

v2.0.0 / 2015-10-29

OMG IT'S MY SISTER'S BIRTHDAY EDITION

Breaking changes

Most important