fix: do not modify index.ejs with default viewport meta tag

Take into account `src/index.ejs` existence while deciding to add default meta-tags. Closes: jantimon#1387
Den-dp · Jun 4, 2022 · 26a3704 · 26a3704
1 parent d5ce5a8
commit 26a3704
Show file tree

Hide file tree

Showing 9 changed files with 537 additions and 4 deletions.
diff --git a/examples/default-template-location/dist/webpack-5/bundle.js b/examples/default-template-location/dist/webpack-5/bundle.js
diff --git a/examples/default-template-location/dist/webpack-5/index.html b/examples/default-template-location/dist/webpack-5/index.html
@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Webpack App</title><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="MobileOptimized" content="width"><script defer="defer" src="bundle.js"></script></head><body><h1>Template</h1></body></html>
diff --git a/examples/default-template-location/readme.md b/examples/default-template-location/readme.md
@@ -0,0 +1,3 @@
+# default template location
+
+in this example a template is placed in the default location
diff --git a/examples/default-template-location/src/example.js b/examples/default-template-location/src/example.js
@@ -0,0 +1,4 @@
+require('./main.css');
+var h1 = document.createElement('h1');
+h1.innerHTML = 'Hello world!';
+document.body.appendChild(h1);
diff --git a/examples/default-template-location/src/index.ejs b/examples/default-template-location/src/index.ejs
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title><%= htmlWebpackPlugin.options.title %></title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="MobileOptimized" content="width">
+</head>
+<body>
+<h1>Template</h1>
+</body>
+</html>
diff --git a/examples/default-template-location/src/main.css b/examples/default-template-location/src/main.css
@@ -0,0 +1,3 @@
+body {
+  background: snow;
+}
diff --git a/examples/default-template-location/webpack.config.js b/examples/default-template-location/webpack.config.js
@@ -0,0 +1,22 @@
+var path = require('path');
+var HtmlWebpackPlugin = require('../..');
+var webpackMajorVersion = require('webpack/package.json').version.split('.')[0];
+
+module.exports = {
+  context: __dirname,
+  entry: './src/example.js',
+  output: {
+    path: path.join(__dirname, 'dist/webpack-' + webpackMajorVersion),
+    publicPath: '',
+    filename: 'bundle.js'
+  },
+  module: {
+    rules: [
+      { test: /\.css$/, use: ['style-loader', 'css-loader'] },
+      { test: /\.png$/, type: 'asset/resource' }
+    ]
+  },
+  plugins: [
+    new HtmlWebpackPlugin()
+  ]
+};
diff --git a/index.js b/index.js
@@ -36,7 +36,7 @@ class HtmlWebpackPlugin {
   }
 
   apply (compiler) {
-    // Wait for configuration preset plugions to apply all configure webpack defaults
+    // Wait for configuration preset plugins to apply all configure webpack defaults
     compiler.hooks.initialize.tap('HtmlWebpackPlugin', () => {
       const userOptions = this.userOptions;
 
@@ -74,7 +74,7 @@ class HtmlWebpackPlugin {
       assert(options.inject === true || options.inject === false || options.inject === 'head' || options.inject === 'body', 'inject needs to be set to true, false, "head" or "body');
 
       // Default metaOptions if no template is provided
-      if (!userOptions.template && options.templateContent === false && options.meta) {
+      if (!userOptions.template && !isTemplateInDefaultLocation(compiler.context) && options.templateContent === false && options.meta) {
         const defaultMeta = {
         // From https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag
           viewport: 'width=device-width, initial-scale=1'
@@ -152,6 +152,11 @@ class HtmlWebpackPlugin {
   }
 }
 
+function isTemplateInDefaultLocation(context) {
+  const template = path.resolve(context, 'src/index.ejs');
+  return fs.existsSync(template);
+}
+
 /**
  * connect the html-webpack-plugin to the webpack compiler lifecycle hooks
  *
@@ -1018,8 +1023,9 @@ function hookIntoCompiler (compiler, options, plugin) {
    */
   function getFullTemplatePath (template, context) {
     if (template === 'auto') {
-      template = path.resolve(context, 'src/index.ejs');
-      if (!fs.existsSync(template)) {
+      if (isTemplateInDefaultLocation(context)) {
+        template = path.resolve(context, 'src/index.ejs');
+      } else {
         template = path.join(__dirname, 'default_index.ejs');
       }
     }

diff --git a/spec/example.spec.js b/spec/example.spec.js
@@ -67,6 +67,10 @@ describe('HtmlWebpackPlugin Examples', () => {
     runExample('default', done);
   });
 
+  it('default template location example', done => {
+    runExample('default-template-location', done);
+  });
+
   it('favicon example', done => {
     runExample('favicon', done);
   });
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Webpack App</title><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="MobileOptimized" content="width"><script defer="defer" src="bundle.js"></script></head><body><h1>Template</h1></body></html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# default template location

		in this example a template is placed in the default location