This module (unsquish) is an application that extracts Fidonet messages from Squish message bases and saves them in JAM.
This application is written in JavaScript (ECMAScript 6) and requires Node.js version 4.0.0 or newer.
The application is currently in an early phase of its development and thus does not have the desired level of feature completeness.
Installing the application
Installing as a global application
-
Latest packaged version:
npm install -g unsquish -
Latest githubbed version:
npm install -g https://github.com/Mithgol/node-unsquish/tarball/master
The application becomes installed globally and appears in the PATH. Then use unsquish command to run the application.
Installing as a portable application
Instead of the above, download the ZIP-packed source code of the application and unpack it to some directory. Then run npm install --production in that directory.
You may now move that directory (for example, on a flash drive) across systems as long as they have the required version of Node.js installed.
Unlike the above (npm -g), the application does not appear in the PATH, and thus you'll have to run it directly from the application's directory. You'll also have to use node unsquish [parameters] instead of unsquish [parameters].
Testing the application
It is necessary to install JSHint for testing.
- You may install JSHint globally (
npm install jshint -g) or locally (npm install jshintin the directory of unsquish).
After that you may run npm test (in the directory of unsquish). Only the JS code errors are caught; the code's behaviour is not tested.
License
MIT license (see the LICENSE file).