mockapi-msi 1.0.1 → 1.1.0

package/README.md

@@ -92,4 +92,18 @@ log: verbose
   #error <- Only exposes internal errors
   #verbose <- Logs debug, information and errors
   #none <- Turn off the logs
-```
+```
+
+## MockAPI CLI
+
+MockAPI provides a small but helpful CLI. Type ```mockapi --help``` to get the available commands from the CLI once MockAPI is installed.
+
+#### The ```init``` command
+
+Once MockAPI is globally installed, you will need a configuration file with minimal information to be able of start mocking the API. The ```init``` command argument will lead you through different basic questions helping you to initialize this configuration file.
+
+```powershell
+mockapi --init
+```
+
+You can skip every question which will assign some default values to the configuration file. Later you could change these values using any text editor.

package/main.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 'use strict';
 
@@ -9,9 +9,17 @@ const constants = require('./modules/constants');
 const readers = require('./modules/readers');
 const parser = require('./modules/urlParser');
 const handlerInjector = require('./modules/configurationParser');
-const ModuleProxy = require('./modules/moduleProxy')
-
+const ModuleProxy = require('./modules/moduleProxy');
+const CLI = require('./modules/cli');
 const rootPath = __dirname;
+
+const cli = new CLI(`${rootPath}/${constants.CONFIG_FILE_NAME}`);
+
+if (cli.hasCommands()) {
+    cli.executeCommandLine();
+    return false;
+}
+
 const configFile = readers.text_reader(`${rootPath}/${constants.CONFIG_FILE_NAME}`);
 const parsedConfiguration = YAML.parse(configFile());
 

package/modules/cli.js

@@ -0,0 +1,107 @@
+const readline = require('readline');
+const YAML = require('yaml');
+const fs = require('fs');
+
+class CLI {
+
+    _configurationFilePath = "";
+    _arguments = [];
+    _commands = {
+        "--help": this._helpCommand,
+        "help": this._helpCommand,
+        "init": this._initCommand,
+        "--init": this._initCommand
+    };
+    _configTemplate = {
+        port: 8080,
+        enableCors: true,
+        data: {
+          myRows: { path: 'YOUR FOLDER', reader: 'folder' }
+        },
+        endpoints: {
+          '/data': {
+            verb: 'get',
+            data: 'myRows',
+            responseStatus: 200,
+            responseContentType: 'application/json'
+          }
+        },
+        log: 'verbose'
+    };
+
+    constructor(configurationFilePath) {
+        this._configurationFilePath = configurationFilePath;
+        this._arguments = process.argv.slice(2);
+    }
+
+    _initCommand() {
+        let configTemplate = this._configTemplate;
+
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+
+        console.log("Creating a basic configuration file");
+        console.log("");
+
+        rl.question(`Set MockAPI listening port (8080): `, (port) => {
+            rl.question(`Do you want to enable CORS? Y/n: `, (enableCors) => {
+                rl.question(`Do you want to include default endpoint? Y/n: `, (defaultEndpoint) => {
+                    const configPort = port || 8080;
+                    const configEnableCors = enableCors === "Y" || enableCors === "y" || enableCors === "";
+                    const configDefaultEndpoint = defaultEndpoint === "Y" || defaultEndpoint === "y" || defaultEndpoint === "";
+
+                    configTemplate.port = configPort;
+                    configTemplate.enableCors = configEnableCors;
+
+                    if (configDefaultEndpoint === false) {
+                        delete configTemplate.endpoints;
+                        delete configTemplate.data;
+                    }
+
+                    const configFile = YAML.stringify(configTemplate);
+
+                    fs.writeFile(this._configurationFilePath, configFile, (err) => {
+                        if (err) {
+                            console.log(err);
+                        } else {
+                            console.log("Configuration file created");
+                        }
+                    });
+                    
+                    rl.close();
+                });
+            });        
+        });
+
+    }
+
+    _helpCommand() {
+        console.log("Run MockAPI:");
+        console.log("mockapi\n");
+        console.log("Command execution:\n");
+        console.log("mockapi <command>");
+        console.log("");
+        console.log("--help, help    shows this help");
+        console.log("--init, init    creates a basic configuration file");
+        console.log("");
+    }
+
+    hasCommands() { return this._arguments.length > 0; }
+
+    executeCommandLine() {
+        if (this._arguments.length > 0) {
+
+            let command = this._commands["--help"];
+
+            if (this._commands[this._arguments[0]] !== undefined) {
+                command = this._commands[this._arguments[0]];
+            }
+
+            command.apply(this);
+        }
+    }
+}
+
+module.exports = CLI;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "mockapi-msi",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Mock API is a lightweight configurable HTTP API for testing and prototyping.",
   "main": "main.js",
   "scripts": {
+    "start": "node ./main.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "Matias Iacono",
@@ -11,6 +12,9 @@
   "bin": {
     "mockapi": "main.js"
   },
+  "engines": {
+    "node": ">=16"
+  },
   "dependencies": {
     "yaml": "2.0.0-5"
   }