# All files / lib winston.js

94.12% Statements 32/34
100% Branches 0/0
100% Functions 3/3
93.94% Lines 31/33

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180

    7x
    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    7x

    126x

    7x

    1x

    7x

    1x

    7x

    7x

    1x

    7x

    1x

    7x
    7x
    7x

    7x

    7x

    7x
     /**
     * winston.js: Top-level include defining Winston.
     *
     * (C) 2010 Charlie Robbins
     * MIT LICENCE
     */

    'use strict';

    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;
    /**
     * Include transports defined by default by winston
     * @type {Array}
     */
    winston.transports = require('./winston/transports');
    /**
     * Expose utility methods
     * @type {Object}
     */
    winston.config = require('./winston/config');
    /**
     * Hoist format-related functionality from logform.
     * @type {Object}
     */
    winston.addColors = logform.levels;
    /**
     * Hoist format-related functionality from logform.
     * @type {Object}
     */
    winston.format = logform.format;
    /**
     * Expose core Logging-related prototypes.
     * @type {function}
     */
    winston.createLogger = require('./winston/create-logger');
    /**
     * Expose core Logging-related prototypes.
     * @type {Object}
     */
    winston.ExceptionHandler = require('./winston/exception-handler');
    /**
     * Expose core Logging-related prototypes.
     * @type {Container}
     */
    winston.Container = require('./winston/container');
    /**
     * Expose core Logging-related prototypes.
     * @type {Object}
     */
    winston.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
     * additional overhead.
     * @example
     *   // some-file1.js
     *   const logger = require('winston').loggers.get('something');
     *
     *   // some-file2.js
     *   const logger = require('winston').loggers.get('something');
     */
    winston.loggers = new winston.Container();

    /**
     * We create and expose a 'defaultLogger' so that the programmer may do the
     * following without the need to create an instance of winston.Logger directly:
     * @example
     *   const winston = require('winston');
     *   winston.log('info', 'some message');
     *   winston.error('some error');
     */
    const defaultLogger = winston.createLogger();

    // Pass through the target methods onto `winston.
    Object.keys(winston.config.npm.levels).concat([
      'log',
      'query',
      'stream',
      'add',
      'remove',
      'clear',
      'profile',
      'startTimer',
      'handleExceptions',
      'unhandleExceptions',
      'configure'
    ]).forEach(method => (
      winston[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', {
      get() {
        return defaultLogger.level;
      },
      set(val) {
        defaultLogger.level = val;
      }
    });

    /**
     * Define getter for `exceptions` which replaces `handleExceptions` and
     * `unhandleExceptions`.
     * @type {Object}
     */
    Object.defineProperty(winston, 'exceptions', {
      get() {
        return defaultLogger.exceptions;
      }
    });

    /**
     * Define getters / setters for appropriate properties of the default logger
     * which need to be exposed by winston.
     * @type {Logger}
     */
    [
      'exitOnError'
    ].forEach(prop => {
      Object.defineProperty(winston, prop, {
        get() {
          return defaultLogger[prop];
        },
        set(val) {
          defaultLogger[prop] = val;
        }
      });
    });

    /**
     * The default transports and exceptionHandlers for the default winston logger.
     * @type {Object}
     */
    Object.defineProperty(winston, 'default', {
      get() {
        return {
          exceptionHandlers: defaultLogger.exceptionHandlers,
          transports: defaultLogger.transports
        };
      }
    });

    // 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', [
      'addRewriter',
      'addFilter',
      'clone',
      'extend'
    ]);
    warn.forProperties(winston, 'deprecated', [
      'emitErrs',
      'levelLength'
    ]);
    // Throw a useful error when users attempt to run `new winston.Logger`.
    warn.moved(winston, 'createLogger', 'Logger');