taraskevizer 9.2.1 → 9.2.3

package/dist/bin.js

@@ -1,61 +1,60 @@
 #!/usr/bin/env node
 import { dicts, TaraskConfig, tarask, pipelines, htmlConfigOptions, wrappers, } from './index.js';
-const prefix = '\x1b[34m[taraskevizer]\x1b[0m ';
 const printWithPrefix = (msg) => {
-    process.stdout.write(prefix + msg + '\n');
+    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.2.1");
+    printWithPrefix("9.2.3");
     process.exit(0);
 }
 if (checkForOptions(['-h', '--help'])) {
-    printWithPrefix(`Usage: tarask [options] text
+    printWithPrefix(`Usage: tarask [options] text
 If text is not passed, interactive mode will be enabled
 
 EXAMPLES
 
 Convert and latinize a word
-	tarask --latin 'планета'
-Will print "p<fix>l</fix>a<fix>ne</fix>ta"
+	tarask --latin 'планета'
+Will print "planeta"
 
 Read from one file and write converted text to another
-	tarask < ./cyr-text.txt > ./lat-text.txt
+	tarask < ./cyr-text.txt > ./lat-text.txt
 
 Enter interactive mode
-	tarask
-Will print "[taraskevizer] Enter the text:" and wait until you press Enter
+	tarask
+Will print "[taraskevizer] Enter the text:" and wait until you press Enter
 
 OPTIONS
 
-General:
-  -h --help
-  -v --version
+General:
+  -h --help
+  -v --version
 
-Alphabet:
-  -l --latin
-  -lj --latin-ji
-  -a --arabic
+Alphabet:
+  -l --latin
+  -lj --latin-ji
+  -a --arabic
 
-When to replace і(i) by й(j) after vowels:
-  -jr --jrandom
-  -ja --jalways
+When to replace і(i) by й(j) after vowels:
+  -jr --jrandom
+  -ja --jalways
 
-Replace ґ(g) by г(h) in cyrillic alphabet:
-  --h
+Replace ґ(g) by г(h) in cyrillic alphabet:
+  --h
 
-Variations:
-  -nv --no-variations
-  -fv --first-variation
+Variations:
+  -nv --no-variations
+  -fv --first-variation
 
-Mode (only one can be used):
-  -html --html
-  -abc --alphabet-only
+Mode (only one can be used):
+  -html --html
+  -abc --alphabet-only
 
-Other:
-  -nec --not-escape-caps
-  -nc --no-color
+Other:
+  -nec --not-escape-caps
+  -nc --no-color
 `);
     process.exit(0);
 }

package/dist/pipelines.d.ts

@@ -1,16 +1,16 @@
 /**
- * A pipeline in Taraskevizer is basically
- * an array of steps of type {@link steps.TaraskStep}.
+ * You can use builtin pipelines from this module or create your own.
  *
- * You can use pre-made pipelines from this module or create your own.
- *
- * If you want to create a pipeline based on a pre-made one
+ * If you want to create a pipeline based on a builtin one
  * and do it more safely, it's recommended to use
  * `.map` if you need replacing only or
  * `.flatMap` if you also need to add or remove steps.
  *
  * This way you will depend less on the
- * internal structure of the pre-made pipeline.
+ * internal structure of the builtin pipeline.
+ *
+ * For cases when you need to replace only {@link steps.taraskevize} in {@link tar}
+ * and have better tree-shaking, you can use {@link _createPipeline}.
  *
  * @module
  */
@@ -21,6 +21,7 @@ import { type TaraskStep } from './steps';
 type AbcOnlyStorage = {
     doEscapeCapitalized: boolean;
 };
+export type Pipeline = TaraskStep<any>[];
 /**
  * Pipeline for changing only the alphabet.
  *
@@ -38,9 +39,9 @@ export declare const abc: (TaraskStep<import("./steps").SpecialSyntaxStorage> |
  *
  * Used by {@link tar} and {@link phonetic}.
  *
- * @param steps - Steps used instead of [{@link steps.taraskevize}].
+ * @param subPipeline - Steps used instead of [{@link subPipeline.taraskevize}].
  */
-export declare const _createPipeline: (steps: TaraskStep<any>[]) => (TaraskStep<import("./steps").SplittedTextStorage> | TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
+export declare const _createPipeline: (subPipeline: Pipeline) => (TaraskStep<import("./steps").SplittedTextStorage> | TaraskStep<import("./steps").SpecialSyntaxStorage> | TaraskStep<import("./steps").WhiteSpaceStorage> | TaraskStep<import("./steps").TrimStorage>)[];
 /**
  * Pipeline for taraskevizing.
  */

package/dist/pipelines.js

@@ -20,14 +20,14 @@ export const abc = [
     }),
 ];
 
-export const _createPipeline = (steps) => [
+export const _createPipeline = (subPipeline) => [
     trim,
     resolveSpecialSyntax,
     prepare,
     whitespacesToSpaces,
     storeSplittedAbcConvertedOrig,
     toLowerCase,
-    ...steps,
+    ...subPipeline,
     replaceIbyJ,
     convertAlphabetLowerCase,
     storeSplittedText,

package/dist/tarask.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "taraskevizer",
-	"version": "9.2.1",
+	"version": "9.2.3",
 	"author": "GooseOb",
 	"repository": {
 		"type": "git",
@@ -10,12 +10,12 @@
 	"module": "dist/index.js",
 	"devDependencies": {
 		"@digitak/esrun": "^3.2.26",
-		"@types/node": "^20.16.5",
-		"bun-types": "^1.1.27",
+		"@types/node": "^20.16.11",
+		"bun-types": "^1.1.30",
 		"husky": "^9.1.6",
 		"prettier": "^3.3.3",
-		"typedoc": "^0.26.7",
-		"typescript": "^5.6.2"
+		"typedoc": "^0.26.9",
+		"typescript": "^5.6.3"
 	},
 	"bin": {
 		"tarask": "dist/bin.js"