taraskevizer v6.1.0

Install

With npm:

npm install taraskevizer

With yarn:

yarn add taraskevizer

With bun:

bun add taraskevizer

Usage

import { Taraskevizer, ALPHABET, J, VARIATION } from 'taraskevizer';

const taraskevizer = new Taraskevizer();
taraskevizer.convert('планета');
// "плянэта"

const taraskevizer = new Taraskevizer({
	general: {
		abc: ALPHABET.CYRILLIC,
		j: J.ALWAYS,
	},
	nonHtml: {
		ansiColors: true,
		variations: VARIATION.FIRST,
		h: false,
	},
});
taraskevizer.convert('планета і Гродна');
// "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"

const taraskevizer = new Taraskevizer({
	general: {
		abc: ALPHABET.LATIN,
	},
	html: {
		g: false, // ignored, because alphabet is set to latin
	},
});
taraskevizer.convertToHtml('энергія планеты');
// "en<tarF>erg</tarF>ija p<tarF>lan</tarF>ety"

// properties can be rewritten after creating an object
taraskevizer.general.abc = ALPHABET.ARABIC;
taraskevizer.html.g = true;

const latinizerWithJi = new Taraskevizer({
	general: { abc: ALPHABET.LATIN_JI },
});

latinizerWithJi.convertAlphabetOnly('яна і іншыя');
// "jana j jinšyja"

Options

general

Type: object

abc

Type: number

Default value: 0

j

Type: number

Default value: 0

Has no effect with LATIN_JI alphabet.

doEscapeCapitalized

Type: boolean

Default true

If set to false, may cause unwanted changes in acronyms.

Is always true in convertAlphabetOnly.

taraskevize

Type: (text: string) => string

Default value: internal function taraskevize

Overriddes internal function in order to change behaviour of taraskevization. This function usually uses private api via __tarask__

html

g

Type: boolean

Default value: false

Do replace г(h) by ґ(g) in cyrillic alphabet?

nonHtml

ansiColors

Type: boolean

Default value: false

h

Type: boolean

Default value: false

Do replace ґ(g) by г(h) in cyrillic alphabet?

variations

Type: number

Default value: 0

HTML tags

tarF

Difference between an input and an output word.

<tarF>this_part_of_word_is_fixed</tarF>

пл<tarF>я</tarF>н

tarL

A part of a word wrapped in this tag is variable, variations are mentioned in a data-l attribute and are separated by commas

<tarL data-l="variation2,variation3">variation1</tarL>

<tarL data-l="Горадня">Гродна</tarL>

tarH

Can be replaced by ґ(g) letter. appears only if alphabet is cyrillic

<tarH>г</tarH>

<tarH>Г</tarH>валт

Special Syntax

CLI

Install

With npm:

npm install -g taraskevizer

With yarn:

yarn global add taraskevizer

With bun:

bun add -g taraskevizer

Usage

tarask [options] text

For usage examples and options use --help option (in source, content of --help is in this file)

"Without installation"

With npm:

npx taraskevizer [options] text

With bun:

bunx taraskevizer [options] text

Known bugs

Replacing не with ня

Ня should appear before a word where the first syllabe is stressed. At the moment, there is no way to check exactly if it is stressed. Algorithm makes some heuristics, but that's not enough to cover all cases.