logger/index.js at master · jimcli/logger · GitHub

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
/* eslint-disable no-console */

const chalk = require('chalk');
const logSymbols = require('log-symbols');
const { argv } = require('yargs');
const timestamp = require('time-stamp');
const ora = require('ora');

/**
 * A simple Logging module
 *
 * This module contains static methods to log messages.
 */
module.exports = class Logger {
	/**
	 * Logs an info message
	 *
	 * @param {String} _message The message to log
	 */
	static info(_message, _force = false) {
		if ((argv.q || argv.quiet) && !_force) {
			return;
		}
		console.log(
			Logger.getTimestamp(),
			logSymbols.info,
			chalk.blue(_message)
		);
	}

	/**
	 * Logs a warning message
	 *
	 * @param {String} _message The message to log
	 */
	static warning(_message, _force = false) {
		if ((argv.q || argv.quiet) && !_force) {
			return;
		}
		console.log(
			Logger.getTimestamp(),
			logSymbols.warning,
			chalk.yellow(_message)
		);
	}

	/**
	 * Logs an error message
	 *
	 * @param {String} _message The message to log
	 */
	static error(_message, _force) {
		if ((argv.q || argv.quiet) && !_force) {
			return;
		}
		console.log(
			Logger.getTimestamp(),
			logSymbols.error,
			chalk.red(_message)
		);
	}

	/**
	 * Logs a success message
	 *
	 * @param {String} _message The message to log
	 */
	static success(_message, _force = false) {
		if ((argv.q || argv.quiet) && !_force) {
			return;
		}
		console.log(
			Logger.getTimestamp(),
			logSymbols.success,
			chalk.green(_message)
		);
	}

	static log(_message, _force = false) {
		if ((argv.q || argv.quiet) && !_force) {
			return;
		}
		console.log(Logger.getTimestamp(), _message);
	}

	/**
	 * Generates the output for the current timestamp
	 *
	 * @private
	 */
	static getTimestamp() {
		return chalk.dim(chalk.white(`[${timestamp('HH:mm:ss')}]`));
	}

	/**
	 * Displays a loading spinner
	 *
	 * @param {String} _message Message to display next to the loading spinner
	 */
	static showLoadingSpinner(_message) {
		this._spinner = ora(_message).start();
	}

	/**
	 * Removes the loading spinner
	 */
	static removeLoadingSpinner() {
		this._spinner.stop();
	}
};