Function logger

logger(__namedParameters?: LoggerOptions): Plugin<LoggerMeta>

A minimal logger plugin that logs the result of each execution step. By default, it uses the Client from Context. If a logFile is provided, it will log to that file instead.

The logger can be enabled or disabled at any time by emitting one of the LoggerHooks events:

enableLogger: Turns the logger on.
disableLogger: Turns the logger off.
toggleLogger: Toggles the logger on or off.

Parameters

__namedParameters: LoggerOptions = {}

Returns Plugin<LoggerMeta>

Example

Basic Usage

import { run, logger } from '@gud/cli';

run({ plugins: [logger()] });

Advanced Usage

import { run, logger } from '@gud/cli';

function timestamp() {
  return new Date().toISOString();
}

run({
  plugins: [
    logger({
      prefix: timestamp,
      logFile: `logs/${timestamp()}.log`,
      enabled: process.env.NODE_ENV === 'development',
    })
  ],
});

Enable/Disable/Toggle the logger in a command

import { command, disableLogger, enableLogger } from '@gud/cli';

export default command({
  options: {
    v {
      description: 'Enable verbose logging',
      type: 'boolean',
      default: false,
    },
  },
  handler: async ({ options, context }) => {
    const verbose = await options.verbose();

    if (verbose) {
      enableLogger();
    } else {
      disableLogger();
    }

    // rest of the command...
  },
});