neo.mjs 4.0.49 → 4.0.50

package/buildScripts/createClass.mjs

@@ -0,0 +1,191 @@
+import chalk       from 'chalk';
+import { Command } from 'commander/esm.mjs';
+import envinfo     from 'envinfo';
+import fs          from 'fs-extra';
+import inquirer    from 'inquirer';
+import os          from 'os';
+import path        from 'path';
+
+const __dirname   = path.resolve(),
+      cwd         = process.cwd(),
+      requireJson = path => JSON.parse(fs.readFileSync((path))),
+      packageJson = requireJson(path.join(__dirname, 'package.json')),
+      insideNeo   = packageJson.name === 'neo.mjs',
+      program     = new Command(),
+      programName = `${packageJson.name} create-class`,
+      questions   = [];
+
+program
+    .name(programName)
+    .version(packageJson.version)
+    .option('-i, --info',              'print environment debug info')
+    .option('-b, --baseClass <value>')
+    .option('-c, --className <value>')
+    .allowUnknownOption()
+    .on('--help', () => {
+        console.log('\nIn case you have any issues, please create a ticket here:');
+        console.log(chalk.cyan(process.env.npm_package_bugs_url));
+    })
+    .parse(process.argv);
+
+const programOpts = program.opts();
+
+if (programOpts.info) {
+    console.log(chalk.bold('\nEnvironment Info:'));
+    console.log(`\n  current version of ${packageJson.name}: ${packageJson.version}`);
+    console.log(`  running from ${__dirname}`);
+
+    envinfo
+        .run({
+            System     : ['OS', 'CPU'],
+            Binaries   : ['Node', 'npm', 'Yarn'],
+            Browsers   : ['Chrome', 'Edge', 'Firefox', 'Safari'],
+            npmPackages: ['neo.mjs']
+        }, {
+            duplicates  : true,
+            showNotFound: true
+        })
+        .then(console.log);
+} else {
+    console.log(chalk.green(programName));
+
+    if (!programOpts.className) {
+        questions.push({
+            type   : 'input',
+            name   : 'className',
+            message: 'Please choose the namespace for your class:',
+            default: 'Covid.view.FooContainer'
+        });
+    }
+
+    if (!programOpts.baseClass) {
+        questions.push({
+            type   : 'list',
+            name   : 'baseClass',
+            message: 'Please pick the base class, which you want to extend:',
+            choices: ['component.Base', 'container.Base'],
+            default: 'component.Base'
+        });
+    }
+
+    inquirer.prompt(questions).then(answers => {
+        let baseClass = programOpts.baseClass || answers.baseClass,
+            className = programOpts.className || answers.className,
+            startDate = new Date(),
+            classFolder, file, folderDelta, ns, root, rootLowerCase;
+
+        if (className.endsWith('.mjs')) {
+            className = className.slice(0, -4);
+        }
+
+        ns            = className.split('.');
+        file          = ns.pop();
+        root          = ns.shift();
+        rootLowerCase = root.toLowerCase();
+
+        if (root === 'Neo') {
+            console.log('todo: create the file inside the src folder');
+        } else {
+            if (fs.existsSync(path.resolve(cwd, 'apps', rootLowerCase))) {
+                classFolder = path.resolve(cwd, 'apps', rootLowerCase, ns.join('/'));
+                folderDelta = ns.length + 2;
+
+                fs.mkdirpSync(classFolder);
+
+                fs.writeFileSync(path.join(classFolder, file + '.mjs'), createContent({baseClass, className, file, folderDelta, ns, root}));
+            } else {
+                console.log('\nNon existing neo app name:', chalk.red(root));
+                process.exit(1);
+            }
+        }
+
+        const processTime = (Math.round((new Date - startDate) * 100) / 100000).toFixed(2);
+        console.log(`\nTotal time for ${programName}: ${processTime}s`);
+
+        process.exit();
+    });
+
+    /**
+     * Adds a comma to the last element of the contentArray
+     * @param {String[]} contentArray
+     */
+    function addComma(contentArray) {
+        contentArray[contentArray.length - 1] += ',';
+    }
+
+    /**
+     * Creates the content of the neo-class .mjs file
+     * @param {Object} opts
+     * @param {String} opts.baseClass
+     * @param {String} opts.className
+     * @param {String} opts.file
+     * @param {String} opts.folderDelta
+     * @param {String} opts.ns
+     * @param {String} opts.root
+     * @returns {String}
+     */
+    function createContent(opts) {
+        let baseClass     = opts.baseClass,
+            baseClassNs   = baseClass.split('.'),
+            baseFileName = baseClassNs.pop(),
+            className     = opts.className,
+            file          = opts.file,
+            i             = 0,
+            importDelta   = '';
+
+        for (; i < opts.folderDelta; i++) {
+            importDelta += '../';
+        }
+
+        let classContent = [
+            `import ${baseFileName} from '${importDelta}${(insideNeo ? '' : 'node_modules/neo.mjs/')}src/${baseClassNs.join('/')}/${baseFileName}.mjs';`,
+            "",
+            "/**",
+            " * @class " + className,
+            " * @extends Neo." + baseClass,
+            " */",
+            `class ${file} extends ${baseFileName} {`,
+            "    static getConfig() {return {",
+            "        /*",
+            `         * @member {String} className='${className}'`,
+            "         * @protected",
+            "         */",
+            `        className: '${className}'`
+        ];
+
+        if (baseClass === 'component.Base') {
+            addComma(classContent);
+
+            classContent.push(
+            "        /*",
+            "         * @member {Object} _vdom",
+            "         */",
+            "        _vdom:",
+            "        {}",
+            );
+        }
+
+        if (baseClass === 'container.Base') {
+            addComma(classContent);
+
+            classContent.push(
+            "        /*",
+            "         * @member {Object[]} items",
+            "         */",
+            "        items: []",
+            );
+        }
+
+        classContent.push(
+            "    }}",
+            "}",
+            "",
+            `Neo.applyClassConfig(${file});`,
+            "",
+            `export default ${file};`,
+            ""
+        );
+
+        return classContent.join(os.EOL);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "neo.mjs",
-    "version": "4.0.49",
+    "version": "4.0.50",
     "description": "The webworkers driven UI framework",
     "type": "module",
     "repository": {
@@ -14,6 +14,7 @@
         "build-themes": "node ./buildScripts/buildThemes.mjs -f",
         "build-threads": "node ./buildScripts/webpack/buildThreads.mjs -f",
         "create-app": "node ./buildScripts/createApp.mjs",
+        "create-class": "node ./buildScripts/createClass.mjs",
         "generate-docs-json": "node ./buildScripts/docs/jsdocx.mjs",
         "server-start": "webpack serve -c ./buildScripts/webpack/webpack.server.config.mjs --open",
         "test": "echo \"Error: no test specified\" && exit 1",