feat: ignoring URLs in translation feature added

Author: ParvinEyvazov

README.md

@@ -386,6 +386,22 @@ To ignore words on translation use `{{word}}` OR `{word}` style on your object.
 }
 ```
 
+- jsontt also ignores the `URL` in the text which means sometimes translations ruin the URL in the given string while translating that string. It prevents such cases by ignoring URLs in the string while translating.
+
+  - You don't especially need to do anything for it, it ignores them automatically.
+
+```
+{
+  "text": "this is a puppy https://shorturl.at/lvPY5"
+}
+
+...translating to german
+
+{
+  "text": "das ist ein welpe https://shorturl.at/lvPY5"
+}
+```
+
 ## **7. CLI commands**
 
 - translate
@@ -470,7 +486,7 @@ jsontt --help
 
 :heavy_check_mark: Argos Translate option (CLI)
 
-- [ ] Ignore URL translation on given string
+:heavy_check_mark: Ignore URL translation on given string
 
 - [ ] Libre Translate option (in code package)
 

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.2",
+  "version": "1.5.0",
   "license": "MIT",
   "main": "dist/index.js",
   "description": "Translate your JSON file or object into another languages with Google Translate API",
@@ -66,7 +66,7 @@
     "@types/bluebird": "^3.5.36",
     "@types/filesystem": "^0.0.32",
     "@vitalets/google-translate-api": "^9.0.0",
-    "axios": "^0.27.2",
+    "axios": "^1.2.2",
     "bluebird": "^3.7.2",
     "cwait": "^1.1.2",
     "http-proxy-agent": "^5.0.0",

src/core/ignorer.ts

@@ -5,6 +5,9 @@ export function map(
   db_map: { [key: string]: string };
   sb_map: { [key: string]: string };
 } {
+  // encode urls if exists in the str
+  str = urlEncoder(str);
+
   let { map: db_map, word: initial_ignored_word } = mapByDoubleBracket(str);
   let { map: sb_map, word: ignored_word } = mapBySingleBracket(
     initial_ignored_word
@@ -21,6 +24,9 @@ export function unMap(str: string, db_map: object, sb_map: object): string {
   let word = unmapBySingleBracket(str, sb_map);
   word = unmapByDoubleBracket(word, db_map);
 
+  // decode urls if exists in the str
+  word = urlDecoder(word);
+
   return word;
 }
 
@@ -89,3 +95,28 @@ function unmapIgnoredValues(
 
   return str;
 }
+
+// URL detector & encode AND decoder
+function urlEncoder(text: string): string {
+  // url finder regex => url
+  const regex = /(?:(?:https?|ftp|file):\/\/|www\.|ftp\.)(?:\([-A-Z0-9+&@#\/%=~_|$?!;:,.]*\)|[-A-Z0-9+&@#\/%=~_|$?!;:,.])*(?:\([-A-Z0-9+&@#\/%=~_|$?!;:,.]*\)|[A-Z0-9+&@#\/%=~_|$])/gim;
+
+  let new_text = text.replace(regex, function(url) {
+    url = `{` + url + `}`;
+    return url;
+  });
+
+  return new_text;
+}
+
+function urlDecoder(text: string): string {
+  // url finder regex => {url}
+  const regex = /{(?:(?:https?|ftp|file):\/\/|www\.|ftp\.)(?:\([-A-Z0-9+&@#\/%=~_|$?!;:,.]*\)|[-A-Z0-9+&@#\/%=~_|$?!;:,.])*(?:\([-A-Z0-9+&@#\/%=~_|$?!;:,.]*\)|[A-Z0-9+&@#\/%=~_|$])}/gim;
+
+  let new_text = text.replace(regex, function(url) {
+    url = url.substring(1, url.length - 1);
+    return url;
+  });
+
+  return new_text;
+}

yarn.lock

@@ -1940,13 +1940,14 @@ axe-core@^4.4.3:
   resolved "https://registry.yarnpkg.com/axe-core/-/axe-core-4.5.1.tgz#04d561c11b6d76d096d34e9d14ba2c294fb20cdc"
   integrity sha512-1exVbW0X1O/HSr/WMwnaweyqcWOgZgLiVxdLG34pvSQk4NlYQr9OUy0JLwuhFfuVNQzzqgH57eYzkFBCb3bIsQ==
 
-axios@^0.27.2:
-  version "0.27.2"
-  resolved "https://registry.yarnpkg.com/axios/-/axios-0.27.2.tgz#207658cc8621606e586c85db4b41a750e756d972"
-  integrity sha512-t+yRIyySRTp/wua5xEr+z1q60QmLq8ABsS5O9Me1AsE5dfKqgnCFzwiCZZ/cGNd1lq4/7akDWMxdhVlucjmnOQ==
+axios@^1.2.2:
+  version "1.2.2"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-1.2.2.tgz#72681724c6e6a43a9fea860fc558127dbe32f9f1"
+  integrity sha512-bz/J4gS2S3I7mpN/YZfGFTqhXTYzRho8Ay38w2otuuDR322KzFIWm/4W2K6gIwvWaws5n+mnb7D1lN9uD+QH6Q==
   dependencies:
-    follow-redirects "^1.14.9"
+    follow-redirects "^1.15.0"
     form-data "^4.0.0"
+    proxy-from-env "^1.1.0"
 
 axobject-query@^2.2.0:
   version "2.2.0"
@@ -3354,7 +3355,7 @@ flatted@^2.0.0:
   resolved "https://registry.yarnpkg.com/flatted/-/flatted-2.0.2.tgz#4575b21e2bcee7434aa9be662f4b7b5f9c2b5138"
   integrity sha512-r5wGx7YeOwNWNlCA0wQ86zKyDLMQr+/RB8xy74M4hTphfmjlijTSSXGuH8rnvKZnfT9i+75zmd8jcKdMR4O6jA==
 
-follow-redirects@^1.14.9:
+follow-redirects@^1.15.0:
   version "1.15.2"
   resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.2.tgz#b460864144ba63f2681096f274c4e57026da2c13"
   integrity sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==
@@ -5864,6 +5865,11 @@ prop-types@^15.8.1:
     object-assign "^4.1.1"
     react-is "^16.13.1"
 
+proxy-from-env@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2"
+  integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==
+
 psl@^1.1.28, psl@^1.1.33:
   version "1.9.0"
   resolved "https://registry.yarnpkg.com/psl/-/psl-1.9.0.tgz#d0df2a137f00794565fcaf3b2c00cd09f8d5a5a7"