tmcsplit 0.0.1 → 0.0.2

package/AUTHORS.rst

@@ -2,7 +2,7 @@
    SPDX-License-Identifier: AGPL-3.0-or-later
 
    ----------------------------------------------------------------------
-   Copyright © 2024, 2025  Pellegrino Prevete
+   Copyright © 2024, 2025, 2026  Pellegrino Prevete
 
    All rights reserved
    ----------------------------------------------------------------------

package/README.md

@@ -22,10 +22,18 @@
 
 # The Martian Company's Split (`tmcsplit`)
 
-Split and merge file in multiple parts.
+Javascript GNU Split rewrite.
+
 Splittable with number of parts or maximum bytes per part.
 
-It works both in Node.js and in web browsers.
+It works both in Node.js and in web browsers
+using the
+[Crash Javacript](
+  https://github.com/themartiancompany/crash-js)
+and
+[Split File](
+  https://github.com/themartiancompany/node-split-file)
+modules.
 
 ### Installation
 
@@ -36,197 +44,21 @@ with the following command:
 npm \
   install \
     --save \
-    @themartiancompany/split-file
-```
-
-### Usage
-
-All methods return a `Promise` (`bluebird`)
-which results in some respose if some.
-
-#### Splitting file with number of parts
-
-```javascript
-_split_file(
-  _input_file,
-  _output_dir?) => Promise<string[]>
-```
-
-**Consumes**:
-- `_input_file`:
-    Path to the file to split.
-- `_output_dir`:
-    Folder for output, defaults to `.` (current folder)
-
-**Produces**:
-- `Promise<string[]>`:
-    Promise with results in an array of part
-    names (full paths) of the splitted files.
-
-#### Example
-
-```javascript
-const
-  _split_file_module =
-    require(
-      'split-file');
-_split_file =
-  _split_file_module._split_file;
-const
-  _input_file =
-    __dirname +
-    '/testfile.bin';
-const
-  _parts_amount =
-    3;
-const
-  _error_callback =
-    function (
-      _error) {
-      const
-        _log =
-          console.log;
-      _log(
-        'Error: ',
-        _error);
-    };
-_split_file(
-  _input_file,
-  _parts_amount)
-  .then(
-    (_output_files) => {
-      console.log(
-        _output_files);
-    })
-  .catch(
-    _error_callback);
-```
-
-#### Splitting file with maximum bytes per part
-
-```javascript
-_split_file_by_size(
-  _input_file,
-  _size_max,
-  _output_dir?) => Promise<string[]>
-```
-
-**Consumes**:
-- `_input_file`:
-    Path to the file to split.
-- `_size_max`:
-    Max size of the splitted parts. (bytes)
-- `_output_dir`:
-    Folder for output, defaults to `.` (current folder)
-
-**Produces**:
-- `Promise<string[]>`:
-    Promise with results in an array of part
-    names (full paths) of the splitted files.
-
-##### Example
-
-```javascript
-const
-  _split_file_module =
-    require(
-      'split-file');
-_split_file_by_size =
-  _split_file_module._split_file_by_size;
-const
-  _input_file =
-    __dirname +
-    '/testfile.bin';
-_size_max =
-  457000;
-const
-  _error_callback =
-    function (
-      _error) {
-      const
-        _log =
-          console.log;
-      _log(
-        'Error: ',
-        _error);
-    };
-_split_file_by_size(
-  _input_file,
-  _size_max)
-  .then(
-    (_output_files) => {
-      console.log(
-        _output_files);
-    })
-  .catch(
-    _error_callback);
+    @themartiancompany/tmcsplit
 ```
 
-#### Merge parts
-
-```javascript
-_merge_files(
-  _input_files,
-  _output_file) => Promise<>
-```
-
-**Consumes**:
-- `_input_files`:
-    Input files, array with full part paths.
-- `_output_file`:
-    Full path of the output file.
-
-**Produces**:
-- `Promise<>`:
-    Promise that results in an empty resolving.
+You can then run the program with
 
-##### Example
-
-```javascript
-const
-  _split_file_module =
-    require(
-      'split-file');
-_merge_files =
-  _split_file_module._merge_files;
-const
-  _input_files = [
-    __dirname + '/file_a',
-    __dirname + '/file_b'
-  ];
-const
-  _output_file =
-    __dirname +
-    '/testfile-output.bin';
-const
-  _error_callback =
-    function (
-      _error) {
-      const
-        _log =
-          console.log;
-      _log(
-        'Error: ',
-        _error);
-    };
-_merge_files(
-  _input_files,
-  _output_file)
-  .then(
-    () => {
-      console.log(
-        'Done!');
-    })
-  .catch(
-    _error_callback);
+```bash
+npx \
+  "tmcsplit"
 ```
 
-## Command-line program
-
-### Installation
-
-To use the module from the command line you can install
-either use npm and install this package in your global context
+or just with `tmcsplit` if you install
+the program system-wide using npm from this source
+repository or from the
+[NPM Registry](
+  https://www.npmjs.com/package/tmcsplit)
 
 ```
 npm \
@@ -235,7 +67,7 @@ npm \
     "split-file"
 ```
 
-or just use GNU make
+or if using GNU make in this repository
 
 ```bash
 make \
@@ -245,61 +77,27 @@ make \
 **Note:** You may need admin rights (`sudo`,
 `su -c` or on Windows `Run as administrator`).
 
-### Usage
-
-The CLI tool works like you use it in your own package.
-
-The manual can be accessed with `man split-file`.
+or if you install it as a
+[DogeOS](
+  https://github.com/themartiancompany/dogeos)
+package from the
+[Ur](
+  https://github.com/themartiancompany/ur)
 
 ```bash
-split-file \
-  -h
-
-Usage:
-
-  split-file
-    <option>
-    [arguments]
-
-  options:
-
-     -s                          Split the input file in
-       <input>                   the given number of parts.
-       <num_parts>
+ur \
+  tmcsplit
+```
 
-     -x
-       <input>
-       <max_size>                Split the input file into
-                                 multiple parts with maximum
-                                 file size of max_size bytes.
+### Documentation
 
-     -m                          Merge the given parts into
-       <output>                  the output file.
-       <part>
-       <part> ...
-        
-  examples:
-  
-     split-file \
-       -s \
-       "input.bin" \
-       5
-  
-     split-file \
-       -x \
-       "input.bin" \
-       457000
-  
-     split-file \
-       -m \
-       "output.bin" \
-       "part1" "part2" ...
-```
+Upon installation the manual can be accessed with
+`man tmcsplit` but really it's the same as
+GNU Split, so you can also refer to `man split`
+for what is it implemented.
 
 # License
 
-Work authored by Tom Valk is released under the terms
-of the MIT license;
-work authored by Pellegrino Prevete is released
+This software by Pellegrino Prevete is released
 under the terms of the GNU Affero General Public License
 version 3.

package/eslint.config.mjs

@@ -1,38 +1,80 @@
-
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025
-//                Jiang Jie
-//    Copyright © 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 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/>.
+/**    ----------------------------------------------------------------------
+ *     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/>.
+ */
+
 
+import js from "@eslint/js";
+import globals from "globals";
 import { defineConfig } from "eslint/config";
 
+const
+  _project =
+    "tmcsplit";
+
 export default defineConfig([
- { ignores: [
+ {
+   ignores: [
+     "build/**",
+     "node_modules/**",
+     "eslint.config.js",
+     "man/**"
+   ],
+   rules:
+     { semi:
+         "error",
+       "prefer-const":
+         "error" },
+   files:
+     [ "**/*js,mjs,cjs}",
+       `**/${_project}*`,
+       `**/lib${_project}`
+     ],
+   plugins:
+     { js },
+   extends:
+     [ "js/recommended" ],
+   languageOptions:
+     { globals:
+         {  ...globals.browser,
+            ...globals.node } } },
+ { 
+   ignores: [
      "build/**",
-     "eslint.config.js"
+     "eslint.config.js",
+     "node_modules/**",
+     "man/**"
    ],
    rules:
      { semi:
          "error",
        "prefer-const":
-         "error" } },
+         "error" },
+   files:
+     [ "**/*.js",
+       `**/${_project}*`,
+       `**/lib${_project}`,
+     ],
+   languageOptions:
+     { sourceType:
+         "commonjs" } },
 ]);

package/fs-worker.js

@@ -0,0 +1 @@
+(()=>{var e={816(e,o,n){function t(){let e;return"undefined"==typeof window&&void 0!==n.g&&n.g.global===n.g&&"function"!=typeof n||(e=function(){let e;try{e=n(816)}catch(e){console.log(e);const o="Error importing the '@themartiancompany/opfs' module as 'opfs'. If you got this error while bundling a webpack for a project depending on this module double check its 'webpack.config.js' file or whether the 'opfs' module is listed in developer dependencies and install them.I'm sorry for this inconvenience but Node packagement system does not currently distinguish 'development' from 'build' dependencies.";throw console.error(o),e}return e}()),e}const r=t();e.exports=r,e.exports.getModule=function(e){let o;if(""==_module_name||"undefined"==typeof _module_name)o=t();else if("opfs"==_module_name)o=n(816);else{if("fs"!=_module_name){const e="Unknown file system module "+`'${_module_name}'.`.const;throw _error={msg:e},console.error(e),_error}o=n(816)}return o}},314(e,o,n){const t=n(816);_sync_agent=t.startSyncAgent,e.exports={_sync_agent},_sync_agent()}},o={};function n(t){var r=o[t];if(void 0!==r)return r.exports;var s=o[t]={exports:{}};return e[t](s,s.exports,n),s.exports}n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n(314)})();

package/fs-worker.webpack.config.cjs

@@ -11,7 +11,7 @@ const
     "fs-worker";
 const
   _input_file_path =
-    `./node_modules/fs/${_input_file_name}`;
+    `./node_modules/opfs/${_input_file_name}`;
 const
   _output_file_name =
     `${_input_file_name}.js`;

package/libtmcsplit

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+/**    ----------------------------------------------------------------------
+ *     libtmcsplit
+ *     ----------------------------------------------------------------------
+ *     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/>.
+ */
+
+/* eslint
+     no-unused-vars: [
+       "error",
+       { "vars":
+           "local" } ] */
+
+const
+  _split_file_module =
+    require(
+      'split-file');
+const
+  _split_file =
+    _split_file_module._split_file;
+const
+  _split_file_by_size =
+    _split_file_module._split_file_by_size;
+const
+  _libcrash =
+    require(
+      'crash-js');
+const
+  _msg_info =
+    _libcrash._msg_info;
+const
+  _msg_error =
+    _libcrash._msg_error;
+
+async function
+  _split(
+    _input_file,
+    _output_prefix,
+    _chunks_amount,
+    _size_max) {
+  let
+    _msg;
+  const
+    _chunks_amount_not_number =
+      isNaN(_chunks_amount);
+  if ( _chunks_amount_not_number ) {
+    _msg =
+      "Chunks amount must be a number.";
+    _msg_error(
+      _msg,
+      1);
+  }
+  _msg =
+    `Splitting '${_input_file}' ` +
+    `into '${_chunks_amount}' of size '${_size_max}' ` +
+    `into files with prefix '${_output_prefix}':`;
+  _msg_info(
+    _msg);
+  _size_max =
+    Number(
+      _size_max);
+  if ( _chunks_amount > 0 ) {
+    _split_file(
+      _input_file,
+      _chunks_amount);
+  }
+  else if ( _size_max > 0 ) {
+    await _split_file_by_size(
+      _input_file,
+      _size_max);
+  }
+}
+
+module.exports = {
+  _split:
+    _split
+};

package/libtmcsplit.webpack.config.cjs

@@ -1,3 +1,27 @@
+/**    ----------------------------------------------------------------------
+ *     libtmcsplit.webpack.config.cjs
+ *     ----------------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         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
   _path =
     require(
@@ -22,6 +46,45 @@ const
     filename:
       _output_file_name
 };
+const
+  _utils_ignore =
+  { resourceRegExp:
+      /^utils$/ };
+const
+  _web_worker_ignore =
+  { resourceRegExp:
+      /^web-worker$/ };
+const
+  _yargs_ignore =
+  { resourceRegExp:
+      /^yargs$/ };
+const
+  _yargs_helpers_ignore =
+  { resourceRegExp:
+      /^yargs\/helpers$/ };
+const
+  _webpack =
+    require(
+     "webpack");
+const
+  _ignore_plugin =
+    _webpack.IgnorePlugin; 
+const
+  _utils_ignore_plugin =
+    new _ignore_plugin(
+          _utils_ignore);
+const
+  _web_worker_ignore_plugin =
+    new _ignore_plugin(
+          _web_worker_ignore);
+const
+  _yargs_ignore_plugin =
+    new _ignore_plugin(
+          _yargs_ignore);
+const
+  _yargs_helpers_ignore_plugin =
+    new _ignore_plugin(
+          _yargs_helpers_ignore);
 module.exports = {
   entry:
     _input_file_path,
@@ -40,6 +103,39 @@ module.exports = {
         _path.resolve(
           __dirname,
           'node_modules/path/mod.js'),
+      "web-worker":
+        _path.resolve(
+          __dirname,
+          'node_modules/web-worker/mod.js'),
+      "yargs":
+        _path.resolve(
+          __dirname,
+          'node_modules/yargs/browser.mjs'),
+      "yargs/helpers":
+        _path.resolve(
+          __dirname,
+          'node_modules/yargs/helpers/helpers.mjs'),
+      "yargs-parser":
+        _path.resolve(
+          __dirname,
+          'node_modules/yargs-parser/browser.mjs'),
     },
+    fallback: {
+      "utils":
+        false,
+      "web-worker":
+        false,
+      "yargs":
+        false,
+      "yargs/helpers":
+        false,
+    }
   },
+  externals:
+    { yargs:
+        'yargs' },
+  plugins: [
+    _yargs_ignore_plugin,
+    _yargs_helpers_ignore_plugin
+  ]
 };