taraskevizer 6.1.19 → 7.0.0

package/README.md

@@ -21,13 +21,21 @@ bun add taraskevizer
 # Usage
 
 ```js
-import { Taraskevizer, ALPHABET, J, VARIATION } from 'taraskevizer';
-
-const taraskevizer = new Taraskevizer();
-taraskevizer.convert('планета');
+import {
+	tarask,
+	plainTextPipeline,
+	htmlPipeline,
+	abcOnlyPipeline,
+	TaraskConfig,
+	ALPHABET,
+	J,
+	VARIATION,
+} from 'taraskevizer';
+
+tarask('планета', plainTextPipeline);
 // "плянэта"
 
-const taraskevizer = new Taraskevizer({
+const cfg = new TaraskConfig({
 	general: {
 		abc: ALPHABET.CYRILLIC,
 		j: J.ALWAYS,
@@ -38,10 +46,10 @@ const taraskevizer = new Taraskevizer({
 		h: false,
 	},
 });
-taraskevizer.convert('планета і Гродна');
+tarask('планета і Гродна', plainTextPipeline, cfg);
 // "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"
 
-const taraskevizer = new Taraskevizer({
+const cfg = new TaraskConfig({
 	general: {
 		abc: ALPHABET.LATIN,
 	},
@@ -49,21 +57,20 @@ const taraskevizer = new Taraskevizer({
 		g: false, // ignored, because alphabet is set to latin
 	},
 });
-taraskevizer.convertToHtml('энергія планеты');
+tarask('энергія планеты', htmlPipeline, cfg);
 // "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({
+const latinWithJiCfg = new TaraskConfig({
 	general: { abc: ALPHABET.LATIN_JI },
 });
 
-latinizerWithJi.convertAlphabetOnly('яна і іншыя');
+tarask('яна і іншыя', abcOnlyPipeline, latinWithJiCfg);
 // "jana j jinšyja"
 ```
 
+Explanation of pipeline steps and
+how to create your own will come soon.
+
 # Options
 
 ## general
@@ -72,16 +79,11 @@ Type: `object`
 
 ### abc
 
-Type: `number`
-
-Default value: `0`
+Type: `object` with schema: `{lower: Dict, upper?: Dict}`,
+where `Dict` is `[pattern: RegExp, result: string][]`
+(may be empty)
 
-| Value | Alphabet of output text |
-| ----- | ----------------------- |
-| 0     | cyrillic                |
-| 1     | latin                   |
-| 2     | arabic                  |
-| 3     | latin with ji           |
+Default value: `ALPHABET.CYRILLIC`
 
 ### j
 
@@ -108,15 +110,6 @@ If set to false, may cause unwanted changes in acronyms.
 
 Is always `false` 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

package/dist/bin.js

@@ -1,5 +1,14 @@
 #!/usr/bin/env node
-import { ALPHABET, REPLACE_J, Taraskevizer, VARIATION } from "./index.js";
+import {
+  ALPHABET,
+  REPLACE_J,
+  VARIATION,
+  TaraskConfig,
+  tarask,
+  abcOnlyPipeline,
+  htmlPipeline,
+  plainTextPipeline
+} from "./index.js";
 const prefix = "\x1B[34m[taraskevizer]\x1B[0m ";
 const printWithPrefix = (msg) => {
   process.stdout.write(prefix + msg + "\n");
@@ -7,7 +16,7 @@ const printWithPrefix = (msg) => {
 process.argv.splice(0, 2);
 const checkForOptions = (options) => process.argv[0] && options.includes(process.argv[0].toLowerCase());
 if (checkForOptions(["-v", "--version"])) {
-  printWithPrefix("6.1.19");
+  printWithPrefix("7.0.0");
   process.exit(0);
 }
 if (checkForOptions(["-h", "--help"])) {
@@ -181,14 +190,13 @@ if (process.argv.length) {
   }
   text = Buffer.concat(chunks, length).toString();
 }
-const taraskevizer = new Taraskevizer({ general, html, nonHtml });
-if (process.stdout.write(
-  {
-    nonHtml: taraskevizer.convert,
-    html: taraskevizer.convertToHtml,
-    alphabetOnly: taraskevizer.convertAlphabetOnly
-  }[mode].apply(taraskevizer, [text]) + "\n"
-)) {
+const cfg = new TaraskConfig({ general, html, nonHtml });
+const piplineByMode = {
+  nonHtml: plainTextPipeline,
+  html: htmlPipeline,
+  alphabetOnly: abcOnlyPipeline
+};
+if (process.stdout.write(tarask(text, piplineByMode[mode], cfg) + "\n")) {
   process.exit(0);
 } else {
   process.stdout.once("drain", () => {