chore: rebase

Author: evenstensberg

README.md

@@ -24,6 +24,8 @@
 [![Issue resolution][issue-resolution]][issue-resolution-url]
 [![PR's welcome][pr-welcome]][pr-welcome-url]
 
+## Table of Contents
+
 -   [About](#about)
     -   [How to install](#how-to-install)
 -   [Packages](#packages)

lib/commands/external.js

@@ -1,5 +1,5 @@
 const { prompt } = require('inquirer');
-
+const chalk = require('chalk');
 class ExternalCommand {
     static async runCommand(command, args = []) {
         const cp = require('child_process');
@@ -19,32 +19,25 @@ class ExternalCommand {
     }
 
     static validateEnv(extName) {
-        let packageIsInstalled;
         try {
             const path = require('path');
             const pathForCmd = path.resolve(process.cwd(), 'node_modules', '@webpack-cli', extName);
             require.resolve(pathForCmd);
-            packageIsInstalled = pathForCmd;
+            return pathForCmd;
         } catch (err) {
-            packageIsInstalled = false;
+            return false;
         }
-        return packageIsInstalled;
     }
     static async promptInstallation(scopeName, name) {
         const path = require('path');
         const fs = require('fs');
         const isYarn = fs.existsSync(path.resolve(process.cwd(), 'yarn.lock'));
-
         const packageManager = isYarn ? 'yarn' : 'npm';
-        const options = ['install', '-D', scopeName];
-
-        if (isYarn) {
-            options[0] = 'add';
-        }
+        const options = [isYarn ? 'add': 'install', '-D', scopeName];
 
         const commandToBeRun = `${packageManager} ${options.join(' ')}`;
-        process.cliLogger.error(`The command moved into a separate package: ${name}`);
-        const question = `Would you like to install ${name}? (That will run ${commandToBeRun})`;
+        process.cliLogger.error(`The command moved into a separate package: ${chalk.keyword('orange')(name)}\n`);
+        const question = `Would you like to install ${name}? (That will run ${chalk.green(commandToBeRun)})`;
         const answer = await prompt([
             {
                 type: 'confirm',

lib/groups/advanced.js

@@ -14,7 +14,7 @@ class AdvancedGroup extends GroupHelper {
                 name = name.substring(0, p);
             }
         } catch (e) {
-            console.log('Invalid plugin arguments ' + name + ' (' + e + ').');
+            process.cliLogger.error('Invalid plugin arguments ' + name + ' (' + e + ').');
 			process.exit(-1); // eslint-disable-line
         }
 
@@ -23,20 +23,20 @@ class AdvancedGroup extends GroupHelper {
             const resolve = require('enhanced-resolve');
             path = resolve.sync(process.cwd(), name);
         } catch (e) {
-            console.log('Cannot resolve plugin ' + name + '.');
+            process.cliLogger.error('Cannot resolve plugin ' + name + '.');
 			process.exit(-1); // eslint-disable-line
         }
         let Plugin;
         try {
             Plugin = require(path);
         } catch (e) {
-            console.log('Cannot load plugin ' + name + '. (' + path + ')');
+            process.cliLogger.error('Cannot load plugin ' + name + '. (' + path + ')');
             throw e;
         }
         try {
             return new Plugin(args);
         } catch (e) {
-            console.log('Cannot instantiate plugin ' + name + '. (' + path + ')');
+            process.cliLogger.error('Cannot instantiate plugin ' + name + '. (' + path + ')');
             throw e;
         }
     }

lib/groups/config.js

@@ -26,7 +26,7 @@ class ConfigGroup extends GroupHelper {
     getConfigExtension(configPath) {
         for (let i = this.extensions.length - 1; i >= 0; i--) {
             const tmpExt = this.extensions[i];
-            if (configPath.indexOf(tmpExt, configPath.length - tmpExt.length) > -1) {
+            if (configPath.includes(tmpExt, configPath.length - tmpExt.length)) {
                 return tmpExt;
             }
         }
@@ -41,22 +41,30 @@ class ConfigGroup extends GroupHelper {
         };
     }
 
+    require(path) {
+        const result = require(path);
+        if (result && result.__esModule && result.default) {
+            return result.default;
+        }
+        return result;
+    }
+
     requireConfig(configPath) {
         const { register } = this.args;
 
         this.configOptions = (() => {
             if (register && register.length) {
                 module.paths.unshift(resolve(process.cwd(), 'node_modules'));
                 register.forEach(dep => {
-                    const isRelative = ["./", "../", ".\\", "..\\"].some(start => dep.startsWith(start));
+                    const isRelative = ['./', '../', '.\\', '..\\'].some(start => dep.startsWith(start));
                     if (isRelative) {
                         require(resolve(process.cwd(), dep));
                     } else {
                         require(dep);
                     }
                 });
             }
-            return require(configPath);
+            return this.require(configPath);
         })();
     }
 
@@ -81,7 +89,7 @@ class ConfigGroup extends GroupHelper {
                 .map(this.mapConfigArg.bind(this));
             if (tmpConfigFiles.length) {
                 if (!config) {
-                    const defaultConfig = tmpConfigFiles.find(p => ~p.path.indexOf(mode));
+                    const defaultConfig = tmpConfigFiles.find(p => p.path.includes(mode));
                     this.configFiles = defaultConfig || tmpConfigFiles[0];
                 }
             }
@@ -110,7 +118,7 @@ class ConfigGroup extends GroupHelper {
         const { merge } = this.args;
         if (merge) {
             const newConfigPath = this.resolveFilePath(merge, 'webpack.base');
-            const newConfig = newConfigPath ? require(newConfigPath) : null;
+            const newConfig = newConfigPath ? this.require(newConfigPath) : null;
             this.opts['options'] = require('webpack-merge')(this.opts['options'], newConfig);
         }
     }

lib/utils/compiler.js

@@ -3,20 +3,15 @@ const fs = require('fs');
 const chalk = require('chalk');
 const Table = require('cli-table3');
 
-function showEmojiConditionally(emoji) {
-    if (process.stdout.isTTY && process.platform === 'darwin') {
-        return emoji;
-    } else {
-        return '';
-    }
+function showEmojiConditionally() {
+    return (process.stdout.isTTY && process.platform === 'darwin')
 }
 
 function generateOutput(outputOptions, stats, statsErrors) {
     const statsObj = stats.toJson(outputOptions);
     const { assets, entrypoints, time, builtAt, warnings, outputPath } = statsObj;
 
-    const emojies = ['✅', '🌏', '⚒️ ', '⏱ ', '📂'];
-    const visibleEmojies = emojies.map(e => showEmojiConditionally(e));
+    const visibleEmojies = showEmojiConditionally() ? ['✅', '🌏', '⚒️ ', '⏱ ', '📂']: new Array(5).fill('');
 
     process.stdout.write('\n');
     process.stdout.write(`${visibleEmojies[0]} ${chalk.underline.bold('Compilation Results')}\n`);

lib/utils/group-helper.js

@@ -57,8 +57,9 @@ class GroupHelper {
     }
     mapArgToBoolean(name, optionName) {
         ifArg(name, function(bool) {
-            if (bool === true) options[optionName || name] = true;
-            else if (bool === false) options[optionName || name] = false;
+            if ([true, false].includes(bool)) {
+              options[optionName || name] = bool;	
+            }
         });
     }
 
@@ -114,10 +115,10 @@ class GroupHelper {
         if (filename && Array.isArray(filename)) {
             return filename.map(fp => this.resolveFilePath(fp, defaultValue)).filter(e => e);
         }
-        if (filename && filename.indexOf('.js') < 0) {
+        if (filename && filename.includes('.js')) {
             filename = filename + '.js';
         }
-        if (defaultValue && defaultValue.indexOf('.js') < 0) {
+        if (defaultValue && defaultValue.includes('.js')) {
             defaultValue = defaultValue + '.js';
         }
         let configPath;

package-lock.json

@@ -40,7 +40,7 @@
     "test": "nyc jest --maxWorkers=4 --reporters=default --reporters=jest-junit",
     "test:cli": "nyc jest test/ --maxWorkers=4 --reporters=default --reporters=jest-junit",
     "test:packages": "nyc jest packages/ --maxWorkers=4 --reporters=default --reporters=jest-junit",
-    "test:ci": "nyc jest --maxWorkers=$(nproc) --reporters=default --reporters=jest-junit",
+    "test:ci": "nyc jest --maxWorkers=$(nproc) --reporters=default --reporters=jest-junit --colors",
     "travis:integration": "npm run build && npm run test && npm run reportCoverage",
     "travis:lint": "npm run build && npm run lint",
     "watch": "npm run build && tsc -w",

package.json

@@ -51,7 +51,7 @@ const addonGenerator = (
 				I will create this folder for you.
 				`);
 				mkdirp(this.props.name, (err: object): void => {
-					console.error("Failed to create directory", err);
+                    if (err) console.error("Failed to create directory", err);
 				});
 				const pathToProjectDir: string = this.destinationPath(this.props.name);
 				this.destinationRoot(pathToProjectDir);

packages/generators/addon-generator.ts

@@ -9,22 +9,81 @@ This package returns a set of information related to the local environment.
 ## Installation
 
 ```bash
+#npm
 npm i -D @webpack-cli/info
+
+#yarn
+yarn add @webpack-cli/info -D
+
+#npx
+npx webpack info [options]
+
 ```
 
 ## Usage
 
+### Args / Flags
+
+#### Output format
+
+| Flag                | Description                   | Type        |
+| ------------------- | ----------------------------- | ----------- |
+| `--output-json`     | To get the output as JSON     | [ boolean ] |
+| `--output-markdown` | To get the output as markdown | [ boolean ] |
+
+_Not supported for config_
+
+#### Options
+
+| Flag                | Description                                                     | Type        |
+| ------------------- | --------------------------------------------------------------- | ----------- |
+| `--help`            | Show help                                                       | [ boolean ] |
+| `--version`         | Show version number of `webpack-cli`                            | [ boolean ] |
+| `--system` , `-s`   | System information ( OS, CPU )                                  | [ boolean ] |
+| `--binaries` , `-b` | Installed binaries (Node, yarn, npm)                            | [ boolean ] |
+| `--browsers`        | Installed web browsers                                          | [ boolean ] |
+| `--npmg`            | Globally installed NPM packages ( webpack & webpack-cli only )  | [ boolean ] |
+| `--npmPackages`     | Info about packages related to webpack installed in the project | [ boolean ] |
+
 ### Node
 
 ```js
-const envinfo = require("@webpack-cli/info").default;
-envinfo();
+const info = require('@webpack-cli/info').default;
+
+async function wrapperFunc() {
+    await info({
+        /* Custom Config */
+    });
+}
+wrapperFunc();
+```
+
+#### Custom config
+
+> Config has higher precedence than system flags
+
+```json
+// Config's relative path
+{
+
+    "config": [string]
+}
+    // System info
+{
+    "binaries": [boolean],
+    "system": [boolean],
+    "browsers": [boolean],
+    "npmg": [boolean],
+    "npmPackages": [boolean],
+}
 ```
 
+The function returns `string` for `system` info, and returns an array of strings (`string[]`) for `config`
+
 ### CLI (via `webpack-cli`)
 
 ```bash
-npx webpack-cli info
+webpack-cli info --FLAGS #Flags are optional for custom output
 ```
 
 [downloads]: https://img.shields.io/npm/dm/@webpack-cli/info.svg