Feat: Add htmlAttributes option and generate <html lang="en"> by default (#8)

J-Kallunki · sapegin · commit 7ee4bc71a8fc · 2019-05-15T10:23:51.000+02:00
BREAKING CHANGE:

* Node 8.12 is the minimum required version.
diff --git a/README.md b/README.md
@@ -19,7 +19,8 @@ const config = {
   plugins: [
     new MiniHtmlWebpackPlugin({
       context: {
-        title: 'Webpack demo'
+        title: 'Webpack demo',
+        htmlAttributes: { lang: 'en' } // Optional, defaults to { lang: 'en' }
       },
       filename: 'demo.html' // Optional, defaults to `index.html`
     })
@@ -65,9 +66,11 @@ const config = {
       context: {
         title: 'Custom template' // Available in the context below
       },
-      template: ({ css, js, title, publicPath }) =>
+      template: ({ css, js, title, htmlAttributes, publicPath }) =>
         `<!DOCTYPE html>
-          <html>
+          <html ${Object.entries(htmlAttributes)
+            .map(attribute => `${attribute[0]}="${attribute[1]}"`)
+            .join(' ')}>
             <head>
               <meta charset="UTF-8">
               <title>${title}</title>
diff --git a/__snapshots__/test.js.snap b/__snapshots__/test.js.snap
@@ -2,7 +2,22 @@
 
 exports[`custom filename 1`] = `
 "<!DOCTYPE html>
-  <html>
+  <html lang=\\"en\\">
+    <head>
+      <meta charset=\\"UTF-8\\">
+      <title></title>
+
+      
+    </head>
+    <body>
+      <script src=\\"runtime~main.js\\"></script><script src=\\"main.js\\"></script>
+    </body>
+  </html>"
+`;
+
+exports[`custom lang 1`] = `
+"<!DOCTYPE html>
+  <html lang=\\"ru\\">
     <head>
       <meta charset=\\"UTF-8\\">
       <title></title>
@@ -19,7 +34,7 @@ exports[`custom template 1`] = `"<div>Pizza</div>"`;
 
 exports[`custom title 1`] = `
 "<!DOCTYPE html>
-  <html>
+  <html lang=\\"en\\">
     <head>
       <meta charset=\\"UTF-8\\">
       <title>Pizza</title>
@@ -34,7 +49,7 @@ exports[`custom title 1`] = `
 
 exports[`default options 1`] = `
 "<!DOCTYPE html>
-  <html>
+  <html lang=\\"en\\">
     <head>
       <meta charset=\\"UTF-8\\">
       <title></title>
diff --git a/index.js b/index.js
@@ -61,9 +61,17 @@ function normalizeEntrypoints(entrypoints) {
 	return Object.keys(entrypoints).map(name => entrypoints[name]);
 }
 
-function defaultTemplate({ css, js, title = '', publicPath }) {
+function defaultTemplate({
+	css,
+	js,
+	title = '',
+	htmlAttributes = { lang: 'en' },
+	publicPath,
+}) {
 	return `<!DOCTYPE html>
-  <html>
+  <html ${Object.entries(htmlAttributes)
+		.map(attribute => `${attribute[0]}="${attribute[1]}"`)
+		.join(' ')}>
     <head>
       <meta charset="UTF-8">
       <title>${title}</title>
diff --git a/test.js b/test.js
@@ -24,11 +24,20 @@ test('custom title', () => {
 	);
 });
 
+test('custom lang', () => {
+	return compiler(
+		{},
+		getConfig({ context: { htmlAttributes: { lang: 'ru' } } })
+	).then(result => {
+		expect(result.compilation.assets['index.html']._value).toMatchSnapshot();
+	});
+});
+
 test('custom template', () => {
 	return compiler(
 		{},
 		getConfig({
-			context: { title: 'Pizza' },
+			context: { title: 'Pizza', htmlAttributes: { lang: 'it' } },
 			template: ({ title }) => `<div>${title}</div>`,
 		})
 	).then(result => {
