standard-log 7.1.0 → 9.0.0

package/src/customLogLevel.spec.ts

@@ -1,39 +0,0 @@
-import a from 'assertron';
-import { addCustomLogLevel, clearCustomLogLevel, getCustomLevels, getLogger, logLevels } from '.';
-import { config } from './config';
-import { createMemoryLogReporter } from './memory';
-import { store } from './store';
-
-afterEach(() => store.reset())
-
-describe('clearCustomLogLevel()', () => {
-  test('clear all custom levels', () => {
-    addCustomLogLevel('c1', logLevels.none + 1)
-    addCustomLogLevel('c2', logLevels.none + 2)
-    expect(getCustomLevels().length).toBe(2)
-
-    clearCustomLogLevel()
-
-    expect(getCustomLevels().length).toBe(0)
-  })
-})
-
-test('custom level will not write if log level is lower', () => {
-  const memReporter = createMemoryLogReporter()
-  config({
-    mode: 'test',
-    reporters: [memReporter]
-  })
-
-  addCustomLogLevel('c1', logLevels.debug + 1)
-  const log = getLogger<'c1'>('custom-level-not-write')
-  log.c1('will not write this')
-
-  expect(memReporter.logs.length).toEqual(0)
-})
-
-test('custom level method is readonly', () => {
-  addCustomLogLevel('c1', logLevels.debug + 1)
-  const log = getLogger<'c1'>('custom method readonly')
-  a.throws(() => { log.c1 = () => {} })
-})

package/src/customLogLevel.ts

@@ -1,35 +0,0 @@
-import { forEachKey, mapKey } from 'type-plus';
-import { store } from './store';
-import { LogLevelEntry } from './types';
-
-/**
- * @param level the `logLevel` number.
- * You can specify this in the form of `logLevel.<x> + n` to make it more readable.
- */
-export function addCustomLogLevel(name: string, level: number) {
-  const { customLevels, customLevelsReverse } = store.value
-  customLevels[name] = level
-  customLevelsReverse[level] = name
-  const { loggerClosures } = store.value
-  forEachKey(loggerClosures, id => loggerClosures[id].addMethod(name, level))
-}
-
-export function clearCustomLogLevel() {
-  const { customLevels, customLevelsReverse } = store.value
-  // Don't replace the object would prevent reference divergence
-  forEachKey(customLevels, k => delete customLevels[k])
-  customLevelsReverse.splice(0, customLevelsReverse.length)
-}
-
-export function getCustomLevel(name: string): number | undefined {
-  return store.value.customLevels[name]
-}
-
-export function getCustomLevelName(level: number): string | undefined {
-  return store.value.customLevelsReverse[level]
-}
-
-export function getCustomLevels(): LogLevelEntry[] {
-  const { customLevels } = store.value
-  return mapKey(customLevels, name => ({ name, level: customLevels[name] }))
-}

package/src/errors.ts

@@ -1,24 +0,0 @@
-import { IsoError, ModuleError } from 'iso-error'
-
-export class StandardLogError extends ModuleError {
-  constructor(description: string, options?: IsoError.Options) {
-    super('standard-log', description, options)
-  }
-}
-export class InvalidId extends StandardLogError {
-  constructor(public id: string) {
-    super(`logger id only supports alphanumeric, unicode characters, and [:_-.]. Received ${id}`)
-  }
-}
-
-export class ProhibitedDuringProduction extends StandardLogError {
-  constructor(public action: string) {
-    super(`Cannot perform ${action} during production`)
-  }
-}
-
-export class InvalidEnvVar extends StandardLogError {
-  constructor(public name: string, public value: string, public possibleValues: string[]) {
-    super(`${name} contains invalid value '${value}'${` valid values: [${possibleValues.join()}]`}`)
-  }
-}

package/src/formatter/createTimestampFormatter.spec.ts

@@ -1,24 +0,0 @@
-import { createTimestampFormatter } from '..'
-
-test('none', () => {
-  const formatter = createTimestampFormatter('none')
-  const now = new Date()
-  const actual = [formatter(now)]
-  expect(actual).toEqual([undefined])
-})
-
-test('iso', () => {
-  const formatter = createTimestampFormatter('iso')
-  const now = new Date()
-  const actual = [formatter(now)]
-  expect(actual).toEqual([now.toISOString()])
-})
-
-test('elapsed', () => {
-  const formatter = createTimestampFormatter('elapsed')
-  const now = new Date()
-  const next = new Date(now.getTime() + 10)
-  const actual = [formatter(now), formatter(next)]
-
-  expect(actual).toEqual(['0ms', '10ms'])
-})

