mirror of https://github.com/thumbsup/thumbsup
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
3.3 KiB
JavaScript
97 lines
3.3 KiB
JavaScript
const fs = require('node:fs')
|
|
const util = require('node:util')
|
|
const tty = require('node:tty')
|
|
const debug = require('debug')
|
|
|
|
/*
|
|
Thumbsup uses the <debug> package for logging.
|
|
It supports two main ways of logging:
|
|
|
|
1. when --log is not specified
|
|
- This ignores all detailed logging calls
|
|
- It simply renders progress using Listr on <stdout>
|
|
- Warning and error are sent to <thumbsup.log> in the output folder for troubleshooting
|
|
|
|
2. when --log is specified
|
|
- This switches Listr to text mode, e.g. "Task XYZ [completed]"
|
|
- It renders log messages to <stdout>
|
|
- The logging level can be configured between info|debug|trace
|
|
- Warnings and errors are always shown, because level is > info|debug|trace
|
|
- <thumbsup.log> is not created by default
|
|
- You can always redirect or tee the output to a file if needed
|
|
|
|
If --log is not specified, but the output doesn't support ANSI (e.g. non-TTY terminal, or file redirection)
|
|
then the mode is automatically switched to "--log info"
|
|
*/
|
|
exports.init = (logLevel, logFile) => {
|
|
// if the output doesn't support ANSI codes (e.g. pipe, redirect to file)
|
|
// then switch to full-text mode, because Listr's output won't make much sense
|
|
if (logLevel === 'default' && !tty.isatty(process.stdout.fd)) {
|
|
logLevel = 'info'
|
|
}
|
|
|
|
// Configure the loggers
|
|
if (logLevel === 'default') {
|
|
configureDefaultMode(logFile)
|
|
} else {
|
|
configureDebugMode(logLevel)
|
|
}
|
|
}
|
|
|
|
/*
|
|
The <debug> package repeats the date + prefix for every log line, but only when using colors
|
|
This fix adds the same behaviour in non-color mode
|
|
It's important so the log files are easy to grep
|
|
*/
|
|
function overrideDebugFormat () {
|
|
debug.formatArgs = function (args) {
|
|
const prefix = new Date().toISOString() + ' ' + this.namespace + ' '
|
|
args[0] = prefix + args[0].split('\n').join('\n' + prefix)
|
|
}
|
|
}
|
|
|
|
/*
|
|
If --log is not specified, we won't show any detailed log on stdout
|
|
Instead we send all errors to a file for troubleshooting
|
|
*/
|
|
function configureDefaultMode (logFile) {
|
|
const stream = fs.createWriteStream(logFile, { flags: 'a' })
|
|
overrideDebugFormat()
|
|
debug.enable('thumbsup:error,thumbsup:warn')
|
|
debug.useColors = () => false
|
|
debug.log = function () {
|
|
const line = util.format.apply(util, arguments) + '\n'
|
|
stream.write(line)
|
|
}
|
|
}
|
|
|
|
/*
|
|
--log mode configuration
|
|
*/
|
|
function configureDebugMode (logLevel) {
|
|
// because Listr logs to stdout (not configurable), make debug() do the same
|
|
// otherwise file redirection gets very confusing
|
|
debug.log = function () {
|
|
const line = util.format.apply(util, arguments) + '\n'
|
|
process.stdout.write(line)
|
|
}
|
|
|
|
// TTY-related configuration
|
|
const supportsANSI = tty.isatty(process.stdout.fd)
|
|
debug.useColors = () => supportsANSI
|
|
if (!supportsANSI) {
|
|
overrideDebugFormat()
|
|
}
|
|
|
|
// enable the right log levels
|
|
if (logLevel === 'trace') debug.enable('*')
|
|
if (logLevel === 'debug') debug.enable('thumbsup:error,thumbsup:warn,thumbsup:info,thumbsup:debug')
|
|
if (logLevel === 'info') debug.enable('thumbsup:error,thumbsup:warn,thumbsup:info')
|
|
|
|
// capture any additional console.log() calls, including Listr task updates
|
|
console.log = require('debug')('thumbsup:info')
|
|
console.info = require('debug')('thumbsup:info')
|
|
console.warn = require('debug')('thumbsup:warn')
|
|
console.error = require('debug')('thumbsup:error')
|
|
}
|