Add simple dever json validation

.gitignore

@@ -1,2 +1,3 @@
 /node_modules
-.idea/
+.idea/
+/bin/dever_config.json

README.md

@@ -67,6 +67,8 @@ Or you could also check the list of commands below in the [Available Commands](#
 | dever list --not-supported | Lists all found not supported projects |
 | dever config | Show content of dever_config.json |
 | dever config --location, -l | Show location of dever_config.json |
+| dever validate | Validate any dever.json which is at the same location as the console |
+| dever validate -f, --file | Validate any dever.json using a filepath |
 | dever [keyword] install | Installs all available packages for specified project keyword if available or shows help |
 | dever [keyword] install -l, --list | List all options under install section in the projects dever.json |
 | dever [keyword] install -lgs, --list-groups | List of all installation groups under install section in the projects dever.json |

bin/common/constants.js

@@ -0,0 +1,4 @@
+module.exports = new class {
+    predefinedKeys = ['init', 'list', 'config', 'validate'];
+    notAllowedKeywords = ['init', 'list', 'config', 'validate', '--help', '--version'];
+}

bin/common/default-yargs-generator.js

@@ -1,7 +1,9 @@
 const config_handler = require("../configuration/handleConfigFile");
-const components_handler = require("../configuration/handleComponents");
+const projectsConfig = require("../configuration/projects-config");
 const versionChecker = require('../common/helper/version-checker');
+const configValidator = require('../common/helper/config-validator');
 
+const path = require("path");
 const init = require("../init");
 const chalk = require("chalk");
 
@@ -57,7 +59,31 @@ module.exports = new class {
                         default:
                             this.#showConfig();
                     }
-
+                }
+            })
+            .command({
+                command: 'validate',
+                desc: `Validate dever.json config file before running 'dever init'`,
+                builder: (yargs) => {
+                    yargs
+                        .option('f', {
+                            alias: 'file',
+                            describe: 'Filepath for dever.json that needs to be validated'
+                        });
+                },
+                handler: (argv) => {
+                    switch (true) {
+                        case argv.file != null:
+                        {
+                            this.#validate(argv.file);
+                            break;
+                        }
+                        default:
+                        {
+                            const file = path.join(process.cwd(), 'dever.json');
+                            this.#validate(file);
+                        }
+                    }
                 }
             })
             .command({
@@ -80,7 +106,7 @@ module.exports = new class {
      * Shows a list of found components in the console
      */
     #listAllComponents() {
-        const projects = components_handler.getAllComponents();
+        const projects = projectsConfig.getAll();
         if (projects == null || projects.length === 0) {
             console.error(`Could not find any projects. Please try running ${chalk.green('dever init')}`);
             return;
@@ -94,7 +120,7 @@ module.exports = new class {
     }
 
     #listAllUnsupportedProjects() {
-        const projects = components_handler.getAllComponents();
+        const projects = projectsConfig.getAll();
         if (projects == null || projects.length === 0) {
             console.error(`Could not find any projects. Please try running ${chalk.green('dever init')}`);
             return;
@@ -127,12 +153,21 @@ module.exports = new class {
      */
     #showConfig() {
         const config = config_handler.get();
-
         if (config == null) {
             console.error(chalk.redBright('Could not find dever configuration'));
             return;
         }
 
         console.log(config);
     }
+
+    #validate(file) {
+        const result = configValidator.validateFile(file);
+        if (!result.status) {
+            console.error(chalk.redBright(result.message));
+            return;
+        }
+
+        console.log('No problems with dever.json');
+    }
 }

bin/common/helper/config-validator.js

@@ -0,0 +1,80 @@
+const constants = require('../constants');
+const fs = require("fs");
+
+module.exports = new class {
+    /**
+     * Validate configuration
+     * @param config {Config}
+     * @return {boolean}
+     */
+    validate(config) {
+        return config.keywords.every(x => !constants.predefinedKeys.includes(x.toLowerCase()));
+    }
+
+    /**
+     * Validate json
+     * @param json {string}
+     */
+    validateJson(json) {
+        // Todo: Missing implementation
+    }
+
+    /**
+     * Validate json file
+     * @param file {string}
+     * @return {ConfigValidation}
+     */
+    validateFile(file) {
+        try {
+            const config = this.#getJson(file);
+            if (this.validate(config)) {
+                return {status: true};
+            }
+
+            return {status: false, message: `One or more keywords are conflicting with the pre-defined keys. ('${constants.predefinedKeys.join("','")}')` };
+        } catch (e) {
+            switch(e.code) {
+                case "ENOENT":
+                case "EISDIR":
+                    return {status: false, message: `Could not find '${file}'. Please check if file path is correct.`};
+                default:
+                    return {status: false, message: "Something went wrong. Most likely due to JSON being wrongly formatted!"};
+            }
+        }
+    }
+
+    /**
+     * Get json from file
+     * @param file {string}
+     * @returns {Config}
+     */
+    #getJson(file) {
+        const content = fs.readFileSync(file);
+        return this.#convertToJson(content);
+    }
+
+    /**
+     *
+     * @param content {null|Buffer}
+     * @return {Config}
+     */
+    #convertToJson(content) {
+        try {
+            return JSON.parse(content);
+        } catch (e) {
+            throw e;
+        }
+    }
+}
+
+class ConfigValidation {
+    /**
+     * @return {boolean}
+     */
+    status;
+
+    /**
+     * @return {string}
+     */
+    message;
+}

bin/configuration/handleConfigFile.js

@@ -3,13 +3,13 @@ const fs = require("fs");
 const chalk = require('chalk');
 
 module.exports = new class {
-    #fileName = 'dever_config.json';
+    #fileName = '.dever';
 
     #root;
     #filePath;
 
     constructor() {
-        this.#root = path.join(path.dirname(fs.realpathSync(__filename)), '../');
+        this.#root = require('os').homedir();
         this.#filePath = path.join(this.#root, this.#fileName);
     }
 
@@ -45,9 +45,8 @@ module.exports = new class {
      */
     get() {
         const config = this.#readJson(this.#filePath);
-
         if (config == null) {
-            throw 'Could not find configuration';
+            return null;
         }
 
         return config;
@@ -89,7 +88,6 @@ module.exports = new class {
         } catch (e) {
             switch (e.code) {
                 case "ENOENT":
-                    console.error(`Could not find '${filePath}' please run 'dever init' again.`);
                     return null;
                 default:
                     console.error(chalk.redBright(`Could not parse '${filePath}' due to json formatting.`));