refactor: code

webpack · Dec 28, 2020 · 4de138c · 4de138c
1 parent b28009f
commit 4de138c
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 73 deletions.
diff --git a/packages/generators/src/index.ts b/packages/generators/src/index.ts
@@ -5,10 +5,10 @@ import addonGenerator from './addon-generator';
 import initGenerator from './init-generator';
 
 class GeneratorsCommand {
-    apply(cli): void {
+    async apply(cli): Promise<void> {
         const { logger } = cli;
 
-        cli.makeCommand(
+        await cli.makeCommand(
             {
                 name: 'loader [output-path]',
                 alias: 'l',

diff --git a/packages/info/src/index.ts b/packages/info/src/index.ts
@@ -30,8 +30,8 @@ const DEFAULT_DETAILS: Information = {
 };
 
 class InfoCommand {
-    apply(cli): void {
-        cli.makeCommand(
+    async apply(cli): Promise<void> {
+        await cli.makeCommand(
             {
                 name: 'info',
                 alias: 'i',

diff --git a/packages/init/src/index.ts b/packages/init/src/index.ts
@@ -2,8 +2,8 @@ import { initGenerator } from '@webpack-cli/generators';
 import { modifyHelperUtil, npmPackagesExists } from '@webpack-cli/utils';
 
 class InitCommand {
-    apply(cli): void {
-        cli.makeCommand(
+    async apply(cli): Promise<void> {
+        await cli.makeCommand(
             {
                 name: 'init [scaffold...]',
                 alias: 'c',

diff --git a/packages/migrate/src/index.ts b/packages/migrate/src/index.ts
@@ -149,10 +149,10 @@ function runMigration(currentConfigPath: string, outputConfigPath: string, logge
 }
 
 class MigrationCommand {
-    apply(cli): void {
+    async apply(cli): Promise<void> {
         const { logger } = cli;
 
-        cli.makeCommand(
+        await cli.makeCommand(
             {
                 name: 'migrate <config-path> [new-config-path]',
                 alias: 'm',

diff --git a/packages/serve/src/index.ts b/packages/serve/src/index.ts
@@ -4,7 +4,7 @@ class ServeCommand {
     async apply(cli): Promise<void> {
         const { logger } = cli;
 
-        cli.makeCommand(
+        await cli.makeCommand(
             {
                 name: 'serve',
                 alias: 's',
@@ -20,7 +20,8 @@ class ServeCommand {
                     // eslint-disable-next-line
                     devServerFlags = require('webpack-dev-server/bin/cli-flags').devServer;
                 } catch (error) {
-                    return [];
+                    logger.error(`You need to install 'webpack-dev-server' for running 'webpack serve'.\n${error}`);
+                    process.exit(2);
                 }
 
                 const builtInOptions = cli.getBuiltInOptions();

diff --git a/packages/webpack-cli/lib/utils/prompt-installation.js b/packages/webpack-cli/lib/utils/prompt-installation.js
@@ -18,15 +18,15 @@ async function promptInstallation(packageName, preMessage) {
         process.exit(2);
     }
 
-    // yarn uses 'add' command, rest npm and pnpm both use 'install'
-    const options = [packageManager === 'yarn' ? 'add' : 'install', '-D', packageName];
-
-    const commandToBeRun = `${packageManager} ${options.join(' ')}`;
-
     if (preMessage) {
         preMessage();
     }
 
+    // yarn uses 'add' command, rest npm and pnpm both use 'install'
+    const commandToBeRun = `${packageManager} ${[packageManager === 'yarn' ? 'add' : 'install', '-D', packageName].join(
+        ' ',
+    )} --ignore-workspace-root-check`;
+
     let installConfirm;
 
     try {

diff --git a/packages/webpack-cli/lib/webpack-cli.js b/packages/webpack-cli/lib/webpack-cli.js
@@ -29,8 +29,8 @@ class WebpackCLI {
         this.utils = { toKebabCase, getPkg, promptInstallation };
     }
 
-    makeCommand(commandOptions, options, action) {
-        const command = program.command(commandOptions.name, {
+    async makeCommand(commandOptions, options, action) {
+        const command = this.program.command(commandOptions.name, {
             noHelp: commandOptions.noHelp,
             hidden: commandOptions.hidden,
             isDefault: commandOptions.isDefault,
@@ -56,41 +56,55 @@ class WebpackCLI {
             command.pkg = 'webpack-cli';
         }
 
+        const { forHelp } = this.program;
+
+        let allDependenciesInstalled = true;
+
+        if (commandOptions.dependencies && commandOptions.dependencies.length > 0) {
+            for (const dependency of commandOptions.dependencies) {
+                const isPkgExist = getPkg(dependency);
+
+                if (isPkgExist) {
+                    continue;
+                } else if (!isPkgExist && forHelp) {
+                    allDependenciesInstalled = false;
+                    continue;
+                }
+
+                try {
+                    await promptInstallation(dependency, () => {
+                        logger.error(
+                            `For using '${green(commandOptions.name)}' command you need to install: '${green(dependency)}' package`,
+                        );
+                    });
+                } catch (error) {
+                    logger.error("Action Interrupted, use 'webpack-cli help' to see possible commands.");
+                    logger.error(error);
+                    process.exit(2);
+                }
+            }
+        }
+
         if (options) {
             if (typeof options === 'function') {
-                options = options();
+                if (forHelp && !allDependenciesInstalled) {
+                    command.description(
+                        `${commandOptions.description} To see all available options you need to install ${commandOptions.dependencies
+                            .map((dependency) => `'${dependency}'`)
+                            .join(',')}.`,
+                    );
+                    options = [];
+                } else {
+                    options = options();
+                }
             }
 
             options.forEach((optionForCommand) => {
                 this.makeOption(command, optionForCommand);
             });
         }
 
-        command.action(async (...args) => {
-            if (commandOptions.dependencies && commandOptions.dependencies.length > 0) {
-                for (const dependency of commandOptions.dependencies) {
-                    const isPkgExist = getPkg(dependency);
-
-                    if (isPkgExist) {
-                        continue;
-                    }
-
-                    try {
-                        await promptInstallation(dependency, () => {
-                            logger.error(
-                                `For using '${green(commandOptions.name)}' command you need to install: '${green(dependency)}' package`,
-                            );
-                        });
-                    } catch (error) {
-                        logger.error("Action Interrupted, use 'webpack-cli help' to see possible commands.");
-                        logger.error(error);
-                        process.exit(2);
-                    }
-                }
-            }
-
-            await action(...args);
-        });
+        command.action(action);
 
         return command;
     }
@@ -654,6 +668,8 @@ class WebpackCLI {
                     }
                 }
 
+                this.program.forHelp = true;
+
                 const optionsForHelp = [].concat(opts.help && !isDefault ? [commandName] : []).concat(options);
 
                 await outputHelp(optionsForHelp, isVerbose, program);

diff --git a/test/optimization/optimization.test.js b/test/optimization/optimization.test.js
diff --git a/test/optimization/src/index.js b/test/optimization/src/index.js
diff --git a/test/optimization/webpack.config.js b/test/optimization/webpack.config.js
diff --git a/test/utils/test-utils.js b/test/utils/test-utils.js
@@ -8,12 +8,22 @@ const { Writable } = require('readable-stream');
 const concat = require('concat-stream');
 const { version } = require('webpack');
 const stripAnsi = require('strip-ansi');
-const { version: devServerVersion } = require('webpack-dev-server/package.json');
+
+const isWebpack5 = version.startsWith('5');
+
+let devServerVersion;
+
+try {
+    // eslint-disable-next-line
+    devServerVersion = require('webpack-dev-server/package.json').version;
+} catch (error) {
+    // Nothing
+}
+
+const isDevServer4 = devServerVersion && devServerVersion.startsWith('4');
 
 const WEBPACK_PATH = path.resolve(__dirname, '../../packages/webpack-cli/bin/cli.js');
 const ENABLE_LOG_COMPILATION = process.env.ENABLE_PIPE || false;
-const isWebpack5 = version.startsWith('5');
-const isDevServer4 = devServerVersion.startsWith('4');
 const isWindows = process.platform === 'win32';
 
 const hyphenToUpperCase = (name) => {