@powerlines/core 0.8.3 → 0.8.67

package/dist/context/base-context.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-context.mjs","names":["#timestamp"],"sources":["../../src/context/base-context.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { EnvPaths } from \"@stryke/env/get-env-paths\";\nimport { resolvePackage } from \"@stryke/fs/resolve\";\nimport chalk from \"chalk\";\nimport { formatDistanceToNowStrict } from \"date-fns/formatDistanceToNowStrict\";\nimport { extendLogger } from \"../plugin-utils/logging\";\nimport { Options } from \"../types/config\";\nimport { BaseContext } from \"../types/context\";\nimport { LogFn, Logger, LoggerOptions, LogMessage } from \"../types/logging\";\n\nexport abstract class PowerlinesBaseContext<\n  TSystemContext = unknown\n> implements BaseContext<TSystemContext> {\n  #timestamp: number = Date.now();\n\n  public powerlinesPath!: string;\n\n  public system!: TSystemContext;\n\n  public abstract get envPaths(): EnvPaths;\n\n  public get logger(): Logger {\n    return this.createLogger();\n  }\n\n  public get cwd(): string {\n    return this.options.cwd || process.cwd();\n  }\n\n  public get timestamp(): number {\n    return this.#timestamp;\n  }\n\n  /**\n   * Initialize the context with the provided configuration options and set up the resolver and user configuration file. This method is called during the construction of the context and can also be called when cloning the context to ensure that the new context has the same configuration and resolver setup as the original context.\n   *\n   * @param options - The configuration options to initialize the context with, which can include properties such as the project root, mode, log level, and other settings that affect the behavior of the context and its plugins.\n   */\n  protected constructor(public options: Options) {}\n\n  public abstract createLogger(options?: LoggerOptions, logFn?: LogFn): Logger;\n\n  public extendLogger(options: LoggerOptions) {\n    return extendLogger(this.logger, options);\n  }\n\n  /**\n   * A logging function for fatal messages\n   *\n   * @param message - The message to log.\n   */\n  public fatal(message: string | LogMessage | Error) {\n    this.logger.error(\n      message instanceof Error\n        ? {\n            meta: {},\n            message: message.message,\n            error: message\n          }\n        : message\n    );\n  }\n\n  /**\n   * A logging function for error messages\n   *\n   * @param message - The message to log.\n   */\n  public error(message: string | LogMessage | Error) {\n    this.logger.error(\n      message instanceof Error\n        ? {\n            meta: {},\n            message: message.message,\n            error: message\n          }\n        : message\n    );\n  }\n\n  /**\n   * A logging function for warning messages\n   *\n   * @param message - The message to log.\n   */\n  public warn(message: string | LogMessage) {\n    this.logger.warn(message);\n  }\n\n  /**\n   * A logging function for informational messages\n   *\n   * @param message - The message to log.\n   */\n  public info(message: string | LogMessage) {\n    this.logger.info(message);\n  }\n\n  /**\n   * A logging function for debug messages\n   *\n   * @param message - The message to log.\n   */\n  public debug(message: string | LogMessage) {\n    this.logger.debug(message);\n  }\n\n  /**\n   * A logging function for trace messages\n   *\n   * @param message - The message to log.\n   */\n  public trace(message: string | LogMessage) {\n    this.logger.trace(message);\n  }\n\n  /**\n   * A function to create a timer for measuring the duration of asynchronous operations\n   *\n   * @example\n   * ```ts\n   * const stopTimer = context.timer(\"Your Async Operation\");\n   * await performAsyncOperation();\n   * stopTimer(); // \"Your Async Operation completed in 123.45 milliseconds\"\n   * ```\n   *\n   * @param name - The name of the timer.\n   * @returns A function that, when called, stops the timer and logs the duration.\n   */\n  public timer(name: string): () => void {\n    const startDate = Date.now();\n    const startDuration = performance.now();\n\n    return () => {\n      const duration = performance.now() - startDuration;\n      this.logger.info({\n        meta: {\n          category: \"performance\"\n        },\n        message: `${chalk.bold.cyanBright(name)} completed in ${chalk.bold.cyanBright(\n          duration < 1000\n            ? `${duration.toFixed(2)} milliseconds`\n            : formatDistanceToNowStrict(startDate)\n        )}`\n      });\n    };\n  }\n\n  /**\n   * Initialize the context with the provided configuration options\n   */\n  protected async init() {\n    if (!this.powerlinesPath) {\n      const powerlinesPath = await resolvePackage(\"powerlines\");\n      if (!powerlinesPath) {\n        throw new Error(\"Could not resolve `powerlines` package location.\");\n      }\n      this.powerlinesPath = powerlinesPath;\n    }\n  }\n}\n"],"mappings":";;;;;;AA2BA,IAAsB,wBAAtB,MAEyC;CACvC,aAAqB,KAAK,KAAK;CAE/B,AAAO;CAEP,AAAO;CAIP,IAAW,SAAiB;AAC1B,SAAO,KAAK,cAAc;;CAG5B,IAAW,MAAc;AACvB,SAAO,KAAK,QAAQ,OAAO,QAAQ,KAAK;;CAG1C,IAAW,YAAoB;AAC7B,SAAO,MAAKA;;;;;;;CAQd,AAAU,YAAY,AAAO,SAAkB;EAAlB;;CAI7B,AAAO,aAAa,SAAwB;AAC1C,SAAO,aAAa,KAAK,QAAQ,QAAQ;;;;;;;CAQ3C,AAAO,MAAM,SAAsC;AACjD,OAAK,OAAO,MACV,mBAAmB,QACf;GACE,MAAM,EAAE;GACR,SAAS,QAAQ;GACjB,OAAO;GACR,GACD,QACL;;;;;;;CAQH,AAAO,MAAM,SAAsC;AACjD,OAAK,OAAO,MACV,mBAAmB,QACf;GACE,MAAM,EAAE;GACR,SAAS,QAAQ;GACjB,OAAO;GACR,GACD,QACL;;;;;;;CAQH,AAAO,KAAK,SAA8B;AACxC,OAAK,OAAO,KAAK,QAAQ;;;;;;;CAQ3B,AAAO,KAAK,SAA8B;AACxC,OAAK,OAAO,KAAK,QAAQ;;;;;;;CAQ3B,AAAO,MAAM,SAA8B;AACzC,OAAK,OAAO,MAAM,QAAQ;;;;;;;CAQ5B,AAAO,MAAM,SAA8B;AACzC,OAAK,OAAO,MAAM,QAAQ;;;;;;;;;;;;;;;CAgB5B,AAAO,MAAM,MAA0B;EACrC,MAAM,YAAY,KAAK,KAAK;EAC5B,MAAM,gBAAgB,YAAY,KAAK;AAEvC,eAAa;GACX,MAAM,WAAW,YAAY,KAAK,GAAG;AACrC,QAAK,OAAO,KAAK;IACf,MAAM,EACJ,UAAU,eACX;IACD,SAAS,GAAG,MAAM,KAAK,WAAW,KAAK,CAAC,gBAAgB,MAAM,KAAK,WACjE,WAAW,MACP,GAAG,SAAS,QAAQ,EAAE,CAAC,iBACvB,0BAA0B,UAAU,CACzC;IACF,CAAC;;;;;;CAON,MAAgB,OAAO;AACrB,MAAI,CAAC,KAAK,gBAAgB;GACxB,MAAM,iBAAiB,MAAM,eAAe,aAAa;AACzD,OAAI,CAAC,eACH,OAAM,IAAI,MAAM,mDAAmD;AAErE,QAAK,iBAAiB"}