tmcsplit 0.0.1

package/README.md

@@ -0,0 +1,305 @@
+[comment]: <> (SPDX-License-Identifier: AGPL-3.0)
+
+[comment]: <> (-------------------------------------------------------------)
+[comment]: <> (Copyright © 2024, 2025)
+[comment]: <> (            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 useful,)
+[comment]: <> (but WITHOUT ANY WARRANTY; without even the implied warranty of)
+[comment]: <> (MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the)
+[comment]: <> (GNU Affero General Public License for more details.)
+
+[comment]: <> (You should have received a copy of the GNU Affero General)
+[comment]: <> (Public License along with this program.)
+[comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
+
+
+# The Martian Company's Split (`tmcsplit`)
+
+Split and merge file in multiple parts.
+Splittable with number of parts or maximum bytes per part.
+
+It works both in Node.js and in web browsers.
+
+### Installation
+
+You can install and save an entry to your `package.json`
+with the following command:
+
+```bash
+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);
+```
+
+#### 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.
+
+##### 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);
+```
+
+## 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
+
+```
+npm \
+  -g \
+  install \
+    "split-file"
+```
+
+or just use GNU make
+
+```bash
+make \
+  install
+```
+
+**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`.
+
+```bash
+split-file \
+  -h
+
+Usage:
+
+  split-file
+    <option>
+    [arguments]
+
+  options:
+
+     -s                          Split the input file in
+       <input>                   the given number of parts.
+       <num_parts>
+
+     -x
+       <input>
+       <max_size>                Split the input file into
+                                 multiple parts with maximum
+                                 file size of max_size bytes.
+
+     -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" ...
+```
+
+# License
+
+Work authored by Tom Valk is released under the terms
+of the MIT license;
+work authored by Pellegrino Prevete is released
+under the terms of the GNU Affero General Public License
+version 3.

package/eslint.config.mjs

@@ -0,0 +1,38 @@
+
+// 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/>.
+
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+ { ignores: [
+     "build/**",
+     "eslint.config.js"
+   ],
+   rules:
+     { semi:
+         "error",
+       "prefer-const":
+         "error" } },
+]);

package/fs-worker.webpack.config.cjs

@@ -0,0 +1,48 @@
+const
+  _path =
+    require(
+      'path');
+const
+  _output_dir =
+    _path.resolve(
+      __dirname);
+const
+  _input_file_name =
+    "fs-worker";
+const
+  _input_file_path =
+    `./node_modules/fs/${_input_file_name}`;
+const
+  _output_file_name =
+    `${_input_file_name}.js`;
+_output = {
+  path:
+    _output_dir,
+  filename:
+    _output_file_name
+};
+module.exports = {
+  entry:
+    _input_file_path,
+  output:
+    _output,
+  optimization: {
+    moduleIds: 'deterministic',
+  },
+  resolve: {
+    alias: {
+      "fs":
+        _path.resolve(
+          __dirname,
+          'node_modules/fs/fs'),
+      "opfs":
+        _path.resolve(
+          __dirname,
+          'node_modules/fs/fs'),
+      "path":
+        _path.resolve(
+          __dirname,
+          'node_modules/path/mod.js'),
+    },
+  }
+};

package/libtmcsplit.webpack.config.cjs

@@ -0,0 +1,45 @@
+const
+  _path =
+    require(
+      'path');
+const
+  _output_dir =
+    _path.resolve(
+      __dirname);
+const
+  _input_file_name =
+    `libtmcsplit`;
+const
+  _input_file_path =
+    `./${_input_file_name}`;
+const
+  _output_file_name =
+    `${_input_file_name}.js`;
+const
+  _output = {
+    path:
+      _output_dir,
+    filename:
+      _output_file_name
+};
+module.exports = {
+  entry:
+    _input_file_path,
+  output:
+    _output,
+  optimization: {
+    moduleIds: 'deterministic',
+  },
+  resolve: {
+    alias: {
+      "fs":
+        _path.resolve(
+          __dirname,
+          'node_modules/fs/fs'),
+      "path":
+        _path.resolve(
+          __dirname,
+          'node_modules/path/mod.js'),
+    },
+  },
+};

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name":
+    "tmcsplit",
+  "version":
+    "0.0.1",
+  "description":
+    "Basic Javascript implementation of GNU Split.",
+  "funding": {
+    "type":
+      "patreon",
+    "url":
+      "https://patreon.com/tallero"
+  },
+  "man":
+    "./man/tmcsplit.1",
+  "files": [
+    "AUTHORS.rst",
+    "COPYING",
+    "README.md",
+    "eslint.config.mjs",
+    "package.json",
+    "tmcsplit.js",
+    "tmcsplit",
+    "fs-worker.js",
+    "fs-worker.webpack.config.cjs",
+    "index.html",
+    "serve.json",
+    "libtmcsplit.webpack.config.cjs",
+    "webpack.config.cjs"
+  ],
+  "keywords": [
+    "ur",
+    "themartiancompany",
+    "dogeos"
+  ],
+  "homepage":
+    "https://github.com/themartiancompany/tmcsplit",
+  "bugs": {
+    "url":
+      "https://github.com/themartiancompany/tmcsplit/issues"
+  },
+  "repository": {
+    "type":
+      "git",
+    "url":
+      "git+https://github.com/themartiancompany/tmcsplit.git"
+  },
+  "license":
+    "AGPL-3.0-or-later",
+  "author": {
+    "name":
+      "Pellegrino Prevete",
+    "email":
+      "pellegrinoprevete@gmail.com",
+    "url":
+      "https://github.com/tallero"
+  },
+  "devDependencies": {
+    "crash-js-webpack":
+      "^0.0.2",
+    "eslint":
+      "^9.32.0",
+    "serve":
+      "^14.2.5",
+    "webpack":
+      "^5.102.1",
+    "webpack-cli":
+      "^6.0.1"
+  },
+  "dependencies": {
+    "crash-js":
+      "^0.1.66",
+    "split-file":
+      "npm:@themartiancompany/split-file@2.3.2"
+  },
+  "type":
+    "commonjs",
+  "main":
+    "tmcsplit",
+  "scripts": {
+    "build-fs-worker":
+      "npx webpack --mode 'production' --config 'fs-worker.webpack.config.cjs' --stats-error-details",
+    "build-lib":
+      "npx webpack --mode 'production' --config 'libtmcsplit.webpack.config.cjs' --stats-error-details",
+    "build-bin":
+      "npx webpack --mode 'production' --config 'webpack.config.cjs' --stats-error-details",
+    "build":
+      "npm run lint && npm run build-fs-worker && npm run build-lib && npm run build-bin",
+    "lint":
+      "npx eslint .",
+    "publish-pnm":
+      "npm run build && npm publish --access public",
+    "start":
+      "serve -c 'serve.json'",
+    "test":
+      "echo \"Error: no test specified\" && exit 1"
+  }
+}