taraskevizer 7.1.2 → 8.0.0

package/README.md

@@ -68,99 +68,7 @@ tarask('яна і іншыя', abcOnlyPipeline, latinWithJiCfg);
 // "jana j jinšyja"
 ```
 
-Explanation of pipeline steps and
-how to create your own will come soon.
-
-# Options
-
-## general
-
-Type: `object`
-
-### abc
-
-Type: `object` with schema: `{lower: Dict, upper?: Dict}`,
-where `Dict` is `[pattern: RegExp, result: string][]`
-(may be empty)
-
-`alphabets` contains the following pre-defined alphabets:
-`cyrillic`, `latin`, `latinJi`, `arabic`
-
-Default value: `alphabets.cyrillic`
-
-### j
-
-Type: `number`
-
-Default value: `0`
-
-| Value | When to replace `і`(`i`) by `й`(`j`) after vowels | Example                  |
-| ----- | ------------------------------------------------- | ------------------------ |
-|       |                                                   | `яна і ён`               |
-| 0     | never                                             | `яна і ён`               |
-| 1     | random                                            | `яна і ён` or `яна й ён` |
-| 2     | always                                            | `яна й ён`               |
-
-Has no effect with `LATIN_JI` alphabet.
-
-### doEscapeCapitalized
-
-Type: `boolean`
-
-Default `true`
-
-If set to false, may cause unwanted changes in acronyms.
-
-Is always `false` in `abcOnlyPipeline`.
-
-## html
-
-### g
-
-Type: `boolean`
-
-Default value: `false`
-
-Do replace `г`(`h`) by `ґ`(`g`) in cyrillic alphabet?
-
-| Value | Example                                 |
-| ----- | --------------------------------------- |
-| true  | `<tarH>г</tarH>валт <tarH>Г</tarH>валт` |
-| false | `<tarH>ґ</tarH>валт <tarH>Ґ</tarH>валт` |
-
-## nonHtml
-
-### ansiColors
-
-Type: `boolean`
-
-Default value: `false`
-
-### h
-
-Type: `boolean`
-
-Default value: `false`
-
-Do replace ґ(g) by г(h) in cyrillic alphabet?
-
-| Value | Example     |
-| ----- | ----------- |
-| true  | Ґвалт ґвалт |
-| false | Гвалт гвалт |
-
-### variations
-
-Type: `number`
-
-Default value: `0`
-
-| Value | Which variation is used if a part of word is variable | Example           |
-| ----- | ----------------------------------------------------- | ----------------- |
-|       |                                                       | Гродна            |
-| 0     | main                                                  | Гродна            |
-| 1     | first                                                 | Горадня           |
-| 2     | all                                                   | (Гродна\|Горадня) |
+# [Full API documentation](https://gooseob.github.io/taraskevizer/)
 
 # HTML tags
 

package/dist/bin.js

@@ -5,9 +5,7 @@ import {
   VARIATION,
   TaraskConfig,
   tarask,
-  abcOnlyPipeline,
-  htmlPipeline,
-  plainTextPipeline
+  pipelines
 } from "./index.js";
 const prefix = "\x1B[34m[taraskevizer]\x1B[0m ";
 const printWithPrefix = (msg) => {
@@ -16,7 +14,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("7.1.2");
+  printWithPrefix("8.0.0");
   process.exit(0);
 }
 if (checkForOptions(["-h", "--help"])) {
@@ -74,7 +72,7 @@ const nonHtml = {
   ansiColors: true
 };
 const html = { g: true };
-let mode = "nonHtml";
+let mode = "plainText";
 const toHashTable = (dict) => {
   const result = {};
   for (const [options, callback] of dict)
@@ -155,7 +153,7 @@ const optionDict = toHashTable([
   [
     ["--alphabet-only", "-abc"],
     () => {
-      mode = "alphabetOnly";
+      mode = "abcOnly";
     }
   ]
 ]);
@@ -191,12 +189,7 @@ if (process.argv.length) {
   text = Buffer.concat(chunks, length).toString();
 }
 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")) {
+if (process.stdout.write(tarask(text, pipelines[mode], cfg) + "\n")) {
   process.exit(0);
 } else {
   process.stdout.once("drain", () => {

package/dist/index.cjs

@@ -23,11 +23,9 @@ __export(src_exports, {
   REPLACE_J: () => REPLACE_J,
   TaraskConfig: () => TaraskConfig,
   VARIATION: () => VARIATION,
-  abcOnlyPipeline: () => abcOnlyPipeline,
   dicts: () => dict_exports,
-  htmlPipeline: () => htmlPipeline,
   lib: () => lib_exports,
-  plainTextPipeline: () => plainTextPipeline,
+  pipelines: () => pipelines_exports,
   steps: () => steps_exports,
   tarask: () => tarask
 });
@@ -61,6 +59,9 @@ var dictFrom = {
       );
     return dict;
   },
+  /**
+   * Adds the global flag to all patterns in the dictionary.
+   */
   nonGlobal: (dict) => {
     for (const item of dict)
       item[0] = RegExp(item[0], "g" + item[0].flags);
@@ -2047,6 +2048,18 @@ var arabic = {
   )
 };
 
+// src/constants.ts
+var REPLACE_J = {
+  NEVER: 0,
+  RANDOM: 1,
+  ALWAYS: 2
+};
+var VARIATION = {
+  NO: 0,
+  FIRST: 1,
+  ALL: 2
+};
+
 // src/config.ts
 var TaraskConfig = class {
   constructor(options) {
@@ -2064,59 +2077,58 @@ var TaraskConfig = class {
         }
     }
   }
+  /** @see {@link TaraskOptions} */
   general = {
     abc: alphabets_exports.cyrillic,
     j: REPLACE_J.NEVER,
     doEscapeCapitalized: true
   };
+  /** @see {@link HtmlOptions} */
   html = {
     g: false
   };
+  /** @see {@link NonHtmlOptions} */
   nonHtml = {
     h: false,
     ansiColors: false,
     variations: VARIATION.ALL
   };
 };
-var REPLACE_J = {
-  NEVER: 0,
-  RANDOM: 1,
-  ALWAYS: 2
-};
-var VARIATION = {
-  NO: 0,
-  FIRST: 1,
-  ALL: 2
-};
 
 // src/tarask.ts
 var tarask = (text, pipeline, cfg = new TaraskConfig()) => {
-  const options = { cfg, storage: {} };
-  return pipeline.reduce((text2, step) => step(text2, options), text);
+  const options = { text, cfg, storage: {} };
+  for (const step of pipeline)
+    step(options);
+  return options.text;
 };
 
 // src/steps/index.ts
 var steps_exports = {};
 __export(steps_exports, {
-  applyHtmlG: () => applyHtmlG,
-  applyHtmlVariations: () => applyHtmlVariations,
+  afterJoin: () => afterJoin,
+  applyGHtml: () => applyGHtml,
+  applyGNonHtml: () => applyGNonHtml,
   applyNoFix: () => applyNoFix,
-  applyNonHtmlG: () => applyNonHtmlG,
-  applyNonHtmlVariations: () => applyNonHtmlVariations,
   applyVariableParts: () => applyVariableParts,
+  applyVariationsHtml: () => applyVariationsHtml,
+  applyVariationsNonHtml: () => applyVariationsNonHtml,
   convertAlphabet: () => convertAlphabet,
   convertAlphabetLowerCase: () => convertAlphabetLowerCase,
-  highlightDiffNonHtmlStep: () => highlightDiffNonHtmlStep,
+  finalize: () => finalize,
   highlightDiffStep: () => highlightDiffStep,
+  highlightDiffStepNonHtml: () => highlightDiffStepNonHtml,
   joinSplittedText: () => joinSplittedText,
   prepare: () => prepare,
   replaceIbyJ: () => replaceIbyJ,
   resolveSpecialSyntax: () => resolveSpecialSyntax,
   restoreCaseStep: () => restoreCaseStep,
+  restoreParentheses: () => restoreParentheses,
   restoreWhitespaces: () => restoreWhitespaces,
   storeSplittedAbcConvertedOrig: () => storeSplittedAbcConvertedOrig,
   storeSplittedText: () => storeSplittedText,
   taraskevize: () => taraskevize,
+  toLowerCase: () => toLowerCase,
   trim: () => trim,
   whitespacesToSpaces: () => whitespacesToSpaces
 });
@@ -2272,55 +2284,118 @@ var ansiColorWrappers = {
 };
 
 // src/steps/convert-alphabet.ts
-var convertAlphabet = (text, {
-  cfg: {
-    general: { abc }
-  }
-}) => replaceWithDict(replaceWithDict(text, abc.lower), abc.upper);
-var convertAlphabetLowerCase = (text, {
-  cfg: {
-    general: { abc }
-  }
-}) => replaceWithDict(text, abc.lower);
+var convertAlphabet = (options) => {
+  const { lower, upper } = options.cfg.general.abc;
+  options.text = replaceWithDict(replaceWithDict(options.text, lower), upper);
+};
+var convertAlphabetLowerCase = (options) => {
+  options.text = replaceWithDict(options.text, options.cfg.general.abc.lower);
+};
 
 // src/steps/highlight-diff.ts
-var highlightDiffStep = (highlight) => (_, {
+var highlightDiffStep = (highlight) => ({
   cfg: {
     general: { abc }
   },
-  storage: { text, orig }
+  storage: { textArr, origArr }
 }) => {
-  highlightDiff(text, orig, abc === alphabets_exports.cyrillic, highlight);
-  return _;
+  highlightDiff(textArr, origArr, abc === alphabets_exports.cyrillic, highlight);
 };
-var highlightDiffNonHtmlStep = (_, {
+var highlightDiffStepNonHtml = ({
   cfg: {
     general: { abc },
     nonHtml: { ansiColors }
   },
-  storage: { text, orig }
+  storage: { textArr, origArr }
 }) => {
   if (ansiColors)
     highlightDiff(
-      text,
-      orig,
+      textArr,
+      origArr,
       abc === alphabets_exports.cyrillic,
       ansiColorWrappers.fix
     );
-  return _;
+};
+
+// src/steps/i-to-j.ts
+var toJ = (shortU) => "й " + (shortU ? "у" : "");
+var replaceIbyJ = (options) => {
+  const { abc, j } = options.cfg.general;
+  if (j && abc !== alphabets_exports.latinJi)
+    options.text = options.text.replace(
+      /(?<=[аеёіоуыэюя] )і (ў?)/g,
+      j === REPLACE_J.ALWAYS ? ($0, $1) => toJ($1) : ($0, $1) => Math.random() >= 0.5 ? toJ($1) : $0
+    );
+};
+
+// src/steps/join-splitted.ts
+var joinSplittedText = (options) => {
+  options.text = options.storage.textArr.join(" ");
+};
+
+// src/steps/apply-g.ts
+var applyGHtml = (options) => {
+  const colorize = htmlWrappers.letterH;
+  if (options.cfg.general.abc === alphabets_exports.cyrillic)
+    options.text = replaceG(
+      options.cfg.html.g ? colorize("$&") : ($0) => colorize(gobj[$0])
+    )(options.text);
+};
+var applyGNonHtml = (options) => {
+  const colorize = ansiColorWrappers.variable;
+  const {
+    cfg: {
+      general: { abc },
+      nonHtml: { h, ansiColors }
+    }
+  } = options;
+  if (abc === alphabets_exports.cyrillic && (h || ansiColors))
+    options.text = replaceG(
+      ansiColors ? h ? ($0) => colorize(gobj[$0]) : colorize("$&") : ($0) => gobj[$0]
+    )(options.text);
+};
+
+// src/steps/apply-variations.ts
+var applyVariableParts = (callback) => (options) => {
+  options.text = options.text.replace(
+    /\([^)]*?\)/g,
+    ($0) => callback($0.slice(1, -1).split("|"))
+  );
+};
+var applyVariationsHtml = applyVariableParts((parts) => {
+  const main = parts.shift();
+  return `<tarL data-l='${parts}'>${main}</tarL>`;
+});
+var applyVariationsNonHtml = (options) => {
+  const partIndex = options.cfg.nonHtml.variations;
+  const colorize = ansiColorWrappers.variable;
+  if (partIndex !== VARIATION.ALL)
+    applyVariableParts(
+      options.cfg.nonHtml.ansiColors ? (parts) => colorize(parts[partIndex]) : (parts) => parts[partIndex]
+    )(options);
+};
+
+// src/steps/prepare.ts
+var prepare = (options) => {
+  options.text = options.text.replace(/г'(?![еёіюя])/g, "ґ").replace(/ - /g, " — ").replace(new RegExp("(\\p{P}|\\p{S}|\\d+)", "gu"), " $1 ").replace(/ ['`’] (?=\S)/g, "ʼ").replace(/\(/g, "&#40");
 };
 
 // src/steps/resolve-syntax.ts
 var NOFIX_CHAR = "  ";
 var NOFIX_REGEX = new RegExp(NOFIX_CHAR, "g");
