erte

erte

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

yarn add erte
npm i erte
lud erte

Table Of Contents

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

API

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

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

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

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,
  opts=: !Options,
): void

Colors the foreground using an ANSI sequence.

• string* string: The string to color.
• color* Color: The color to use.
• opts !Options (optional): Additional options.

Any text in strings can be coloured using the c and b methods. They accept a colour, and additional ANSI transformations.

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

Options: Additional options.

Name	Type	Description
bold	boolean	The bold ANSI.
underline	boolean	The ͟u͟n͟d͟e͟r͟l͟i͟n͟e͟ ANSI.
reverse	boolean	The reverse ANSI (inverses background and foreground).
conceal	boolean	The conceal ANSI (doesn't show symbols).

import { c } from 'erte'

const redText = c('RED ALERT', 'red', {
  underline: true,
  bold: true,
  conceal: true,
  reverse: true,
})
console.log(redText)

b(
  string: string,
  color: Color,
  opts=: !Options,
): void

Colors the background with specified ANSI color.

• string* string: The string to color.
• color* Color: The color to use.
• opts !Options (optional): Additional options.

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