@mmutils/logger 0.0.0-stage → 0.1.1

package/dist/cjs/index.cjs

@@ -0,0 +1,72 @@
+'use strict';
+
+var logger = require('./logger.cjs');
+var time = require('./time.cjs');
+var levels = require('./levels.cjs');
+var outputs = require('./outputs.cjs');
+var message = require('./plugins/message.cjs');
+var json = require('./plugins/json.cjs');
+var graph = require('./plugins/graph.cjs');
+var columns = require('./plugins/columns.cjs');
+var shared = require('./plugins/shared.cjs');
+var text = require('./utils/text.cjs');
+
+
+
+exports.BaseLogger = logger.BaseLogger;
+exports.Logger = logger.Logger;
+exports.templateTransformer = logger.templateTransformer;
+exports.DEFAULT_TIMESTAMP_FORMAT = time.DEFAULT_TIMESTAMP_FORMAT;
+exports.compileTimestamp = time.compileTimestamp;
+exports.LOG_TYPES = levels.LOG_TYPES;
+exports.LOG_TYPE_MAX_LENGTH = levels.LOG_TYPE_MAX_LENGTH;
+exports.LOG_TYPE_VALUES = levels.LOG_TYPE_VALUES;
+exports.LogLevels = levels.LogLevels;
+exports.assertLogLevel = levels.assertLogLevel;
+exports.isLogLevel = levels.isLogLevel;
+exports.isLogType = levels.isLogType;
+exports.shouldLog = levels.shouldLog;
+exports.consoleOutput = outputs.consoleOutput;
+exports.joinedOutput = outputs.joinedOutput;
+exports.messagePlugin = message.messagePlugin;
+exports.renderMessageData = message.renderMessageData;
+exports.jsonPlugin = json.jsonPlugin;
+exports.renderJsonData = json.renderJsonData;
+exports.DEFAULT_GRAPH_LIMITS = graph.DEFAULT_GRAPH_LIMITS;
+exports.formatAxisLabel = graph.formatAxisLabel;
+exports.graphPlugin = graph.graphPlugin;
+exports.renderGraph = graph.renderGraph;
+exports.valuesToBars = graph.valuesToBars;
+exports.DEFAULT_COLUMNS_WRAP = columns.DEFAULT_COLUMNS_WRAP;
+exports.columnsPlugin = columns.columnsPlugin;
+exports.wrapText = columns.wrapText;
+exports.DEFAULT_SYMBOLS = shared.DEFAULT_SYMBOLS;
+exports.DEFAULT_TEXT_STYLES = shared.DEFAULT_TEXT_STYLES;
+exports.headerTemplates = shared.headerTemplates;
+exports.mergeStyleSheets = shared.mergeStyleSheets;
+exports.paint = shared.paint;
+exports.paintUnrenderable = shared.paintUnrenderable;
+exports.DEFAULT_OUTPUT_LIMITS = text.DEFAULT_OUTPUT_LIMITS;
+exports.NO_OUTPUT_LIMITS = text.NO_OUTPUT_LIMITS;
+exports.charWidth = text.charWidth;
+exports.createSanitizer = text.createSanitizer;
+exports.describeBinary = text.describeBinary;
+exports.describeFunction = text.describeFunction;
+exports.describeLeftOut = text.describeLeftOut;
+exports.describeObject = text.describeObject;
+exports.describeThrown = text.describeThrown;
+exports.isForeignError = text.isForeignError;
+exports.justifyLeftRight = text.justifyLeftRight;
+exports.limitKeys = text.limitKeys;
+exports.padTextMiddle = text.padTextMiddle;
+exports.resolveOutputLimits = text.resolveOutputLimits;
+exports.safeStringify = text.safeStringify;
+exports.scaleArray = text.scaleArray;
+exports.splitError = text.splitError;
+exports.stringifyData = text.stringifyData;
+exports.stringifyPrimitive = text.stringifyPrimitive;
+exports.stringifyProperty = text.stringifyProperty;
+exports.textWidth = text.textWidth;
+exports.truncate = text.truncate;
+exports.visibleLength = text.visibleLength;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/levels.cjs

