taraskevizer 5.1.0 → 5.1.2

package/README.md

@@ -1,16 +1,31 @@
-## Install
+# Install
+
+With npm:
 
 ```bash
-$ npm i taraskevizer
+npm install taraskevizer
 ```
 
-## Usage
+With yarn:
+
+```bash
+yarn add taraskevizer
+```
+
+With bun:
+
+```bash
+bun add taraskevizer
+```
+
+# Usage
 
 ```js
 import { Taraskevizer, ALPHABET, J, VARIATION } from 'taraskevizer';
 
 const taraskevizer = new Taraskevizer();
-taraskevizer.convert('планета'); // "плянэта"
+taraskevizer.convert('планета');
+// "плянэта"
 
 const taraskevizer = new Taraskevizer({
 	general: {
@@ -23,7 +38,8 @@ const taraskevizer = new Taraskevizer({
 		h: false,
 	},
 });
-taraskevizer.convert('планета і Гродна'); // "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"
+taraskevizer.convert('планета і Гродна');
+// "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"
 
 const taraskevizer = new Taraskevizer({
 	general: {
@@ -33,14 +49,15 @@ const taraskevizer = new Taraskevizer({
 		g: false, // ignored, because alphabet is set to latin
 	},
 });
-taraskevizer.convertToHtml('энергія планеты'); // "en<tarF>erg</tarF>ija p<tarF>lan</tarF>ety"
+taraskevizer.convertToHtml('энергія планеты');
+// "en<tarF>erg</tarF>ija p<tarF>lan</tarF>ety"
 
 // properties can be rewritten after creating an object
 taraskevizer.abc = ALPHABET.ARABIC;
 taraskevizer.html.g = true;
 ```
 
-### Function signatures are in [this file](./dist/index.d.ts) (not available if project is not built)
+# Options
 
 ## general
 
@@ -86,7 +103,7 @@ Type: `(text: string) => string`
 Default value: internal function `taraskevize`
 
 Can be overridden in order to make additional changes to the text.
-This function usually uses private api via `Taraskevizer._.`
+This function usually uses private api via `__tarask__`
 
 ## html
 
@@ -137,9 +154,9 @@ Default value: `0`
 | 1     | first                                                 | Горадня           |
 | 2     | all                                                   | (Гродна\|Горадня) |
 
-## HTML tags
+# HTML tags
 
-### tarF
+## tarF
 
 Difference between an input and an output word.
 
@@ -149,7 +166,7 @@ Difference between an input and an output word.
 пл<tarF>я</tarF>н
 ```
 
-### tarL
+## tarL
 
 A part of a word wrapped in this tag is variable,
 variations are mentioned in a `data-l` attribute
@@ -161,7 +178,7 @@ and are separated by commas
 <tarL data-l="Горадня">Гродна</tarL>
 ```
 
-### tarH
+## tarH
 
 Can be replaced by `ґ`(`g`) letter. appears only if alphabet is cyrillic
 
@@ -171,7 +188,7 @@ Can be replaced by `ґ`(`g`) letter. appears only if alphabet is cyrillic
 <tarH>Г</tarH>валт
 ```
 
-## Special Syntax
+# Special Syntax
 
 |             | fix          | no fix       | change only alphabet |
 | ----------- | ------------ | ------------ | -------------------- |
@@ -182,14 +199,28 @@ Can be replaced by `ґ`(`g`) letter. appears only if alphabet is cyrillic
 
 ## Install
 
+With npm:
+
+```bash
+npm install -g taraskevizer
+```
+
+With yarn:
+
+```bash
+yarn global add taraskevizer
+```
+
+With bun:
+
 ```bash
-$ npm i -g taraskevizer
+bun add -g taraskevizer
 ```
 
 ## Usage
 
 ```bash
-$ tarask "планета"
+tarask "планета"
 ```
 
 ## Options

package/dist/index.cjs

@@ -2203,7 +2203,7 @@ var Taraskevizer = class {
           [replaceWithDict($3.toLowerCase(), letters[abc])],
           [$3]
         );
-      noFixArr.push($2 === "." ? $3 : `<${$3}>`);
+      noFixArr.push($2 === "." ? $3 : LEFT_ANGLE_BRACKET + $3 + ">");
       return NOFIX_CHAR;
     }).replace(/г'(?![еёіюя])/g, "ґ").replace(/([\n\t])/g, " $1 ").replace(/ - /g, " — ").replace(new RegExp("(\\p{P}|\\p{S}|\\d)", "gu"), " $1 ").replace(/ ['`’] (?=\S)/g, "ʼ").replace(/\(/g, "&#40");
     let splittedOrig, splitted;

package/dist/index.js

@@ -2172,7 +2172,7 @@ var Taraskevizer = class {
           [replaceWithDict($3.toLowerCase(), letters[abc])],
           [$3]
         );
-      noFixArr.push($2 === "." ? $3 : `<${$3}>`);
+      noFixArr.push($2 === "." ? $3 : LEFT_ANGLE_BRACKET + $3 + ">");
       return NOFIX_CHAR;
     }).replace(/г'(?![еёіюя])/g, "ґ").replace(/([\n\t])/g, " $1 ").replace(/ - /g, " — ").replace(new RegExp("(\\p{P}|\\p{S}|\\d)", "gu"), " $1 ").replace(/ ['`’] (?=\S)/g, "ʼ").replace(/\(/g, "&#40");
     let splittedOrig, splitted;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "taraskevizer",
-	"version": "5.1.0",
+	"version": "5.1.2",
 	"author": "GooseOb",
 	"repository": {
 		"type": "git",