tests: configtest

packages/configtest/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webpack-cli/configtest",
   "version": "1.0.0",
-  "description": "Test your webpack configuration",
+  "description": "Test your webpack configuration against validation errors.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "license": "MIT",

packages/configtest/src/index.ts

@@ -19,13 +19,12 @@ class ConfigTestCommand {
                     process.exit(2);
                 }
 
-                const { options, absolutePath } = await cli.resolveConfig({ config: [configPath] });
+                const { options } = await cli.resolveConfig({ config: [configPath] });
 
                 //eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const validationErrors: any = validate(options);
 
                 if (validationErrors) {
-                    logger.error("Your configuration validation wasn't successful");
                     logger.error(validationErrors);
                 }
 

packages/webpack-cli/package.json

@@ -54,6 +54,9 @@
     "@webpack-cli/migrate": {
       "optional": true
     },
+    "@webpack-cli/configtest": {
+      "optional": true
+    },
     "webpack-bundle-analyzer": {
       "optional": true
     },

test/configtest/configtest.test.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const { run } = require('../utils/test-utils');
+
+describe('basic info usage', () => {
+    it('should validate webpack config successfully', () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['configtest', './webpack.config.js'], false);
+
+        expect(exitCode).toBe(0);
+        expect(stderr).toBeFalsy();
+        expect(stdout).toContain('There are no validation errors in the given webpack configuration.');
+    });
+
+    it('should throw validation error', () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['configtest', './error.config.js'], false);
+
+        expect(exitCode).toBe(2);
+        expect(stderr).toContain('ValidationError: Invalid configuration object.');
+        expect(stderr).toContain('configuration.mode should be one of these:');
+        expect(stdout).toBeFalsy();
+    });
+
+    it(`should validate the config with alias 't'`, () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['t', './error.config.js'], false);
+
+        expect(exitCode).toBe(2);
+        expect(stderr).toContain('ValidationError: Invalid configuration object.');
+        expect(stderr).toContain('configuration.mode should be one of these:');
+        expect(stdout).toBeFalsy();
+    });
+
+    it('should throw error when multiple configurations are provided simultaneously', () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['configtest', './error.config.js', './webpack.config.js'], false);
+
+        expect(exitCode).toBe(2);
+        expect(stderr).toContain('Only one configuration can be validated at a time');
+        expect(stdout).toBeFalsy();
+    });
+});

test/configtest/error.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    mode: 'dev', // error
+    target: 'node',
+    stats: 'normal',
+};

test/configtest/src/index.js

@@ -0,0 +1 @@
+console.log('configtest command');

test/configtest/webpack.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    mode: 'development',
+    target: 'node',
+    stats: 'verbose',
+};

test/help/help.test.js

@@ -28,6 +28,7 @@ describe('help', () => {
         expect(stdout.match(/loader\|l/g)).toHaveLength(1);
         expect(stdout.match(/migrate\|m/g)).toHaveLength(1);
         expect(stdout.match(/plugin\|p/g)).toHaveLength(1);
+        expect(stdout.match(/configtest\|t/g)).toHaveLength(1);
         expect(stdout).toContain("To see list of all supported commands and options run 'webpack --help=verbose'.");
         expect(stdout).toContain('CLI documentation: https://webpack.js.org/api/cli/.');
         // TODO buggy on windows