@@ -0,0 +1,82 @@
+'use strict';
+
+/**
+ * Numeric expression of the log levels. The lower the value, the less the
+ * output.
+ */
+const LogLevels = {
+    silent: 100,
+    fatal: 200,
+    error: 300,
+    warning: 400,
+    info: 500,
+    debug: 600,
+    trace: 700,
+    verbose: 800,
+};
+/**
+ * All log types, ordered by level.
+ */
+const LOG_TYPES = [
+    'fatal',
+    'error',
+    'warning',
+    'info',
+    'debug',
+    'trace',
+    'verbose',
+];
+/**
+ * Length of the longest log type name.
+ */
+const LOG_TYPE_MAX_LENGTH = LOG_TYPES.reduce((max, type) => Math.max(max, type.length), 0);
+/**
+ * Checks if a message of a given type passes the current level.
+ */
+const shouldLog = (type, level) => LogLevels[type] <= LogLevels[level];
+/**
+ * Numeric values of the log types, without `'silent'`. A plain literal, so
+ * V8 keeps fast properties: the lookup runs on every log, filtered ones
+ * included. Inherited keys (`'toString'`) give non-numbers, so callers check
+ * `typeof value === 'number'`.
+ */
+const LOG_TYPE_VALUES = {
+    fatal: LogLevels.fatal,
+    error: LogLevels.error,
+    warning: LogLevels.warning,
+    info: LogLevels.info,
+    debug: LogLevels.debug,
+    trace: LogLevels.trace,
+    verbose: LogLevels.verbose,
+};
+/**
+ * Runtime check of a log level, e.g. one read from an environment variable.
+ */
+const isLogLevel = (value) => typeof value === 'string' && Object.hasOwn(LogLevels, value);
+/**
+ * Runtime check of a log type. `'silent'` is a level, not a type.
+ */
+const isLogType = (value) => typeof value === 'string' && Object.hasOwn(LOG_TYPE_VALUES, value);
+const describeName = (value) => typeof value === 'string' ? `"${value}"` : typeof value;
+/**
+ * @throws RangeError naming the valid levels.
+ */
+const assertLogLevel = (value) => {
+    if (!isLogLevel(value))
+        throw new RangeError(`Unknown log level ${describeName(value)}. Use one of: ${Object.keys(LogLevels).join(', ')}.`);
+};
+/**
+ * Error for a log call with an unknown type, naming the valid types.
+ */
+const unknownLogTypeError = (value) => new TypeError(`Unknown log type ${describeName(value)}. Use one of: ${LOG_TYPES.join(', ')}.`);
+
+exports.LOG_TYPES = LOG_TYPES;
+exports.LOG_TYPE_MAX_LENGTH = LOG_TYPE_MAX_LENGTH;
+exports.LOG_TYPE_VALUES = LOG_TYPE_VALUES;
+exports.LogLevels = LogLevels;
+exports.assertLogLevel = assertLogLevel;
+exports.isLogLevel = isLogLevel;
+exports.isLogType = isLogType;
+exports.shouldLog = shouldLog;
+exports.unknownLogTypeError = unknownLogTypeError;
+//# sourceMappingURL=levels.cjs.map

