fix(cli): fix file resolution inside group helper (#1221)

* fix(cli): fix file resolution inside group helper * fix(cli): default output bundle is main.js
webpack · Feb 12, 2020 · 76d2eb3 · 76d2eb3
1 parent e0c359e
commit 76d2eb3
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 14 deletions.
diff --git a/lib/groups/ZeroConfigGroup.js b/lib/groups/ZeroConfigGroup.js
@@ -1,5 +1,7 @@
 const GroupHelper = require('../utils/GroupHelper');
 
+const PRODUCTION = 'production';
+const DEVELOPMENT = 'development';
 /**
  * ZeroConfigGroup creates a zero configuration based on the environment
  */
@@ -13,25 +15,30 @@ class ZeroConfigGroup extends GroupHelper {
      * @returns {string} The mode
      */
     getEnvFromOptionsAndMode() {
-        if (process.env.NODE_ENV && (process.env.NODE_ENV === 'production' || process.env.NODE_ENV === 'development')) {
+        if (process.env.NODE_ENV && (process.env.NODE_ENV === PRODUCTION || process.env.NODE_ENV === DEVELOPMENT)) {
             return process.env.NODE_ENV;
         } else if (this.args.prod) {
-            return 'production';
+            return PRODUCTION;
         } else if (this.args.dev) {
-            return 'development';
+            return DEVELOPMENT;
         }
-        return 'production';
+        return PRODUCTION;
     }
 
     resolveZeroConfig() {
         const defaultConfigType = this.getEnvFromOptionsAndMode();
-        const defaultConfig = require(`./${defaultConfigType}-config`)();
+        let defaultConfig;
+        if (defaultConfigType === PRODUCTION) {
+            defaultConfig = require('../utils/production-config')();
+        } else {
+            defaultConfig = require('../utils/development-config')();
+        }
 
         const isEntryObject = defaultConfig.entry && defaultConfig.entry instanceof Object;
         const isOutputDefined = defaultConfig.output && defaultConfig.output.filename;
-        const isConflictingOutput = isEntryObject && isOutputDefined && defaultConfig.output.filename === 'bundle.js';
+        const isConflictingOutput = isEntryObject && isOutputDefined && defaultConfig.output.filename === 'main.js';
         if (isConflictingOutput) {
-            defaultConfig.output.filename = '[name].bundle.js';
+            defaultConfig.output.filename = '[name].main.js';
         }
         this.opts.options = defaultConfig;
     }

diff --git a/lib/utils/development-config.js b/lib/utils/development-config.js
@@ -8,6 +8,6 @@ module.exports = () => ({
     devtool: 'eval',
     output: {
         path: defaultOutputPath,
-        filename: 'bundle.js',
+        filename: 'main.js',
     },
 });
diff --git a/lib/utils/production-config.js b/lib/utils/production-config.js
@@ -9,7 +9,7 @@ module.exports = () => ({
     devtool: 'source-map',
     output: {
         path: defaultOutputPath,
-        filename: 'bundle.js',
+        filename: 'main.js',
     },
     optimization: {
         minimizer: [

diff --git a/lib/utils/zero-config.js b/lib/utils/zero-config.js
@@ -23,9 +23,9 @@ function getConfigurations(options, outputOptions) {
 
     const isEntryObject = newConfig.entry && newConfig.entry instanceof Object;
     const isOutputDefined = newConfig.output && newConfig.output.filename;
-    const isConflictingOutput = isEntryObject && isOutputDefined && newConfig.output.filename === 'bundle.js';
+    const isConflictingOutput = isEntryObject && isOutputDefined && newConfig.output.filename === 'main.js';
     if (isConflictingOutput) {
-        newConfig.output.filename = '[name].bundle.js';
+        newConfig.output.filename = '[name].main.js';
     }
     return newConfig;
 }

diff --git a/lib/webpack-cli.js b/lib/webpack-cli.js
@@ -218,7 +218,7 @@ class WebpackCLI extends GroupHelper {
 
     /**
      * Responsible for applying defaults, if necessary
-     * @private
+     * @private\
      * @returns {void}
      */
     _handForcedDefaults() {

diff --git a/packages/generators/__tests__/add-generator.test.js b/packages/generators/__tests__/add-generator.test.js
diff --git a/test/ZeroConfigGroup.test.js b/test/ZeroConfigGroup.test.js
@@ -0,0 +1,26 @@
+const ZeroConfigGroup = require('../lib/groups/ZeroConfigGroup');
+
+describe('GroupHelper', function() {
+    it('should  load the dev zero config', () => {
+        const group = new ZeroConfigGroup([
+            {
+                dev: true,
+            },
+        ]);
+
+        const result = group.run();
+        expect(result.options.mode).toEqual('development');
+    });
+    it('should load the prod zero config', () => {
+        const group = new ZeroConfigGroup([
+            [
+                {
+                    prod: true,
+                },
+            ],
+        ]);
+
+        const result = group.run();
+        expect(result.options.mode).toEqual('production');
+    });
+});
diff --git a/test/env/prod/index.js b/test/env/prod/index.js
@@ -0,0 +1 @@
+console.log('environment is '.concat(PRODUCTION ? 'production' : 'development'));
diff --git a/test/env/prod/prod.test.js b/test/env/prod/prod.test.js
@@ -0,0 +1,27 @@
+'use strict';
+
+const path = require('path');
+const execa = require('execa');
+const { sync: spawnSync } = execa;
+
+const { run } = require('../../utils/test-utils');
+
+describe('env object', () => {
+    it('is able to compile successfully with --prod flag', () => {
+        const { stderr, stdout } = run(__dirname, ['--prod']);
+        const executable = path.join(__dirname, './bin/main.js');
+        const bundledScript = spawnSync('node', [executable]);
+        expect(bundledScript.stdout).toBe('environment is production');
+        expect(stderr).toBeFalsy();
+        expect(stdout).toBeTruthy();
+    });
+
+    it('is able to compile successfully with -p flag', () => {
+        const { stderr, stdout } = run(__dirname, ['-p']);
+        const executable = path.join(__dirname, './bin/main.js');
+        const bundledScript = spawnSync('node', [executable]);
+        expect(bundledScript.stdout).toBe('environment is production');
+        expect(stderr).toBeFalsy();
+        expect(stdout).toBeTruthy();
+    });
+});
diff --git a/test/env/prod/webpack.config.js b/test/env/prod/webpack.config.js
@@ -0,0 +1,11 @@
+const webpack = require('webpack');
+
+module.exports = {
+    mode: 'development',
+    devtool: 'eval-cheap-module-source-map',
+    plugins: [
+        new webpack.DefinePlugin({
+            PRODUCTION: JSON.stringify(true),
+        }),
+    ],
+};
diff --git a/test/output/named-bundles/output-named-bundles.test.js b/test/output/named-bundles/output-named-bundles.test.js
@@ -53,11 +53,11 @@ describe('output flag named bundles', () => {
 
         expect(summary['Output Directory']).toContain(outputDir);
 
-        stat(resolve(__dirname, './dist/b.bundle.js'), (err, stats) => {
+        stat(resolve(__dirname, './dist/b.main.js'), (err, stats) => {
             expect(err).toBe(null);
             expect(stats.isFile()).toBe(true);
         });
-        stat(resolve(__dirname, './dist/c.bundle.js'), (err, stats) => {
+        stat(resolve(__dirname, './dist/c.main.js'), (err, stats) => {
             expect(err).toBe(null);
             expect(stats.isFile()).toBe(true);
         });