encoding-tools 0.0.1 → 0.0.4

package/README.md

@@ -0,0 +1,85 @@
+[comment]: <> (SPDX-License-Identifier: AGPL-3.0)
+
+[comment]: <> (------------------------------------------------------)
+[comment]: <> (Copyright © 2024, 2025, 2026  Pellegrino Prevete)
+[comment]: <> (All rights reserved)
+[comment]: <> (------------------------------------------------------)
+
+[comment]: <> (This program is free software: you can redistribute)
+[comment]: <> (it and/or modify it under the terms of the GNU Affero)
+[comment]: <> (General Public License as published by the Free)
+[comment]: <> (Software Foundation, either version 3 of the License.)
+
+[comment]: <> (This program is distributed in the hope that it will be)
+[comment]: <> (useful, but WITHOUT ANY WARRANTY; without even the)
+[comment]: <> (implied warranty of MERCHANTABILITY or FITNESS FOR)
+[comment]: <> (A PARTICULAR PURPOSE. See the)
+[comment]: <> (See the GNU Affero General Public License for)
+[comment]: <> (more details.)
+
+[comment]: <> (You should have received a copy of the GNU Affero)
+[comment]: <> (General Public License along with this program.)
+[comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
+
+# Encoding Tools (`encoding-tools.js`)
+
+Simple, easy to read and use collection of Javascript
+encoding tools.
+
+This collection is the Javascript programming
+language implementation of
+[Encoding Tools](
+  https://github.com/themartiancompany/encoding-tools),
+in which it is included.
+
+The tools are a dependency for the
+[Ethereum Virtual Machine File System](
+  https://github.com/themartiancompany/evmfs)
+and for the uncensorable Twitter.
+
+They depend on the `base64` encoding tool
+and the
+[Crash Javascript](
+  https://github.com/themartiancompany/crash-js)
+library.
+
+## Installation
+
+The tools in this source repo
+can be installed from source using GNU Make.
+
+```bash
+make \
+  install
+```
+
+The collection has been officially published
+on the the uncensorable
+[Ur](
+  https://github.com/themartiancompany/ur)
+user repository and application store as
+`encoding-tools`.
+The source code is published on the
+[Ethereum Virtual Machine File System](
+  https://github.com/themartiancompany/evmfs)
+so it can't possibly be taken down.
+
+To install it from there just type
+
+```bash
+ur \
+  encoding-tools
+```
+
+A censorable HTTP Github mirror of the recipe published there,
+containing a full list of the software dependencies needed to run the
+tools is hosted on
+[encoding-tools-ur](
+  https://github.com/themartiancompany/encoding-tools-ur).
+Be aware the mirror could go offline any time as Github and more
+in general all HTTP resources are inherently unstable and censorable.
+
+## License
+
+This program is released by Pellegrino Prevete under the terms
+of the GNU Affero General Public License version 3.

package/bin2txt

@@ -2,63 +2,117 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025  Pellegrino Prevete
-//
-//    All rights reserved
-//    ----------------------------------------------------------------------
-//
-//    This program is free software: you can redistribute it and/or modify
-//    it under the terms of the GNU Affero General Public License as published by
-//    the Free Software Foundation, either version 3 of the License, or
-//    (at your option) any later version.
-//
-//    This program is distributed in the hope that it will be useful,
-//    but WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//    GNU Affero General Public License for more details.
-//
-//    You should have received a copy of the GNU Affero General Public License
-//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+/**    ----------------------------------------------------------------
+ *     bin2txt
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         2024, 2025, 2026
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or
+ *     modify it under the terms of the GNU General Public License as
+ *     published by the Free Software Foundation, either version 3 of
+ *     the License, or (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.
+ *     If not, see <https://www.gnu.org/licenses/>.
+ */
 
 const
   _libcrash =
   require(
     'crash-js');
-_cmdline_check =
-  _libcrash._cmdline_check;
-_msg_info =
-  _libcrash._msg_info;
-_msg_error =
-  _libcrash._msg_error;
+/* global
+     _cmdline_check */
+const
+  _cmdline_check =
+    _libcrash._cmdline_check;
+/* global
+     _msg_info */
+const
+  _msg_info =
+    _libcrash._msg_info;
+/* global
+     _msg_error */
+const
+  _msg_error =
+    _libcrash._msg_error;
+/* global
+     _argv_get */
+const
+_argv_get =
+  _libcrash._argv_get;
+
 const
   _encoding_tools =
     require(
       "./encoding-tools");
+/* global
+     _bin2txt */
 _bin2txt =
   _encoding_tools._bin2txt;
 
 function
   _global_variables() {
+  /* global
+       app_name:
+         writable */
   app_name =
     "bin2txt";
+  /* global
+       app_opts:
+         writable */
+  app_opts =
+    [];
+  /* global
+       encoding_format:
+         writable */
   encoding_format =
     "";
+  /* global
+       buffer_size:
+         writable */
   buffer_size =
     "";
+  /* global
+       string_length:
+         writable */
   string_length =
     "";
+  /* global
+       in_file:
+         writable */
   in_file =
     "";
+  /* global
+       out_txt_prefix:
+         writable */
   out_txt_prefix =
     "";
+  /* global
+       amount_only:
+         writable */
+  amount_only =
+    "";
+  /* global
+       quiet:
+         writable */
   quiet =
     "";
 }
 
 function 
   _overrides_set() {
-  if ( target_message == "" ) {
+  if ( encoding_format == "" ) {
     encoding_format =
       "base64";
   }
@@ -137,7 +191,7 @@ function
     "     -v --verbose                    Enable verbose output."
   ];
   for ( _line of _text ) {
-    _msg_info(
+    console.log(
       _line);
   }
   process.exit(
@@ -148,25 +202,33 @@ function
   _cmdline_parse() {
   let
     _argv,
+    _help_display,
     _msg;
   _argv =
-    _yargv_get();
+    _argv_get();
+  _options =
+    _argv[
+      "_"];
   quiet = 
     "y";
   runtime_environment =
     "node";
-  help_display =
-    _argv[
-      "help"] ||
-    _argv[
-      "h"];
-  if ( help_display ) {
+  if ( _options.indexOf(
+         "--help") > -1 ||
+       _options.indexOf(
+         "-h") > -1) {
+    _help_display =
+      true;
+  }
+  if ( _help_display ) {
     quiet =
       "n";
     _usage(
       0);
   }
-  if ( _argv[
+  if ( typeof(
+         _argv) == "undefined" ||
+       _argv[
          "_"].length < 1 ) {
     _msg =
       "Input file argument required.";
@@ -183,7 +245,8 @@ function
   if ( _argv[
          "_"].length < 2 ) {
     out_txt_prefix =
-      in_file + ".base64"
+      in_file +
+      ".base64";
   }
   if ( "s" in _argv ) {
     string_length =
@@ -238,16 +301,18 @@ function
 
 _global_variables();
 if ( _cmdline_check(
-       "bin2txt") == true ) {
+       "bin2txt.js") == true ) {
   _cmdline_parse();
 }
-else {
-  _url_parse();
-}
+_overrides_set();
 _config_show();
 app_opts = [
   in_file,
-  out_txt_prefix
+  out_txt_prefix,
+  encoding_format,  
+  string_length,
+  buffer_size,
+  amount_only 
 ];
 _bin2txt.apply(
   null,