taraskevizer 6.0.9 → 6.1.0

package/README.md

@@ -232,30 +232,24 @@ bun add -g taraskevizer
 ## Usage
 
 ```bash
-tarask "планета"
+tarask [options] text
 ```
 
-## Options
+For usage examples and options use `--help` option
+(in source, content of `--help` is in [this file](./cli-help.txt))
+
+### "Without installation"
+
+With npm:
+
+```bash
+npx taraskevizer [options] text
+```
+
+With bun:
 
 ```bash
-# Alpabet
---latin (-l)
---latin-ji (-lj)
---arabic (-a)
-# When to replace і(i) by й(j) after vowels
---jrandom (-jr)
---jalways (-ja)
-# Replace ґ(g) by г(h) in cyrillic alphabet
---h (-h)
-# Variations
---no-variations (-nv)
---first-variation-only (-fvo)
-# Mode
---html (-html)
---alphabet-only (-abc)
-# Other
---not-escape-caps (-nec)
---no-color (-nc)
+bunx taraskevizer [options] text
 ```
 
 # Known bugs

package/dist/bin.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 import { ALPHABET, REPLACE_J, Taraskevizer, VARIATION } from "./index.js";
 import readline from "readline/promises";
-import { readFile } from "fs/promises";
 const prefix = "\x1B[34m[taraskevizer]\x1B[0m ";
 const printWithPrefix = (msg) => {
   process.stdout.write(prefix + msg.toString() + "\n");
@@ -9,10 +8,56 @@ const printWithPrefix = (msg) => {
 process.argv.splice(0, 2);
 const checkForOptions = (options) => process.argv[0] && options.includes(process.argv[0].toLowerCase());
 if (checkForOptions(["-v", "--version"])) {
-  const { version } = JSON.parse(
-    await readFile(new URL("../package.json", import.meta.url), "utf8")
-  );
-  printWithPrefix(version);
+  printWithPrefix("6.1.0");
+  process.exit(0);
+}
+if (checkForOptions(["-h", "--help"])) {
+  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\x1B[32ml\x1B[0ma\x1B[32mne\x1B[0mta"
+
+Read from one file and write converted text to another
+	tarask < ./cyr-text.txt > ./lat-text.txt
+
+Enter interactive mode
+	tarask
+Will print "\x1B[34m[taraskevizer]\x1B[0m Enter the text:" and wait until you press Enter
+
+OPTIONS
+
+General:
+	-h --help
+	-v --version
+
+Alphabet:
+  -l --latin
+  -lj --latin-ji
+  -a --arabic
+
+When to replace і(i) by й(j) after vowels:
+  -jr --jrandom
+  -ja --jalways
+
+Replace ґ(g) by г(h) in cyrillic alphabet:
+  --h
+
+Variations:
+  -nv --no-variations
+  -fvo --first-variation-only
+
+Mode (only one can be used):
+  -html --html
+  -abc --alphabet-only
+
+Other:
+  -nec --not-escape-caps
+  -nc --no-color
+`);
   process.exit(0);
 }
 const general = {};
@@ -30,6 +75,8 @@ const toHashTable = (dict) => {
   return result;
 };
 const optionDict = toHashTable([
+  [["--help", "-h"], () => {
+  }],
   [
     ["--latin", "-l"],
     () => {
@@ -67,7 +114,7 @@ const optionDict = toHashTable([
     }
   ],
   [
-    ["--h", "-h"],
+    ["--h"],
     () => {
       nonHtml.h = true;
       html.g = false;

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 type Dict<T = RegExp> = readonly (readonly [T, string])[];
-type WritableDict<T = RegExp> = [T, string][];
 
 type ModifyObjectType<T, TResultObj> = T extends object ? T extends (...args: any[]) => any ? T : TResultObj : T;
 type DeepPartialReadonly<T> = ModifyObjectType<T, {
@@ -47,7 +46,7 @@ declare const __tarask__: {
     readonly softeners: Dict;
     readonly replaceWithDict: (text: string, dict?: ExtendedDict) => string;
     readonly afterTarask: ExtendedDict;
-    readonly noSoften: WritableDict;
+    readonly noSoften: Dict;
 };
 declare class Taraskevizer {
     general: {

package/package.json

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