get_color_fns.ts

import { Writable } from 'node:stream'
import chalk from 'chalk'
import { ColorInfo, supportsColor } from 'supports-color'
import { TestStepResultStatus } from '@cucumber/messages'
import { doesNotHaveValue } from '../value_checker'

export type IColorFn = (text: string) => string

export interface IColorFns {
  forStatus: (status: TestStepResultStatus) => IColorFn
  location: IColorFn
  tag: IColorFn
  diffAdded: IColorFn
  diffRemoved: IColorFn
  errorMessage: IColorFn
  errorStack: IColorFn
}

export default function getColorFns(
  stream: Writable,
  env: NodeJS.ProcessEnv,
  enabled?: boolean
): IColorFns {
  const support: ColorInfo = detectSupport(stream, env, enabled)
  if (support) {
    const chalkInstance = new chalk.Instance(support)
    return {
      forStatus(status: TestStepResultStatus) {
        return {
          AMBIGUOUS: chalkInstance.red.bind(chalk),
          FAILED: chalkInstance.red.bind(chalk),
          PASSED: chalkInstance.green.bind(chalk),
          PENDING: chalkInstance.yellow.bind(chalk),
          SKIPPED: chalkInstance.cyan.bind(chalk),
          UNDEFINED: chalkInstance.yellow.bind(chalk),
          UNKNOWN: chalkInstance.yellow.bind(chalk),
        }[status]
      },
      location: chalkInstance.gray.bind(chalk),
      tag: chalkInstance.cyan.bind(chalk),
      diffAdded: chalkInstance.green.bind(chalk),
      diffRemoved: chalkInstance.red.bind(chalk),
      errorMessage: chalkInstance.red.bind(chalk),
      errorStack: chalkInstance.grey.bind(chalk),
    }
  } else {
    return {
      forStatus(_status: TestStepResultStatus) {
        return (x) => x
      },
      location: (x) => x,
      tag: (x) => x,
      diffAdded: (x) => x,
      diffRemoved: (x) => x,
      errorMessage: (x) => x,
      errorStack: (x) => x,
    }
  }
}

function detectSupport(
  stream: Writable,
  env: NodeJS.ProcessEnv,
  enabled?: boolean
): ColorInfo {
  const support: ColorInfo = supportsColor(stream)
  // if we find FORCE_COLOR, we can let the supports-color library handle that
  if ('FORCE_COLOR' in env || doesNotHaveValue(enabled)) {
    return support
  }
  return enabled ? support || { level: 1 } : false
}