-var applyNoFix = (text, { storage: { noFixArr } }) => noFixArr.length ? text.replace(NOFIX_REGEX, () => noFixArr.shift()) : text;
-var applyVariableParts = (callback) => (text) => text.replace(/\([^)]*?\)/g, ($0) => callback($0.slice(1, -1).split("|")));
-var resolveSpecialSyntax = (leftAngleBracket) => (text, {
-  storage,
-  cfg: {
-    general: { doEscapeCapitalized, abc }
-  }
-}) => {
+var applyNoFix = (options) => {
+  const { noFixArr } = options.storage;
+  if (noFixArr.length)
+    options.text = options.text.replace(NOFIX_REGEX, () => noFixArr.shift());
+};
+var resolveSpecialSyntax = (leftAngleBracket) => (options) => {
+  const {
+    text,
+    storage,
+    cfg: {
+      general: { doEscapeCapitalized, abc }
+    }
+  } = options;
   const noFixArr = storage.noFixArr = [];
   const convertAlphavet = (abcOnlyText, abc2) => restoreCase(
     replaceWithDict(abcOnlyText.toLowerCase(), abc2.lower).split(" "),
@@ -2334,8 +2409,10 @@ var resolveSpecialSyntax = (leftAngleBracket) => (text, {
     }
   ) : text2;
   const parts = text.split(/(?=[<>])/g);
-  if (parts.length === 1)
-    return escapeCapsIfNeeded(text);
+  if (parts.length === 1) {
+    options.text = escapeCapsIfNeeded(text);
+    return;
+  }
   let result = text.startsWith("<") ? "" : escapeCapsIfNeeded(parts.shift());
   let depth = 0;
   let currentPart = "";
@@ -2380,94 +2457,53 @@ var resolveSpecialSyntax = (leftAngleBracket) => (text, {
       result += escapeCapsIfNeeded(part);
     }
   }
-  return result + escapeCapsIfNeeded(currentPart);
-};
-
-// src/steps/html-steps.ts
-var applyHtmlVariations = applyVariableParts((parts) => {
-  const main = parts.shift();
-  return `<tarL data-l='${parts}'>${main}</tarL>`;
-});
-var applyHtmlG = (text, {
-  cfg: {
-    general: { abc },
-    html: { g }
-  }
-}) => {
-  const colorize = htmlWrappers.letterH;
-  return abc === alphabets_exports.cyrillic ? replaceG(g ? colorize("$&") : ($0) => colorize(gobj[$0]))(text) : text;
-};
-
-// src/steps/i-to-j.ts
-var toJ = (shortU) => "й " + (shortU ? "у" : "");
-var replaceIbyJ = (text, {
-  cfg: {
-    general: { j, abc }
-  }
-}) => j && abc !== alphabets_exports.latinJi ? text.replace(
-  /(?<=[аеёіоуыэюя] )і (ў?)/g,
-  j === REPLACE_J.ALWAYS ? ($0, $1) => toJ($1) : ($0, $1) => Math.random() >= 0.5 ? toJ($1) : $0
-) : text;
-
-// src/steps/join-splitted.ts
-var joinSplittedText = (_, { storage: { text } }) => text.join(" ");
-
-// src/steps/non-html-steps.ts
-var applyNonHtmlVariations = (text, options) => {
-  const partIndex = options.cfg.nonHtml.variations;
-  const colorize = ansiColorWrappers.variable;
-  return partIndex === VARIATION.ALL ? text : applyVariableParts(
-    options.cfg.nonHtml.ansiColors ? (parts) => colorize(parts[partIndex]) : (parts) => parts[partIndex]
-  )(text, options);
-};
-var applyNonHtmlG = (text, {
-  cfg: {
-    general: { abc },
-    nonHtml: { h, ansiColors }
-  }
-}) => {
-  const colorize = ansiColorWrappers.variable;
-  return abc === alphabets_exports.cyrillic && (h || ansiColors) ? replaceG(
-    ansiColors ? h ? ($0) => colorize(gobj[$0]) : colorize("$&") : ($0) => gobj[$0]
-  )(text) : text;
+  options.text = result + escapeCapsIfNeeded(currentPart);
 };
 
-// src/steps/prepare.ts
-var prepare = (text) => text.replace(/г'(?![еёіюя])/g, "ґ").replace(/ - /g, " — ").replace(new RegExp("(\\p{P}|\\p{S}|\\d+)", "gu"), " $1 ").replace(/ ['`’] (?=\S)/g, "ʼ").replace(/\(/g, "&#40");
-
 // src/steps/restore-case.ts
-var restoreCaseStep = (_, {
+var restoreCaseStep = ({
   cfg: {
     general: { abc }
   },
-  storage: { text, orig }
+  storage: { textArr, origArr }
 }) => {
   if (abc.upper) {
-    restoreCase(text, orig);
+    restoreCase(textArr, origArr);
   } else {
-    for (let i = 0; i < text.length; i++) {
-      if (orig[i] !== orig[i].toLowerCase())
-        text[i] = orig[i];
+    for (let i = 0; i < textArr.length; i++) {
+      if (origArr[i] !== origArr[i].toLowerCase())
+        textArr[i] = origArr[i];
     }
   }
-  return _;
 };
 
 // src/steps/store-splitted-abc-converted-orig.ts
-var storeSplittedAbcConvertedOrig = (text, options) => {
-  options.storage.orig = convertAlphabet(text, options).split(" ");
-  return text;
+var storeSplittedAbcConvertedOrig = ({
+  cfg: {
+    general: {
+      abc: { lower, upper }
+    }
+  },
+  text,
+  storage
+}) => {
+  storage.origArr = replaceWithDict(replaceWithDict(text, lower), upper).split(
+    " "
+  );
 };
 
 // src/steps/store-splitted-text.ts
-var storeSplittedText = (text, { storage }) => {
-  storage.text = text.split(" ");
-  return text;
+var storeSplittedText = ({
+  text,
+  storage
+}) => {
+  storage.textArr = text.split(" ");
 };
 
 // src/steps/taraskevize.ts
 var wordlistPlusNoSoften = wordlist.concat(noSoften);
-var taraskevize = (text) => {
+var taraskevize = (options) => {
+  let { text } = options;
   text = replaceWithDict(text, wordlistPlusNoSoften);
   softening:
     do {
@@ -2477,37 +2513,56 @@ var taraskevize = (text) => {
           continue softening;
       break;
     } while (true);
-  return replaceWithDict(text.replace(//g, ""), afterTarask);
+  options.text = replaceWithDict(text.replace(//g, ""), afterTarask);
 };
 
 // src/steps/whitespaces.ts
-var whitespacesToSpaces = (text, { storage }) => {
+var whitespacesToSpaces = (options) => {
+  const { storage } = options;
   storage.spaces = [];
-  return text.replace(/\s+/g, (match) => {
+  options.text = options.text.replace(/\s+/g, (match) => {
     storage.spaces.push(match);
     return " ";
   });
 };
-var restoreWhitespaces = (text, { storage }) => {
-  storage.spaces.reverse();
-  return text.replace(/ /g, () => storage.spaces.pop());
+var restoreWhitespaces = (options) => {
+  const { spaces } = options.storage;
+  spaces.reverse();
+  options.text = options.text.replace(/ /g, () => spaces.pop());
 };
 
 // src/steps/trim.ts
-var trim = (text) => ` ${text.trim()} `;
+var trim = (options) => {
+  options.text = ` ${options.text.trim()} `;
+};
+
+// src/steps/other.ts
+var restoreParentheses = (options) => {
+  options.text = options.text.replace(/&#40/g, "(");
+};
+var afterJoin = (options) => {
+  options.text = options.text.replace(/&nbsp;/g, " ").replace(new RegExp(" (\\p{P}|\\p{S}|\\d+|&#40) ", "gu"), "$1");
+};
+var finalize = (newLine) => (options) => {
+  options.text = options.text.replace(/\n/g, newLine).trim();
+};
+var toLowerCase = (options) => {
+  options.text = options.text.toLowerCase();
+};
 
 // src/pipelines.ts
-var restoreParentheses = (text) => text.replace(/&#40/g, "(");
-var afterJoin = (text) => text.replace(/&nbsp;/g, " ").replace(new RegExp(" (\\p{P}|\\p{S}|\\d+|&#40) ", "gu"), "$1");
-var finalize = (newLine) => (text) => text.replace(/\n/g, newLine).trim();
+var pipelines_exports = {};
+__export(pipelines_exports, {
+  abcOnly: () => abcOnly,
+  html: () => html,
+  plainText: () => plainText
+});
 var resolveSpecialSyntaxWithLAB = resolveSpecialSyntax("<");
-var toLowerCase = (text) => text.toLowerCase();
 var finalizeWithNewLine = finalize("\n");
-var abcOnlyPipeline = [
-  (_, { storage, cfg: { general } }) => {
+var abcOnly = [
+  ({ storage, cfg: { general } }) => {
     storage.doEscapeCapitalized = general.doEscapeCapitalized;
     general.doEscapeCapitalized = false;
-    return _;
   },
   trim,
   resolveSpecialSyntaxWithLAB,
@@ -2519,9 +2574,8 @@ var abcOnlyPipeline = [
   restoreParentheses,
   afterJoin,
   finalizeWithNewLine,
-  (_, { storage, cfg: { general } }) => {
+  ({ storage, cfg: { general } }) => {
     general.doEscapeCapitalized = storage.doEscapeCapitalized;
-    return _;
   }
 ];
 var createPipeline = (resolveSpecialSyntax2, applyG, applyVariations, finalize2, highlightDiffStep2) => [
@@ -2546,17 +2600,17 @@ var createPipeline = (resolveSpecialSyntax2, applyG, applyVariations, finalize2,
   applyNoFix,
   finalize2
 ];
-var plainTextPipeline = createPipeline(
+var plainText = createPipeline(
   resolveSpecialSyntaxWithLAB,
-  applyNonHtmlG,
-  applyNonHtmlVariations,
+  applyGNonHtml,
+  applyVariationsNonHtml,
   finalizeWithNewLine,
-  highlightDiffNonHtmlStep
+  highlightDiffStepNonHtml
 );
-var htmlPipeline = createPipeline(
+var html = createPipeline(
   resolveSpecialSyntax("&lt;"),
-  applyHtmlG,
-  applyHtmlVariations,
+  applyGHtml,
+  applyVariationsHtml,
   finalize("<br>"),
   highlightDiffStep(htmlWrappers.fix)
 );
@@ -2565,11 +2619,9 @@ var htmlPipeline = createPipeline(
   REPLACE_J,
   TaraskConfig,
   VARIATION,
-  abcOnlyPipeline,
   dicts,
-  htmlPipeline,
   lib,
-  plainTextPipeline,
+  pipelines,
   steps,
   tarask
 });