projen
Version:
CDK for software projects
117 lines • 12.7 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.LogLevel = exports.Logger = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const chalk_1 = __importDefault(require("chalk"));
const common_1 = require("./common");
const component_1 = require("./component");
const logging_1 = require("./logging");
const util_1 = require("./util");
const constructs_1 = require("./util/constructs");
/**
* Project-level logging utilities.
*/
class Logger extends component_1.Component {
static [JSII_RTTI_SYMBOL_1] = { fqn: "projen.Logger", version: "0.103.12" };
level;
usePrefix;
constructor(scope, options = {}) {
const project = (0, constructs_1.findClosestProject)(scope, new.target.name);
super(scope, `${new.target.name}#${project.name}`);
// if we are running inside a test, default to no logs
const defaultLevel = common_1.IS_TEST_RUN ? LogLevel.OFF : LogLevel.INFO;
this.level = options.level ?? defaultLevel;
this.usePrefix = options.usePrefix ?? false;
}
/**
* Log a message to stderr with a given logging level. The message will be
* printed as long as `logger.level` is set to the message's severity or higher.
*
* @param level Logging verbosity
* @param text strings or objects to print
*/
log(level, ...text) {
if (level === LogLevel.OFF) {
throw new Error("Cannot log a message with level LogLevel.OFF");
}
let maxLevel = this.level;
// logging level can be overridden through the --debug CLI option
if ((0, util_1.isTruthy)(process.env.DEBUG) && maxLevel < LogLevel.DEBUG) {
maxLevel = LogLevel.DEBUG;
}
if (level <= maxLevel) {
const color = this.colorForLogLevel(level) ??
((...values) => values.join(" "));
const prefix = this.usePrefix ? `[${this.project.name}] ` : "";
console.error(`${logging_1.ICON} ${prefix}${color(...text)}`);
}
}
/**
* Log a message to stderr with VERBOSE severity
* @param text strings or objects to print
*/
verbose(...text) {
this.log(LogLevel.VERBOSE, ...text);
}
/**
* Log a message to stderr with DEBUG severity
* @param text strings or objects to print
*/
debug(...text) {
this.log(LogLevel.DEBUG, ...text);
}
/**
* Log a message to stderr with INFO severity
* @param text strings or objects to print
*/
info(...text) {
this.log(LogLevel.INFO, ...text);
}
/**
* Log a message to stderr with WARN severity
* @param text strings or objects to print
*/
warn(...text) {
this.log(LogLevel.WARN, ...text);
}
/**
* Log a message to stderr with ERROR severity
* @param text strings or objects to print
*/
error(...text) {
this.log(LogLevel.ERROR, ...text);
}
colorForLogLevel(level) {
switch (level) {
case LogLevel.ERROR:
return chalk_1.default.red;
case LogLevel.WARN:
return chalk_1.default.yellow;
case LogLevel.INFO:
return chalk_1.default.cyan;
case LogLevel.DEBUG:
return chalk_1.default.gray;
case LogLevel.VERBOSE:
return chalk_1.default.white;
default:
return chalk_1.default.white;
}
}
}
exports.Logger = Logger;
/**
* Logging verbosity.
*/
var LogLevel;
(function (LogLevel) {
LogLevel["OFF"] = "00.off";
LogLevel["ERROR"] = "10.error";
LogLevel["WARN"] = "20.warn";
LogLevel["INFO"] = "30.info";
LogLevel["DEBUG"] = "40.debug";
LogLevel["VERBOSE"] = "50.verbose";
})(LogLevel || (exports.LogLevel = LogLevel = {}));
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;;;AAAA,kDAA0B;AAE1B,qCAAuC;AACvC,2CAAwC;AACxC,uCAAiC;AACjC,iCAAkC;AAClC,kDAAuD;AAsBvD;;GAEG;AACH,MAAa,MAAO,SAAQ,qBAAS;;IAClB,KAAK,CAAW;IAChB,SAAS,CAAU;IAEpC,YAAY,KAAiB,EAAE,UAAyB,EAAE;QACxD,MAAM,OAAO,GAAG,IAAA,+BAAkB,EAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEnD,sDAAsD;QACtD,MAAM,YAAY,GAAG,oBAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAEhE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACI,GAAG,CAAC,KAAe,EAAE,GAAG,IAAW;QACxC,IAAI,KAAK,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;QAE1B,iEAAiE;QACjE,IAAI,IAAA,eAAQ,EAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7D,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC5B,CAAC;QAED,IAAI,KAAK,IAAI,QAAQ,EAAE,CAAC;YACtB,MAAM,KAAK,GACT,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;gBAC5B,CAAC,CAAC,GAAG,MAAgB,EAAU,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,OAAO,CAAC,KAAK,CAAC,GAAG,cAAI,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,GAAG,IAAW;QAC3B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,IAAW;QACzB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,GAAG,IAAW;QACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,GAAG,IAAW;QACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,IAAW;QACzB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAEO,gBAAgB,CAAC,KAAe;QACtC,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,QAAQ,CAAC,KAAK;gBACjB,OAAO,eAAK,CAAC,GAAG,CAAC;YACnB,KAAK,QAAQ,CAAC,IAAI;gBAChB,OAAO,eAAK,CAAC,MAAM,CAAC;YACtB,KAAK,QAAQ,CAAC,IAAI;gBAChB,OAAO,eAAK,CAAC,IAAI,CAAC;YACpB,KAAK,QAAQ,CAAC,KAAK;gBACjB,OAAO,eAAK,CAAC,IAAI,CAAC;YACpB,KAAK,QAAQ,CAAC,OAAO;gBACnB,OAAO,eAAK,CAAC,KAAK,CAAC;YACrB;gBACE,OAAO,eAAK,CAAC,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;;AAlGH,wBAmGC;AAED;;GAEG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,0BAAc,CAAA;IACd,8BAAkB,CAAA;IAClB,4BAAgB,CAAA;IAChB,4BAAgB,CAAA;IAChB,8BAAkB,CAAA;IAClB,kCAAsB,CAAA;AACxB,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB","sourcesContent":["import chalk from \"chalk\";\nimport type { IConstruct } from \"constructs\";\nimport { IS_TEST_RUN } from \"./common\";\nimport { Component } from \"./component\";\nimport { ICON } from \"./logging\";\nimport { isTruthy } from \"./util\";\nimport { findClosestProject } from \"./util/constructs\";\n\n/**\n * Options for logging utilities.\n */\nexport interface LoggerOptions {\n  /**\n   * The logging verbosity. The levels available (in increasing verbosity) are\n   * OFF, ERROR, WARN, INFO, DEBUG, and VERBOSE.\n   *\n   * @default LogLevel.INFO\n   */\n  readonly level?: LogLevel;\n\n  /**\n   * Include a prefix for all logging messages with the project name.\n   *\n   * @default false\n   */\n  readonly usePrefix?: boolean;\n}\n\n/**\n * Project-level logging utilities.\n */\nexport class Logger extends Component {\n  private readonly level: LogLevel;\n  private readonly usePrefix: boolean;\n\n  constructor(scope: IConstruct, options: LoggerOptions = {}) {\n    const project = findClosestProject(scope, new.target.name);\n    super(scope, `${new.target.name}#${project.name}`);\n\n    // if we are running inside a test, default to no logs\n    const defaultLevel = IS_TEST_RUN ? LogLevel.OFF : LogLevel.INFO;\n\n    this.level = options.level ?? defaultLevel;\n    this.usePrefix = options.usePrefix ?? false;\n  }\n\n  /**\n   * Log a message to stderr with a given logging level. The message will be\n   * printed as long as `logger.level` is set to the message's severity or higher.\n   *\n   * @param level Logging verbosity\n   * @param text strings or objects to print\n   */\n  public log(level: LogLevel, ...text: any[]) {\n    if (level === LogLevel.OFF) {\n      throw new Error(\"Cannot log a message with level LogLevel.OFF\");\n    }\n\n    let maxLevel = this.level;\n\n    // logging level can be overridden through the --debug CLI option\n    if (isTruthy(process.env.DEBUG) && maxLevel < LogLevel.DEBUG) {\n      maxLevel = LogLevel.DEBUG;\n    }\n\n    if (level <= maxLevel) {\n      const color =\n        this.colorForLogLevel(level) ??\n        ((...values: string[]): string => values.join(\" \"));\n      const prefix = this.usePrefix ? `[${this.project.name}] ` : \"\";\n      console.error(`${ICON} ${prefix}${color(...text)}`);\n    }\n  }\n\n  /**\n   * Log a message to stderr with VERBOSE severity\n   * @param text strings or objects to print\n   */\n  public verbose(...text: any[]) {\n    this.log(LogLevel.VERBOSE, ...text);\n  }\n\n  /**\n   * Log a message to stderr with DEBUG severity\n   * @param text strings or objects to print\n   */\n  public debug(...text: any[]) {\n    this.log(LogLevel.DEBUG, ...text);\n  }\n\n  /**\n   * Log a message to stderr with INFO severity\n   * @param text strings or objects to print\n   */\n  public info(...text: any[]) {\n    this.log(LogLevel.INFO, ...text);\n  }\n\n  /**\n   * Log a message to stderr with WARN severity\n   * @param text strings or objects to print\n   */\n  public warn(...text: any[]) {\n    this.log(LogLevel.WARN, ...text);\n  }\n\n  /**\n   * Log a message to stderr with ERROR severity\n   * @param text strings or objects to print\n   */\n  public error(...text: any[]) {\n    this.log(LogLevel.ERROR, ...text);\n  }\n\n  private colorForLogLevel(level: LogLevel): chalk.ChalkFunction {\n    switch (level) {\n      case LogLevel.ERROR:\n        return chalk.red;\n      case LogLevel.WARN:\n        return chalk.yellow;\n      case LogLevel.INFO:\n        return chalk.cyan;\n      case LogLevel.DEBUG:\n        return chalk.gray;\n      case LogLevel.VERBOSE:\n        return chalk.white;\n      default:\n        return chalk.white;\n    }\n  }\n}\n\n/**\n * Logging verbosity.\n */\nexport enum LogLevel {\n  OFF = \"00.off\",\n  ERROR = \"10.error\",\n  WARN = \"20.warn\",\n  INFO = \"30.info\",\n  DEBUG = \"40.debug\",\n  VERBOSE = \"50.verbose\",\n}\n"]}