Introduce the CLI mode

Author: elszczepano

README.md

@@ -106,6 +106,26 @@ import customFileSystem from './some-destination';
 
 const mfr: MFR = new MFR( [], customFileSystem );
 ```
+## CLI
+
+MFR supports also CLI version. To run mfr in the CLI mode install it first using `npm install -g mfr`.
+Then you will be able to run MFR via the `mfr` command:
+
+```
+Usage: -m <mode> -s <source> -d <destination>
+
+Options:
+      --help            Show help                                      [boolean]
+      --version         Show version number                            [boolean]
+  -m, --mode            Application mode                     [string] [required]
+  -s, --source          Source path                          [string] [required]
+  -d, --destination     Destiatnion path                     [string] [required]
+  -f, --formats         Handled formats                                  [array]
+  -p, --pattern         Pattern                                         [string]
+  -a, --appendix        Appendix                                        [string]
+      --pre, --prefix   Prefix pattern                                  [string]
+      --pos, --postfix  Prefix patern                                   [string]
+```
 
 ---
 

package.json

@@ -14,21 +14,28 @@
     "lint:fix": "npm run lint -- --fix",
     "test": "nyc ava"
   },
+  "bin": {
+    "mfr": "./dist/bin/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git@github.com:elszczepano/mfr.git"
   },
   "author": "Dominik Szczepaniak",
   "license": "MIT",
   "dependencies": {
-    "uuid": "8.3.2"
+    "chalk": "4.1.0",
+    "uuid": "8.3.2",
+    "yargs": "16.2.0"
   },
   "devDependencies": {
     "@cksource-cs/eslint-config-cs-module": "^2.1.2",
+    "@types/chalk": "2.2.0",
     "@types/node": "12.12.6",
     "@types/rimraf": "3.0.0",
     "@types/sinon": "9.0.10",
     "@types/uuid": "8.3.0",
+    "@types/yargs": "16.0.0",
     "ava": "3.15.0",
     "eslint": "6.6.0",
     "eslint-import-resolver-node": "0.3.4",

src/bin/index.ts

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+/*
+* Copyright © 2021 Dominik Szczepaniak, MIT License.
+*/
+
+import chalk from 'chalk';
+import yargs from 'yargs';
+
+import MFR from '../Engine';
+
+interface IOptions extends Record<string, unknown> {
+	mode: string;
+	source: string;
+	destination: string;
+	formats?: string[];
+	pattern?: string;
+	appendix?: 'prefix' | 'postfix' | 'all' | 'none';
+	prefix?: string;
+	postfix?: string;
+}
+
+// @ts-ignore - issue with typings
+const options: IOptions = yargs
+	.usage( 'Usage: -m <mode> -s <source> -d <destination>' )
+	.option( 'm', { alias: 'mode', describe: 'Application mode', type: 'string', demandOption: true } )
+	.option( 's', { alias: 'source', describe: 'Source path', type: 'string', demandOption: true } )
+	.option( 'd', { alias: 'destination', describe: 'Destiatnion path', type: 'string', demandOption: true } )
+	.option( 'f', { alias: 'formats', describe: 'Handled formats', type: 'array' } )
+	.option( 'p', { alias: 'pattern', describe: 'Pattern', type: 'string' } )
+	.option( 'a', { alias: 'appendix', describe: 'Appendix', type: 'string' } )
+	.option( 'pre', { alias: 'prefix', describe: 'Prefix pattern', type: 'string' } )
+	.option( 'pos', { alias: 'postfix', describe: 'Prefix patern', type: 'string' } )
+	.argv;
+
+( async function() {
+	try {
+		const mfr: MFR = new MFR();
+
+		const { mode, source, destination, formats, pattern, appendix, prefix, postfix } = options;
+
+		await mfr.run( {
+			mode,
+			sourcePath: source,
+			destinationPath: destination,
+			formats,
+			pattern,
+			appendix,
+			prefixPattern: prefix,
+			postfixPattern: postfix
+		} );
+
+		chalk.green.bold( 'Done!' );
+	} catch ( error ) {
+		chalk.red.bold( 'Rename operation failed. An unexpected error occurred!', error );
+	}
+}() );