package/dist/cjs/levels.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"levels.cjs","sources":["../../src/levels.ts"],"sourcesContent":["import type { LogLevel, LogType } from './types.js';\n\n/**\n * Numeric expression of the log levels. The lower the value, the less the\n * output.\n */\nexport const LogLevels = {\n  silent: 100,\n  fatal: 200,\n  error: 300,\n  warning: 400,\n  info: 500,\n  debug: 600,\n  trace: 700,\n  verbose: 800,\n} as const satisfies Record<LogLevel, number>;\n\n/**\n * All log types, ordered by level.\n */\nexport const LOG_TYPES = [\n  'fatal',\n  'error',\n  'warning',\n  'info',\n  'debug',\n  'trace',\n  'verbose',\n] as const satisfies readonly LogType[];\n\n/**\n * Length of the longest log type name.\n */\nexport const LOG_TYPE_MAX_LENGTH = LOG_TYPES.reduce(\n  (max, type) => Math.max(max, type.length),\n  0\n);\n\n/**\n * Checks if a message of a given type passes the current level.\n */\nexport const shouldLog = (type: LogType, level: LogLevel): boolean =>\n  LogLevels[type] <= LogLevels[level];\n\n/**\n * Numeric values of the log types, without `'silent'`. A plain literal, so\n * V8 keeps fast properties: the lookup runs on every log, filtered ones\n * included. Inherited keys (`'toString'`) give non-numbers, so callers check\n * `typeof value === 'number'`.\n */\nexport const LOG_TYPE_VALUES: Readonly<Record<string, number | undefined>> = {\n  fatal: LogLevels.fatal,\n  error: LogLevels.error,\n  warning: LogLevels.warning,\n  info: LogLevels.info,\n  debug: LogLevels.debug,\n  trace: LogLevels.trace,\n  verbose: LogLevels.verbose,\n} satisfies Record<LogType, number>;\n\n/**\n * Runtime check of a log level, e.g. one read from an environment variable.\n */\nexport const isLogLevel = (value: unknown): value is LogLevel =>\n  typeof value === 'string' && Object.hasOwn(LogLevels, value);\n\n/**\n * Runtime check of a log type. `'silent'` is a level, not a type.\n */\nexport const isLogType = (value: unknown): value is LogType =>\n  typeof value === 'string' && Object.hasOwn(LOG_TYPE_VALUES, value);\n\nconst describeName = (value: unknown): string =>\n  typeof value === 'string' ? `\"${value}\"` : typeof value;\n\n/**\n * @throws RangeError naming the valid levels.\n */\nexport const assertLogLevel: (value: unknown) => asserts value is LogLevel = (\n  value\n) => {\n  if (!isLogLevel(value))\n    throw new RangeError(\n      `Unknown log level ${describeName(value)}. Use one of: ${Object.keys(LogLevels).join(', ')}.`\n    );\n};\n\n/**\n * Error for a log call with an unknown type, naming the valid types.\n */\nexport const unknownLogTypeError = (value: unknown): TypeError =>\n  new TypeError(\n    `Unknown log type ${describeName(value)}. Use one of: ${LOG_TYPES.join(', ')}.`\n  );\n"],"names":[],"mappings":";;AAEA;;;AAGG;AACI,MAAM,SAAS,GAAG;AACvB,IAAA,MAAM,EAAE,GAAG;AACX,IAAA,KAAK,EAAE,GAAG;AACV,IAAA,KAAK,EAAE,GAAG;AACV,IAAA,OAAO,EAAE,GAAG;AACZ,IAAA,IAAI,EAAE,GAAG;AACT,IAAA,KAAK,EAAE,GAAG;AACV,IAAA,KAAK,EAAE,GAAG;AACV,IAAA,OAAO,EAAE,GAAG;;AAGd;;AAEG;AACI,MAAM,SAAS,GAAG;IACvB,OAAO;IACP,OAAO;IACP,SAAS;IACT,MAAM;IACN,OAAO;IACP,OAAO;IACP,SAAS;;AAGX;;AAEG;AACI,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CACjD,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,EACzC,CAAC;AAGH;;AAEG;MACU,SAAS,GAAG,CAAC,IAAa,EAAE,KAAe,KACtD,SAAS,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,KAAK;AAEpC;;;;;AAKG;AACI,MAAM,eAAe,GAAiD;IAC3E,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,OAAO,EAAE,SAAS,CAAC,OAAO;IAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,OAAO,EAAE,SAAS,CAAC,OAAO;;AAG5B;;AAEG;MACU,UAAU,GAAG,CAAC,KAAc,KACvC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK;AAE7D;;AAEG;MACU,SAAS,GAAG,CAAC,KAAc,KACtC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,KAAK;AAEnE,MAAM,YAAY,GAAG,CAAC,KAAc,KAClC,OAAO,KAAK,KAAK,QAAQ,GAAG,IAAI,KAAK,CAAA,CAAA,CAAG,GAAG,OAAO,KAAK;AAEzD;;AAEG;AACI,MAAM,cAAc,GAAkD,CAC3E,KAAK,KACH;AACF,IAAA,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;QACpB,MAAM,IAAI,UAAU,CAClB,CAAA,kBAAA,EAAqB,YAAY,CAAC,KAAK,CAAC,CAAA,cAAA,EAAiB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAA,CAAG,CAC9F;AACL;AAEA;;AAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,KAAc,KAChD,IAAI,SAAS,CACX,CAAA,iBAAA,EAAoB,YAAY,CAAC,KAAK,CAAC,CAAA,cAAA,EAAiB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAA,CAAG;;;;;;;;;;"}