package/src/formatter/formatLogLevel.ts

@@ -1,6 +0,0 @@
-import { upperCase } from 'upper-case';
-import { toLogLevelName } from '../logLevelFn';
-
-export function formatLogLevel(level: number) {
-  return `(${upperCase(toLogLevelName(level))})`
-}

package/src/formatter/index.ts

@@ -1,3 +0,0 @@
-export * from './createTimestampFormatter';
-export * from './formatLogLevel';
-export * from './plainLogFormatter';

package/src/formatter/plainLogFormatter.spec.ts

@@ -1,8 +0,0 @@
-import { logLevels, plainLogFormatter } from '..';
-
-test('convert log entries to string', () => {
-  const timestamp = new Date(2019, 6)
-  const actual = plainLogFormatter({ id: 'plain', level: logLevels.emergency, args: ['emergency'], timestamp })
-
-  expect(actual).toEqual([timestamp.toISOString(), 'plain', `(EMERGENCY)`, `emergency`])
-})

package/src/formatter/plainLogFormatter.ts

@@ -1,6 +0,0 @@
-import { LogEntry } from '../types'
-import { formatLogLevel } from './formatLogLevel'
-
-export function plainLogFormatter({ id, level, args, timestamp }: LogEntry) {
-  return [timestamp.toISOString(), id, formatLogLevel(level), ...args]
-}

package/src/getDefaultReporter.browser.ts

@@ -1,13 +0,0 @@
-/* istanbul ignore file */
-import { createConsoleLogReporter } from './console';
-
-declare const StandardLogColor: any
-
-export function getDefaultReporter() {
-  try {
-    return StandardLogColor.createColorLogReporter()
-  }
-  catch (e) {
-    return createConsoleLogReporter()
-  }
-}

package/src/getDefaultReporter.ts

@@ -1,15 +0,0 @@
-import { createConsoleLogReporter } from './console';
-
-export function getDefaultReporter() {
-  try {
-    // tricks webpack to not bundle standard-log-color
-    const c = '-color'
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const colorModule = require('standard-log' + c)
-    return colorModule.createColorLogReporter()
-  }
-  catch (e) {
-    // istanbul ignore next
-    return createConsoleLogReporter()
-  }
-}

package/src/getLogModeFromEnvironment.browser.ts

@@ -1,6 +0,0 @@
-import { LogMode } from './types';
-
-// istanbul ignore next
-export function getLogModeFromEnvironment(): LogMode | undefined {
-  return undefined
-}

package/src/getLogModeFromEnvironment.spec.ts

@@ -1,16 +0,0 @@
-import a from 'assertron';
-import { InvalidEnvVar } from '.';
-import { getLogModeFromEnvironment } from './getLogModeFromEnvironment';
-
-test('invalid value throws', () => {
-  process.env.STANDARD_LOG = 'unknown'
-  a.throws(() => getLogModeFromEnvironment(), InvalidEnvVar)
-})
-
-test('valid values', () => {
-  process.env.STANDARD_LOG = 'production'
-  expect(getLogModeFromEnvironment()).toBe('production')
-
-  process.env.STANDARD_LOG = 'development'
-  expect(getLogModeFromEnvironment()).toBe('development')
-})

package/src/getLogModeFromEnvironment.ts

@@ -1,16 +0,0 @@
-import { InvalidEnvVar } from './errors';
-import { LogMode } from './types';
-
-const logModeValues = ['production', 'development', 'test']
-
-export function getLogModeFromEnvironment(): LogMode | undefined {
-  const mode = process.env.STANDARD_LOG
-  if (mode === undefined || isLogMode(mode)) {
-    return mode
-  }
-  throw new InvalidEnvVar('STANDARD_LOG', mode, logModeValues)
-}
-
-function isLogMode(mode: string): mode is LogMode {
-  return logModeValues.indexOf(mode) !== -1
-}