@canopycanopycanopy/b-ber-logger 3.0.8-nav.0 → 3.0.8-next.96

package/README.md

@@ -1,58 +1,31 @@
 # `@canopycanopycanopy/b-ber-logger`
 
-`b-ber-logger` is b-ber's console logger.
-
-## Install
-
-```
-$ npm i -g @canopycanopycanopy/b-ber-logger
-```
-
-## Usage
-
-Output from `bber` commands can be logged to the console with different levels of verbosity.
-
-### Arguments
-
-#### `--quiet`
-
-The `--quiet` flag will emit nothing to the console and is an alias of `loglevel=0`.
-
-```
-$ bber build --quiet
-$ bber build --log-level=0
-```
-
-#### `--warn`
-
-The `---warn` flag will emit warnings and single-line error messages to the console and is an alias of `loglevel=1`.
-
-```
-$ bber build --warn
-$ bber build --log-level=1
-```
-
-#### `--error`
-
-The `--error` flag will emit warnings and stack traces for errors to the console and is an alias of `loglevel=2`.
-
-```
-$ bber build --error
-$ bber build --log-level=2
-```
-
-#### `--verbose`
-
-The `--verbose` flat will emit messages, warnings, errors and stack traces to the console.
-
-```
-$ bber build --verbose
-```
-
-#### `--debug`
-
-The `--debug` flag will emit stack traces for everything, as well as warnings and errors to the console.
-
-```
-$ bber build --debug
+`b-ber-logger` is the logging utility for the b-ber build pipeline. It exports a single `Logger` singleton (`log`) that all other packages import instead of using `console.log` directly. The logger supports levelled output (`info`, `warn`, `error`, `debug`, `trace`, `notice`, `inspect`), chalk-coloured formatting, indentation tracking across nested task steps, a build-run timer, end-of-run summary of collected warnings and errors, and quiet/verbose/debug modes driven by CLI flags (`--quiet`, `--verbose`, `--debug`, `--log-level=N`).
+
+## Key exports
+
+| Export          | Purpose                                                       |
+| --------------- | ------------------------------------------------------------- |
+| `log` (default) | Singleton `Logger` instance; import and call methods directly |
+
+### Logger methods
+
+| Method                    | Purpose                                            |
+| ------------------------- | -------------------------------------------------- |
+| `log.info(msg)`           | Standard informational output                      |
+| `log.warn(msg)`           | Warning, collected for end-of-run summary          |
+| `log.error(msg)`          | Error output, collected for end-of-run summary     |
+| `log.debug(msg)`          | Debug output; enabled by `--debug` flag            |
+| `log.trace(msg)`          | Trace-level output                                 |
+| `log.notice(msg)`         | Notice-level output                                |
+| `log.inspect(val)`        | Pretty-prints objects                              |
+| `log.printSummary()`      | Prints collected warnings/errors at end of a build |
+| `log.configure(opts)`     | Applies settings (logLevel, boringOutput, etc.)    |
+| `log.registerSequence(n)` | Sets total task count for progress display         |
+
+## Dev
+
+```bash
+npm test      # jest
+npm run build
 ```

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+import { EventEmitter } from "events";
+
+//#region src/Timer.d.ts
+interface TaskTime {
+  taskName: string;
+  beginHrtime: [number, number];
+  endHrtime: [number, number];
+  beginMs: string;
+  endMs: string;
+  totalMs: string;
+}
+declare class Timer extends EventEmitter {
+  static dateFormattingOptions: Intl.DateTimeFormatOptions;
+  static timeFormat(t: [number, number]): string;
+  static dateFormat(): string;
+  taskBegin: [number, number] | null;
+  taskEnd: [number, number] | null;
+  sequenceBegin: [number, number];
+  formattedStartDate: string;
+  taskTimes: TaskTime[];
+  constructor();
+  prepare(): void;
+  start(task: string): void;
+  stop(task: string): void;
+  done({
+    state
+  }: {
+    state: unknown;
+  }): void;
+}
+//#endregion
+//#region src/index.d.ts
+interface LoggerSettings {
+  quiet: boolean;
+  verbose: boolean;
+  debug: boolean;
+  summary: boolean;
+  'no-color': boolean;
+  'log-level': number;
+}
+interface LogEntry {
+  stack: string | undefined;
+  message: string;
+  formatted: string;
+}
+declare class Logger extends Timer {
+  static defaults: {
+    logLevel: number;
+    boringOutput: boolean;
+    summary: boolean;
+    command: string | null;
+    consoleWidth: number;
+    errors: LogEntry[];
+    warnings: LogEntry[];
+    taskWarnings: number;
+    taskErrors: number;
+    whitespace: string;
+    increment: number;
+    indentLevel: number;
+    taskCounter: number;
+    context: string | null;
+  };
+  logLevel: number;
+  boringOutput: boolean;
+  command: string | null;
+  consoleWidth: number;
+  errors: LogEntry[];
+  warnings: LogEntry[];
+  taskWarnings: number;
+  taskErrors: number;
+  whitespace: string;
+  increment: number;
+  indentLevel: number;
+  taskCounter: number;
+  context: string | null;
+  summary?: boolean;
+  task?: string;
+  settings: LoggerSettings;
+  printWarnings: (task?: string) => void;
+  printErrors: (task?: string) => void;
+  indent: () => string;
+  incrementIndent: () => void;
+  decrementIndent: () => void;
+  incrementCounter: () => void;
+  decrementCounter: () => void;
+  bind: () => void;
+  notify: (event: string, data: unknown) => void;
+  warn: (...args: unknown[]) => void;
+  info: (...args: unknown[]) => void;
+  error: (args: unknown) => void;
+  debug: () => void;
+  trace: () => void;
+  notice: (...args: unknown[]) => void;
+  inspect: (args: unknown) => void;
+  printSummary: (data: unknown) => void;
+  configure: () => void;
+  printVersion: (version: string) => void;
+  registerSequence: (state: unknown, command: string, sequence: string[]) => void;
+  wrap: (arr: string[], space: string) => string;
+  decorate: (args: unknown, ...props: string[]) => string;
+  floatFormat: (n: unknown) => string;
+  counter: () => string;
+  getContext: () => string;
+  composeMessage: (args: unknown[]) => string;
+  reset: () => void;
+  constructor();
+  newLine(): void;
+}
+declare const log: Logger;
+export = log;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/Timer.ts","../src/index.ts"],"mappings":";;;UAEU,QAAA;EACR,QAAA;EACA,WAAA;EACA,SAAA;EACA,OAAA;EACA,KAAA;EACA,OAAA;AAAA;AAAA,cAGI,KAAA,SAAc,YAAA;EAAA,OACX,qBAAA,EAAuB,IAAA,CAAK,qBAAA;EAAA,OAS5B,UAAA,CAAW,CAAA;EAAA,OAKX,UAAA;EAIP,SAAA;EACA,OAAA;EACA,aAAA;EACA,kBAAA;EACA,SAAA,EAAY,QAAA;;EAOZ,OAAA;EASA,KAAA,CAAM,IAAA;EAKN,IAAA,CAAK,IAAA;EAoBL,IAAA;IAAO;EAAA;IAAW,KAAA;EAAA;AAAA;;;UChDV,cAAA;EACR,KAAA;EACA,OAAA;EACA,KAAA;EACA,OAAA;EACA,UAAA;EACA,WAAA;AAAA;AAAA,UAGQ,QAAA;EACR,KAAA;EACA,OAAA;EACA,SAAA;AAAA;AAAA,cAGI,MAAA,SAAe,KAAA;EAAA,OACZ,QAAA;;;;;;YAMS,QAAA;cACE,QAAA;;;;;;;;;EAUlB,QAAA;EACA,YAAA;EACA,OAAA;EACA,YAAA;EACA,MAAA,EAAS,QAAA;EACT,QAAA,EAAW,QAAA;EACX,YAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA,WAAA;EACA,WAAA;EACA,OAAA;EACA,OAAA;EACA,IAAA;EACA,QAAA,EAAW,cAAA;EAEX,aAAA,GAAiB,IAAA;EACjB,WAAA,GAAe,IAAA;EACf,MAAA;EACA,eAAA;EACA,eAAA;EACA,gBAAA;EACA,gBAAA;EACA,IAAA;EACA,MAAA,GAAU,KAAA,UAAe,IAAA;EACzB,IAAA,MAAW,IAAA;EACX,IAAA,MAAW,IAAA;EACX,KAAA,GAAS,IAAA;EACT,KAAA;EACA,KAAA;EACA,MAAA,MAAa,IAAA;EACb,OAAA,GAAW,IAAA;EACX,YAAA,GAAgB,IAAA;EAChB,SAAA;EACA,YAAA,GAAgB,OAAA;EAChB,gBAAA,GACE,KAAA,WACA,OAAA,UACA,QAAA;EAEF,IAAA,GAAQ,GAAA,YAAe,KAAA;EACvB,QAAA,GAAY,IAAA,cAAkB,KAAA;EAC9B,WAAA,GAAe,CAAA;EACf,OAAA;EACA,UAAA;EACA,cAAA,GAAkB,IAAA;EAClB,KAAA;;EAsFA,OAAA;AAAA;AAAA,cAKI,GAAA,EAAG,MAAe;AAAA"}