standard-log 9.1.6 → 10.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "standard-log",
-  "version": "9.1.6",
+  "version": "10.0.0",
   "description": "The standard log library",
   "homepage": "https://github.com/unional/standard-log/tree/master/packages/log",
   "bugs": {
@@ -58,25 +58,25 @@
     "@just-func/types": "^0.2.0",
     "iso-error": "^4.3.5",
     "ms": "^2.1.3",
-    "type-plus": "^4.10.2",
+    "type-plus": "^4.11.2",
     "upper-case": "^2.0.2"
   },
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^7.0.8",
+    "@size-limit/preset-small-lib": "^8.0.0",
     "@types/ms": "^0.7.31",
     "@types/ramda": "^0.28.13",
-    "assertron": "^9.2.5",
+    "assertron": "^10.0.0",
     "compression-webpack-plugin": "^10.0.0",
     "cross-env": "^7.0.3",
     "depcheck": "^1.4.3",
     "eslint": "^8.17.0",
-    "jest": "^28.1.1",
+    "jest": "^29.0.0",
     "npm-run-all": "^4.1.5",
     "param-case": "^3.0.4",
     "pascal-case": "^3.1.2",
     "ramda": "^0.28.0",
     "rimraf": "^3.0.2",
-    "size-limit": "^7.0.8",
+    "size-limit": "^8.0.0",
     "ts-jest": "^28.0.5",
     "ts-loader": "^9.3.0",
     "tslib": "^2.4.0",

package/ts/console.ts

@@ -1,5 +1,5 @@
-import { required } from 'type-plus'
-import { plainLogFormatter } from './formatter.js'
+import { unpartial } from 'type-plus'
+import { consoleFormatter } from './formatter.js'
 import { logLevels } from './logLevels.js'
 import { polyfill } from './platform.js'
 import type { ConsoleLike, LogEntry, LogFormatter, LogReporter, LogReporterOptions } from './types.js'
@@ -51,7 +51,7 @@ export type ConsoleLogReporter = LogReporter<any[]> & { console: ConsoleLike }
 export type ConsoleLogReporterOptions = LogReporterOptions<any[]>
 
 export function createConsoleLogReporter(options?: ConsoleLogReporterOptions): ConsoleLogReporter {
-  const { id, formatter, filter } = required({ id: 'console', formatter: plainLogFormatter }, options)
+  const { id, formatter, filter } = unpartial({ id: 'console', formatter: consoleFormatter }, options)
   if (!polyfill.console) polyfill.console = buildPolyfillConsole()
 
   return Object.freeze({

package/ts/formatter.ts

@@ -5,7 +5,7 @@ import type { LogEntry } from './types.js'
 
 export type TimestampFormat = 'none' | 'iso' | 'elapsed'
 
-export function createTimestampFormatter(format: TimestampFormat) {
+export function createTimestampFormatter(format: TimestampFormat): (timestamp: Date) => string | undefined {
   switch (format) {
     case 'none':
       return (_timestamp: Date) => undefined
@@ -27,6 +27,19 @@ export function formatLogLevel(level: number) {
   return `(${upperCase(toLogLevelName(level))})`
 }
 
+/**
+ * Formats log entry as plain text with the following format:
+ * `timestamp id level ...args`
+ *
+ * This is typically useful for writing logs to file
+ */
 export function plainLogFormatter({ id, level, args, timestamp }: LogEntry) {
   return [timestamp.toISOString(), id, formatLogLevel(level), ...args]
 }
+
+/**
+ * Formats log entry like default console log.
+ */
+export function consoleFormatter({ args }: LogEntry) {
+  return args
+}

package/ts/logger.ts

@@ -5,9 +5,9 @@ import { LogStore } from './logStore.js'
 import type { LogEntry, LogFunction, Logger, LoggerOptions, LogMethodNames, LogReporter } from './types.js'
 import { LogLevel } from './types.js'
 
-export function createLogger<T extends string = LogMethodNames>(
+export function createLogger<N extends string = LogMethodNames>(
   store: LogStore, id: string, options?: LoggerOptions
-): Logger {
+): Logger<N | LogMethodNames> {
   validateId(id, options)
   const writeTo = options?.writeTo ?? (() => true)
   const [filter, reporters]: [(reporterId: string) => boolean, LogReporter[]] = typeof writeTo === 'string'
@@ -44,7 +44,7 @@ export function createLogger<T extends string = LogMethodNames>(
     },
     on: {
       writable: false,
-      value: (level: number | T, logFn: LogFunction) => {
+      value: (level: number | N | LogMethodNames, logFn: LogFunction) => {
         const logLevel = typeof level === 'string' ? store.logLevelStore.getLevel(level)! : level
         if (shouldLog(store, logLevel, logger.level)) {
           const methodName = store.logLevelStore.getName(logLevel)

package/ts/standardLog.ts

@@ -9,7 +9,7 @@ export interface StandardLogInstance<N extends string = LogMethodNames> {
   logLevel: number,
   toLogLevelName(level: number): string,
   toLogLevel(name: N): number,
-  getLogger(id: string, options?: LoggerOptions): Logger<N>
+  getLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>
 }
 
 export interface StandardLog<N extends string = LogMethodNames> extends Readonly<StandardLogInstance<N>> {

package/ts/types.ts

@@ -11,7 +11,7 @@ export interface LoggerOptions extends StackTraceMeta {
   writeTo?: LogReporter | ReporterFilter
 }
 
-export type Logger<T extends string = LogMethodNames> = {
+export type Logger<N extends string = LogMethodNames> = {
   readonly id: string,
   /**
    * Logger local log level.
@@ -22,12 +22,12 @@ export type Logger<T extends string = LogMethodNames> = {
    * This is useful during debugging to check for steps executed.
    */
   count(...args: any[]): void,
-  on(level: number | T, logFunction: LogFunction): void,
+  on(level: number | N, logFunction: LogFunction): void,
   /**
    * Write custom log entries.
    */
   write(entry: LogEntry): void
-} & { [k in T]: LogMethod }
+} & { [k in N]: LogMethod }
 
 /**
  * Names of the standard log methods.