taraskevizer 9.3.4 → 10.0.0-alpha.0

package/README.md

@@ -4,19 +4,19 @@
 
 With npm:
 
-```bash
+```sh
 npm install taraskevizer
 ```
 
 With yarn:
 
-```bash
+```sh
 yarn add taraskevizer
 ```
 
 With bun:
 
-```bash
+```sh
 bun add taraskevizer
 ```
 
@@ -24,7 +24,6 @@ bun add taraskevizer
 
 ```js
 import {
-	tarask,
 	pipelines,
 	TaraskConfig,
 	htmlConfigOptions,
@@ -34,32 +33,32 @@ import {
 	VARIATION,
 } from 'taraskevizer';
 
-tarask('планета', pipelines.tar);
+pipelines.tarask('планета');
 // "плянэта"
 
+// Explicit config declaration is recommended if it's used multiple times
 const cfg = new TaraskConfig({
 	abc: alphabets.cyrillic,
 	j: 'always',
 	variations: 'first',
-	wrapperDict: ansiColorWrappers,
+	wrappers: ansiColorWrappers,
 	g: true,
 });
-tarask('планета і Гродна', pipelines.tar, cfg);
+pipelines.tarask('планета і Гродна', cfg);
 // "пл\x1b[32mя\x1b[0mн\x1b[32mэ\x1b[0mта \x1b[32mй\x1b[0m \x1b[35mГорадня\x1b[0m"
 
-const htmlCfg = new TaraskConfig({
-	abc: alphabets.latin,
-	g: false,
+pipelines.tarask('энергія планеты', {
 	...htmlConfigOptions,
+	abc: alphabets.latin,
+	g: false, // ignored, g matters for cyrillic alphabet only
 });
-tarask('энергія планеты', pipelines.tar, htmlCfg);
 // "en<tarF>erg</tarF>ija p<tarF>lan</tarF>ety"
 
 const latinWithJiCfg = new TaraskConfig({
 	abc: alphabets.latinJi,
 });
 
-tarask('яна і іншыя', pipelines.abcOnly, latinWithJiCfg);
+pipelines.alphabetic('яна і іншыя', latinWithJiCfg);
 // "jana j jinšyja"
 ```
 
@@ -111,25 +110,25 @@ Appears only if alphabet is cyrillic.
 
 With npm:
 
-```bash
+```sh
 npm install -g taraskevizer
 ```
 
 With yarn:
 
-```bash
+```sh
 yarn global add taraskevizer
 ```
 
 With bun:
 
-```bash
+```sh
 bun add -g taraskevizer
 ```
 
 ## Usage
 
-```bash
+```sh
 tarask [options] text
 ```
 
@@ -140,13 +139,13 @@ For usage examples and options use `--help` option
 
 With npm:
 
-```bash
+```sh
 npx taraskevizer [options] text
 ```
 
 With bun:
 
-```bash
+```sh
 bunx taraskevizer [options] text
 ```
 

package/dist/bin.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import { dicts, TaraskConfig, tarask, pipelines, htmlConfigOptions, wrappers, } from './index.js';
+import { dicts, TaraskConfig, pipelines, htmlConfigOptions, wrappers } from './index.js';
 const printWithPrefix = (msg) => {
     process.stdout.write("[taraskevizer]" + ' ' + msg + '\n');
 };
 process.argv.splice(0, 2);
 const checkForOptions = (options) => process.argv[0] && options.includes(process.argv[0].toLowerCase());
 if (checkForOptions(['-v', '--version'])) {
-    printWithPrefix("9.3.4");
+    printWithPrefix("10.0.0-alpha.0");
     process.exit(0);
 }
 if (checkForOptions(['-h', '--help'])) {
@@ -63,7 +63,7 @@ let cfg = {
     variations: 'all',
     wrapperDict: wrappers.ansiColor,
 };
-let mode = 'tar';
+let mode = 'tarask';
 const toHashTable = (dict) => {
     const result = {};
     for (const { 0: options, 1: callback } of dict)
@@ -143,7 +143,7 @@ const optionDict = toHashTable([
     [
         ['--alphabet-only', '-abc'],
         () => {
-            mode = 'abc';
+            mode = 'alphabetic';
         },
     ],
     [
@@ -195,7 +195,7 @@ cfg = new TaraskConfig(isHtml
         wrapperDict: htmlConfigOptions.wrapperDict,
     }
     : cfg);
-if (process.stdout.write(tarask(text, pipelines[mode], cfg) + '\n')) {
+if (process.stdout.write(pipelines[mode](text, cfg) + '\n')) {
     process.exit(0);
 }
 else {

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export * as dicts from './dict';
-export * from './tarask';
 export * from './config';
 export * as steps from './steps';
 export * as pipelines from './pipelines';

package/dist/index.js

@@ -1,5 +1,4 @@
 export * as dicts from './dict/index.js';
-export * from './tarask.js';
 export * from './config.js';
 export * as steps from './steps/index.js';
 export * as pipelines from './pipelines.js';

package/dist/lib/after-tarask.js

@@ -6,7 +6,7 @@ export const endZSoftenAndNiaBiaz = callableDict([
     // )
     // (?!{прыназоўнік})/
     [
-        / не (?=[бвгджзйклмнпхрстфхцчшўьʼ]*.\u0301|[бвгджзйклмнпхрстфхцчшўьʼ]*[аеёіоуыэюя][бвгджзйклмнпхрстфхцчшўьʼ]* )(?!а[бд]?|б[ея]зь?|[дз]а|д?ля|дзеля|[нп]ад?|пр[аы]|празь?|у|церазь?)/g,
+        / не (?=[бвгджзйклмнпрстфхцчшўьʼ]*.\u0301|[бвгджзйклмнпрстфхцчшўьʼ]*[аеёіоуыэюя][бвгджзйклмнпрстфхцчшўьʼ]* )(?!а[бд]?|б[ея]зь?|[дз]а|д?ля|дзеля|[нп]ад?|пр[аы]|празь?|у|церазь?)/g,
         ' ня ',
     ],
     // / без(?=ь? (?:
@@ -14,7 +14,7 @@ export const endZSoftenAndNiaBiaz = callableDict([
     //  |{зычны}*{галосны}{зычны}*{канец слова}
     // )/
     [
-        / без(?=ь? (?:[бвгджзйклмнпхрстфхцчшўьʼ]*.\u0301|[бвгджзйклмнпхрстфхцчшўьʼ]*[аеёіоуыэюя][бвгджзйклмнпхрстфхцчшўьʼ]* ))/g,
+        / без(?=ь? (?:[бвгджзйклмнпрстфхцчшўьʼ]*.\u0301|[бвгджзйклмнпрстфхцчшўьʼ]*[аеёіоуыэюя][бвгджзйклмнпрстфхцчшўьʼ]* ))/g,
         ' бяз',
     ],
     

package/dist/pipelines.d.ts

@@ -3,19 +3,29 @@
  *
  * If you want to create your own pipeline
  * based on a builtin one and do it safely, use
- * `.map` if you need replacing only or
- * `.flatMap` if you also need to add or remove steps.
+ * `pipeline.steps.map` if you need replacing only or
+ * `pipeline.steps.flatMap` if you also need to add or remove steps.
+ *
+ * Then pass the result to {@link createPipeline}.
  *
  * This way you will depend less on the
- * internal structure of the builtin pipeline.
+ * internal order of the builtin pipeline steps.
  *
- * For cases when you need to replace only {@link steps.taraskevize} in {@link tar}
+ * For cases when you need to replace only {@link steps.taraskevize} in {@link tarask}
  * and have better tree-shaking, you can use {@link _createPipeline}.
  *
  * @module
  */
+import { TaraskConfig } from './config';
 import { type TaraskStep } from './steps';
-export type Pipeline = TaraskStep<any>[];
+export type Pipeline = {
+    (text: string, cfg?: Partial<TaraskConfig>): string;
+    steps: TaraskStep<any>[];
+};
+/**
+ * Create a callable pipeline from steps.
+ */
+export declare const createPipeline: (steps: TaraskStep<any>[]) => Pipeline;
 /**
  * Pipeline for changing only the alphabet.
  *
@@ -23,21 +33,21 @@ export type Pipeline = TaraskStep<any>[];
  *
  * To see the full list of steps, check the source code.
  */
-export declare const abc: (TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
+export declare const alphabetic: Pipeline;
 /**
  * For better tree-shaking instead of `Array.prototype.flatMap`
  *
- * Used by {@link tar} and {@link phonetic}.
+ * Used by {@link tarask} and {@link phonetic}.
  *
  * @param subPipeline - Steps used instead of [{@link steps.taraskevize}].
  */
-export declare const _createPipeline: (subPipeline: Pipeline) => (TaraskStep<import("./steps").SplittedTextStorage> | TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
+export declare const _createPipeline: (subPipeline: TaraskStep<any>[]) => Pipeline;
 /**
  * Pipeline for taraskevizing.
  */
-export declare const tar: (TaraskStep<import("./steps").SplittedTextStorage> | TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
+export declare const tarask: Pipeline;
 /**
  * Pipeline for phonetizing.
  * @alpha
  */
-export declare const phonetic: (TaraskStep<import("./steps").SplittedTextStorage> | TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
+export declare const phonetic: Pipeline;

package/dist/pipelines.js

@@ -1,7 +1,23 @@
 
+import { TaraskConfig } from './config.js';
 import { highlightDiffStep, applyNoFix, convertAlphabet, convertAlphabetLowerCase, joinSplittedText, prepare, replaceIbyJ, resolveSpecialSyntax, restoreCaseStep, restoreWhitespaces, storeSplittedAbcConvertedOrig, storeSplittedText, taraskevize, phonetize, whitespacesToSpaces, trim, finalize, toLowerCase, iotacizeJi, untrim, applyG, applyVariations, } from './steps/index.js';
 
-export const abc = [
+export const createPipeline = (steps) => {
+    const fn = (text, cfg = new TaraskConfig()) => {
+        const ctx = {
+            text,
+            cfg: cfg instanceof TaraskConfig ? cfg : new TaraskConfig(cfg),
+            storage: {},
+        };
+        for (const step of fn.steps)
+            step(ctx);
+        return ctx.text;
+    };
+    fn.steps = steps;
+    return fn;
+};
+
+export const alphabetic = createPipeline([
     (ctx) => {
         ctx.cfg = { ...ctx.cfg, doEscapeCapitalized: false };
     },
@@ -14,9 +30,9 @@ export const abc = [
     applyNoFix,
     finalize,
     untrim,
-];
+]);
 
-export const _createPipeline = (subPipeline) => [
+export const _createPipeline = (subPipeline) => createPipeline([
     trim,
     resolveSpecialSyntax,
     prepare,
@@ -36,8 +52,8 @@ export const _createPipeline = (subPipeline) => [
     applyNoFix,
     finalize,
     untrim,
-];
+]);
 
-export const tar = _createPipeline([taraskevize]);
+export const tarask = _createPipeline([taraskevize]);
 
 export const phonetic = _createPipeline([phonetize, iotacizeJi]);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "taraskevizer",
-	"version": "9.3.4",
+	"version": "10.0.0-alpha.0",
 	"author": "GooseOb",
 	"repository": {
 		"type": "git",

package/dist/tarask.d.ts

@@ -1,10 +0,0 @@
-import { TaraskConfig } from './config';
-import type { Pipeline } from './pipelines';
-/**
- * @returns converted text
- *
- * @example
- * tarask("планета", pipelines.tar);
- * // "плянэта"
- */
-export declare const tarask: (text: string, pipeline: Pipeline, cfg?: Readonly<TaraskConfig>) => string;

package/dist/tarask.js

@@ -1,8 +0,0 @@
-import { TaraskConfig } from './config.js';
-
-export const tarask = (text, pipeline, cfg = new TaraskConfig()) => {
-    const ctx = { text, cfg, storage: {} };
-    for (const step of pipeline)
-        step(ctx);
-    return ctx.text;
-};