erte

erte

erte Colors Strings' Foreground And Background And Shows String Difference With Color.

yarn add -E erte

Table Of Contents

• Table Of Contents
• API
  • Color
• erte(source: string, target: string): string
• c(string: string, color: Color): string
• b(string: string, color: Color): string
• Copyright & License

API

The package is available by importing its default and named functions:

import erte, { c, b } from 'erte'

('black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'grey') Color: The color to apply.

erte(
  source: string,
  target: string,
): string

Compares the strings using the diff package, and outputs a coloured version where strings don't match with green or red differences. Returns a string which uses shell-codes to highlight differences.

• source* string: The string to compare.
• target* string: The string to comparison against.

import erte from 'erte'

const s = 'test this string'
const e = 'test this string with extra data'
const m = 'test this'

const green = erte(s, e)
console.log(green)

const red = erte(s, m)
console.log(red)

const grey = erte(s, s)
console.log(grey)

test this string with extra data
test this string
test this string

c(
  string: string,
  color: Color,
): string

Colors the foreground using an ANSI sequence.

• string* string: The string to color.
• color* Color: The color to use.

import { c } from 'erte'

const redText = c('RED ALERT', 'red')
console.log(redText)

b(
  string: string,
  color: Color,
): string

Colors the background with specified ANSI color.

• string* string: The string to color.
• color* Color: The color to use.

import { b } from 'erte'

const greenText = b('VEGAN', 'green')
console.log(greenText)

Copyright & License

The diff package is released under BSD License by Kevin Decker. Artwork by Erte.

GNU Affero General Public License v3.0

	© Art Deco™ 2020