@artdeco/erte
String difference with colour for Node.js and ANSI formatting. [FREE]
Last updated 5 months ago by zvr .
AGPL-3.0 · Bugs · Original npm · Tarball · package.json
$ cnpm install @artdeco/erte 
SYNC missed versions from official npm registry.

erte

npm version Pipeline Badge

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

Free Paid
yarn add erte
npm i erte
lud erte
yarn add @artdeco/erte
npm i @artdeco/erte
lud @artdeco/erte

section break

Table Of Contents

erte

section break

API

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

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

section break

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.

  • <kbd>source*</kbd> string: The string to compare.
  • <kbd>target*</kbd> 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

extra

missing

same

section break

c(
  string: string,
  color: Color,
  opts=: !Options,
): string

Colors the foreground using an ANSI sequence.

  • <kbd>string*</kbd> string: The string to color.
  • <kbd>color*</kbd> Color: The color to use.
  • <kbd>opts</kbd> !Options (optional): Additional options. Only available in the paid version.

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. Only available in the paid version.

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)

c

section break

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

Colors the background with specified ANSI color.

  • <kbd>string*</kbd> string: The string to color backgroud of.
  • <kbd>color*</kbd> Color: The color to use.
  • <kbd>opts</kbd> !Options (optional): Additional options. Only available in the paid version.
import { b } from 'erte'

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

b

section break

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 © Art Deco™ 2020 AGPL-3.0

section break

Current Tags

  • 1.4.2                                ...           latest (5 months ago)

2 Versions

  • 1.4.2                                ...           5 months ago
  • 1.3.1                                ...           6 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 2
Last Month 15
Dependencies (0)
None
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2016 © taobao.org |