taraskevizer
    Preparing search index...

    taraskevizer

    If you're looking for JSON dictionaries, check out the github releases.

    Go to full API documentation

    Using <script> tag

    Warning

    In production, replace latest with a specific version number to avoid breaking changes due to major updates. Using latest could potentially break your website if a new version introduces breaking changes.

    <head>
      <script src="https://cdn.jsdelivr.net/npm/taraskevizer@latest/dist/bundle.js"></script>
      <script>
        document.write(taraskevizer.pipelines.tarask("планета"));
      </script>
    </head>

    Install

    With npm:

    npm install taraskevizer

    With yarn:

    yarn add taraskevizer

    With bun:

    bun add taraskevizer

    Usage

    import {
      pipelines,
      TaraskConfig,
      htmlConfigOptions,
      wrappers,
      alphabets,
    } from "taraskevizer";

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

    const cfg = new TaraskConfig({
      abc: alphabets.cyrillic,
      j: "always",
      variations: "first",
      wrappers: wrappers.ansiColor,
      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"

    Builtin Pipelines

    Pipeline Taraskevization Phonetization Alphabet Special syntax
    tarask ✅ ❌ ✅ ✅
    alphabetic ❌ ❌ ✅ ✅
    phonetic ❌ ✅ (experimental) ✅ ✅

    HTML tags

    Difference between the input and the output word.

    <tarF>this_part_of_word_is_fixed</tarF>

    пл<tarF>я</tarF>н

    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>

    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

    With npm:

    npm install -g taraskevizer

    With yarn:

    yarn global add taraskevizer

    With bun:

    bun add -g taraskevizer

    tarask [options] text

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

    With npm:

    npx taraskevizer [options] text

    With bun:

    bunx taraskevizer [options] text

    Known bugs

    Ня 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.

    Dependency graph of the project files

    Dependency graph

    Settings

    Member Visibility

    On This Page

    Using <script> tagInstallUsageBuiltin PipelinesHTML tagsSpecial SyntaxCLIKnown bugsDependency graph of the project files