Skip to content
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.

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

Make winston more ESM friendly #2006

Merged
merged 1 commit into from
Jan 10, 2022
Merged
Changes from all commits
Commits
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
54 changes: 24 additions & 30 deletions lib/winston.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,62 +10,56 @@
const logform = require('logform');
const { warn } = require('./winston/common');

/**
* Setup to expose.
* @type {Object}
*/
const winston = exports;

/**
* Expose version. Use `require` method for `webpack` support.
* @type {string}
*/
winston.version = require('../package.json').version;
exports.version = require('../package.json').version;
/**
* Include transports defined by default by winston
* @type {Array}
*/
winston.transports = require('./winston/transports');
exports.transports = require('./winston/transports');
/**
* Expose utility methods
* @type {Object}
*/
winston.config = require('./winston/config');
exports.config = require('./winston/config');
/**
* Hoist format-related functionality from logform.
* @type {Object}
*/
winston.addColors = logform.levels;
exports.addColors = logform.levels;
/**
* Hoist format-related functionality from logform.
* @type {Object}
*/
winston.format = logform.format;
exports.format = logform.format;
/**
* Expose core Logging-related prototypes.
* @type {function}
*/
winston.createLogger = require('./winston/create-logger');
exports.createLogger = require('./winston/create-logger');
/**
* Expose core Logging-related prototypes.
* @type {Object}
*/
winston.ExceptionHandler = require('./winston/exception-handler');
exports.ExceptionHandler = require('./winston/exception-handler');
/**
* Expose core Logging-related prototypes.
* @type {Object}
*/
winston.RejectionHandler = require('./winston/rejection-handler');
exports.RejectionHandler = require('./winston/rejection-handler');
/**
* Expose core Logging-related prototypes.
* @type {Container}
*/
winston.Container = require('./winston/container');
exports.Container = require('./winston/container');
/**
* Expose core Logging-related prototypes.
* @type {Object}
*/
winston.Transport = require('winston-transport');
exports.Transport = require('winston-transport');
/**
* We create and expose a default `Container` to `winston.loggers` so that the
* programmer may manage multiple `winston.Logger` instances without any
Expand All @@ -77,7 +71,7 @@ winston.Transport = require('winston-transport');
* // some-file2.js
* const logger = require('winston').loggers.get('something');
*/
winston.loggers = new winston.Container();
exports.loggers = new exports.Container();

/**
* We create and expose a 'defaultLogger' so that the programmer may do the
Expand All @@ -87,10 +81,10 @@ winston.loggers = new winston.Container();
* winston.log('info', 'some message');
* winston.error('some error');
*/
const defaultLogger = winston.createLogger();
const defaultLogger = exports.createLogger();

// Pass through the target methods onto `winston.
Object.keys(winston.config.npm.levels)
Object.keys(exports.config.npm.levels)
.concat([
'log',
'query',
Expand All @@ -108,15 +102,15 @@ Object.keys(winston.config.npm.levels)
'child'
])
.forEach(
method => (winston[method] = (...args) => defaultLogger[method](...args))
method => (exports[method] = (...args) => defaultLogger[method](...args))
);

/**
* Define getter / setter for the default logger level which need to be exposed
* by winston.
* @type {string}
*/
Object.defineProperty(winston, 'level', {
Object.defineProperty(exports, 'level', {
get() {
return defaultLogger.level;
},
Expand All @@ -130,7 +124,7 @@ Object.defineProperty(winston, 'level', {
* `unhandleExceptions`.
* @type {Object}
*/
Object.defineProperty(winston, 'exceptions', {
Object.defineProperty(exports, 'exceptions', {
get() {
return defaultLogger.exceptions;
}
Expand All @@ -142,7 +136,7 @@ Object.defineProperty(winston, 'exceptions', {
* @type {Logger}
*/
['exitOnError'].forEach(prop => {
Object.defineProperty(winston, prop, {
Object.defineProperty(exports, prop, {
get() {
return defaultLogger[prop];
},
Expand All @@ -156,7 +150,7 @@ Object.defineProperty(winston, 'exceptions', {
* The default transports and exceptionHandlers for the default winston logger.
* @type {Object}
*/
Object.defineProperty(winston, 'default', {
Object.defineProperty(exports, 'default', {
get() {
return {
exceptionHandlers: defaultLogger.exceptionHandlers,
Expand All @@ -168,15 +162,15 @@ Object.defineProperty(winston, 'default', {

// Have friendlier breakage notices for properties that were exposed by default
// on winston < 3.0.
warn.deprecated(winston, 'setLevels');
warn.forFunctions(winston, 'useFormat', ['cli']);
warn.forProperties(winston, 'useFormat', ['padLevels', 'stripColors']);
warn.forFunctions(winston, 'deprecated', [
warn.deprecated(exports, 'setLevels');
warn.forFunctions(exports, 'useFormat', ['cli']);
warn.forProperties(exports, 'useFormat', ['padLevels', 'stripColors']);
warn.forFunctions(exports, 'deprecated', [
'addRewriter',
'addFilter',
'clone',
'extend'
]);
warn.forProperties(winston, 'deprecated', ['emitErrs', 'levelLength']);
warn.forProperties(exports, 'deprecated', ['emitErrs', 'levelLength']);
// Throw a useful error when users attempt to run `new winston.Logger`.
warn.moved(winston, 'createLogger', 'Logger');
warn.moved(exports, 'createLogger', 'Logger');