Go to full API documentation

Install

With npm:

npm install taraskevizer

With yarn:

yarn add taraskevizer

With bun:

bun add taraskevizer

Usage

import {
	pipelines,
	TaraskConfig,
	htmlConfigOptions,
	ansiColorWrappers,
	alphabets,
	REPLACE_J,
	VARIATION,
} from 'taraskevizer';

pipelines.tarask('планета');
// "плянэта"

// Explicit config declaration is recommended if it's used multiple times
const cfg = new TaraskConfig({
	abc: alphabets.cyrillic,
	j: 'always',
	variations: 'first',
	wrappers: ansiColorWrappers,
	g: true,
});
pipelines.tarask('планета і Гродна', cfg);
// "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"

pipelines.tarask('энергія планеты', {
	...htmlConfigOptions,
	abc: alphabets.latin,
	g: false, // ignored, g matters for cyrillic alphabet only
});
// "en<tarF>erg</tarF>ija p<tarF>lan</tarF>ety"

const latinWithJiCfg = new TaraskConfig({
	abc: alphabets.latinJi,
});

pipelines.alphabetic('яна і іншыя', latinWithJiCfg);
// "jana j jinšyja"

HTML tags

tarF

Difference between the input and the 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, separated with commas.

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

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

tarH

May be toggled between г(h) and ґ(g). Appears only if alphabet is cyrillic.

<tarH>г</tarH>

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

Special Syntax

| | fix | no fix | change only alphabet | | ----------- | ------------ | ------------ | -------------------- | | brackets | <,Планета> | <Планета> | <*Планета> | | no brackets | Планета | <.Планета> | <*.Планета> |

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.