fix: default value of the static option is the static directory path.join(process.cwd() + 'static') (#2897)

BREAKING CHANGE: default value of the `static` option is `path.resolve(process.cwd(), 'static')`, previously `process.cwd()`

Author: alexander-akait

lib/utils/normalizeOptions.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const path = require('path');
 const isAbsoluteUrl = require('is-absolute-url');
 const getCompilerConfigArray = require('./getCompilerConfigArray');
 
@@ -14,7 +15,7 @@ function normalizeOptions(compiler, options) {
     : {};
 
   const defaultOptionsForStatic = {
-    directory: process.cwd(),
+    directory: path.join(process.cwd(), 'static'),
     staticOptions: {},
     publicPath: ['/'],
     serveIndex: { icons: true },

test/fixtures/contentbase-config/static/index.html

@@ -0,0 +1 @@
+Heyo.

test/server/host-option.test.js

@@ -1,10 +1,16 @@
 'use strict';
 
+const path = require('path');
 const request = require('supertest');
 const config = require('../fixtures/simple-config/webpack.config');
 const testServer = require('../helpers/test-server');
 const port = require('../ports-map')['host-option'];
 
+const staticDirectory = path.resolve(
+  __dirname,
+  '../fixtures/contentbase-config'
+);
+
 describe('host option', () => {
   let server = null;
   let req = null;
@@ -15,6 +21,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           port,
@@ -44,6 +51,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           // eslint-disable-next-line no-undefined
@@ -75,6 +83,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           host: null,
@@ -105,6 +114,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           host: '127.0.0.1',
@@ -135,6 +145,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           host: 'localhost',
@@ -165,6 +176,7 @@ describe('host option', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           host: '0.0.0.0',

test/server/port-option.test.js

@@ -1,10 +1,16 @@
 'use strict';
 
+const path = require('path');
 const request = require('supertest');
 const testServer = require('../helpers/test-server');
 const config = require('../fixtures/simple-config/webpack.config');
 const port = require('../ports-map')['port-option'];
 
+const staticDirectory = path.resolve(
+  __dirname,
+  '../fixtures/contentbase-config'
+);
+
 describe('port', () => {
   let server = null;
   let req = null;
@@ -15,6 +21,7 @@ describe('port', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           port,
@@ -45,6 +52,7 @@ describe('port', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           // eslint-disable-next-line no-undefined
@@ -76,6 +84,7 @@ describe('port', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           port: null,
@@ -106,6 +115,7 @@ describe('port', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           port: '33333',
@@ -135,6 +145,7 @@ describe('port', () => {
         config,
         {
           static: {
+            directory: staticDirectory,
             watch: false,
           },
           port: '33333',

test/server/static-directory-option.test.js

@@ -7,14 +7,12 @@ const testServer = require('../helpers/test-server');
 const config = require('../fixtures/contentbase-config/webpack.config');
 const port = require('../ports-map')['static-directory-option'];
 
-const publicDirectory = path.resolve(
+const staticDirectory = path.resolve(
   __dirname,
-  '../fixtures/contentbase-config/public'
-);
-const otherPublicDirectory = path.resolve(
-  __dirname,
-  '../fixtures/contentbase-config/other'
+  '../fixtures/contentbase-config'
 );
+const publicDirectory = path.resolve(staticDirectory, 'public');
+const otherPublicDirectory = path.resolve(staticDirectory, 'other');
 
 describe('static.directory option', () => {
   let server;
@@ -290,7 +288,9 @@ describe('static.directory option', () => {
 
   describe('default to PWD', () => {
     beforeAll((done) => {
-      jest.spyOn(process, 'cwd').mockImplementation(() => publicDirectory);
+      jest
+        .spyOn(process, 'cwd')
+        .mockImplementation(() => path.resolve(staticDirectory));
 
       server = testServer.start(
         config,
@@ -310,7 +310,7 @@ describe('static.directory option', () => {
     });
 
     it('Request to page', (done) => {
-      req.get('/other.html').expect(200, done);
+      req.get('/index.html').expect(200, done);
     });
   });
 

test/server/static-publicPath-option.test.js

@@ -6,15 +6,12 @@ const testServer = require('../helpers/test-server');
 const config = require('../fixtures/contentbase-config/webpack.config');
 const port = require('../ports-map')['static-publicPath-option'];
 
-const publicDirectory = path.resolve(
+const staticDirectory = path.resolve(
   __dirname,
-  '../fixtures/contentbase-config/public'
+  '../fixtures/contentbase-config'
 );
-const otherPublicDirectory = path.resolve(
-  __dirname,
-  '../fixtures/contentbase-config/other'
-);
-
+const publicDirectory = path.resolve(staticDirectory, 'public');
+const otherPublicDirectory = path.resolve(staticDirectory, 'other');
 const staticPublicPath = '/serve-content-base-at-this-url';
 const otherStaticPublicPath = '/serve-other-content-at-this-url';
 
@@ -191,7 +188,7 @@ describe('static.publicPath option', () => {
 
   describe('default to PWD', () => {
     beforeAll((done) => {
-      jest.spyOn(process, 'cwd').mockImplementation(() => publicDirectory);
+      jest.spyOn(process, 'cwd').mockImplementation(() => staticDirectory);
 
       server = testServer.start(
         config,
@@ -213,7 +210,7 @@ describe('static.publicPath option', () => {
     });
 
     it('Request to page', (done) => {
-      req.get(`${staticPublicPath}/other.html`).expect(200, done);
+      req.get(`${staticPublicPath}/index.html`).expect(200, done);
     });
   });
 

test/server/utils/normalizeOptions.test.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const path = require('path');
 const webpack = require('webpack');
 const normalizeOptions = require('../../../lib/utils/normalizeOptions');
 
@@ -448,7 +449,7 @@ describe('normalizeOptions', () => {
 
           if (data.options.static) {
             data.options.static.forEach((staticOpts) => {
-              if (staticOpts.directory === process.cwd()) {
+              if (staticOpts.directory === path.join(process.cwd(), 'static')) {
                 // give an indication in the snapshot that this is the
                 // current working directory
                 staticOpts.directory = 'CWD';