fix: compatibility with swc (#87)

webpack-contrib · Oct 13, 2022 · afaf453 · afaf453
1 parent 0ae3eef
commit afaf453
Show file tree

Hide file tree

Showing 7 changed files with 208 additions and 135 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,8 @@ module.exports = {
 
       // For `@swc/html`:
       //
+      // Options - https://github.com/swc-project/bindings/blob/main/packages/html/index.ts#L5
+      //
       // new HtmlMinimizerPlugin({
       //   minify: HtmlMinimizerPlugin.swcMinify,
       //   minimizerOptions: {}
@@ -450,6 +452,8 @@ module.exports = {
 
 ### `swc/html`
 
+Available [`options`](https://github.com/swc-project/bindings/blob/main/packages/html/index.ts#L5).
+
 ```js
 const HtmlMinimizerPlugin = require("html-minimizer-webpack-plugin");
 const CopyPlugin = require("copy-webpack-plugin");
@@ -479,7 +483,7 @@ module.exports = {
       new HtmlMinimizerPlugin({
         minify: HtmlMinimizerPlugin.swcMinify,
         minimizerOptions: {
-          // Options
+          // Options - https://github.com/swc-project/bindings/blob/main/packages/html/index.ts#L5
         },
       }),
     ],

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -62,7 +62,7 @@
     "@babel/preset-env": "^7.18.9",
     "@commitlint/cli": "^17.1.2",
     "@commitlint/config-conventional": "^17.1.0",
-    "@swc/html": "^0.0.16",
+    "@swc/html": "^0.0.17",
     "@types/serialize-javascript": "^5.0.2",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-jest": "^29.1.2",

diff --git a/src/utils.js b/src/utils.js
@@ -113,12 +113,30 @@ async function swcMinify(input, minimizerOptions = {}) {
   // eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
   const swcMinifier = require("@swc/html");
 
-  const [[, code]] = Object.entries(input);
-  const result = await swcMinifier.minify(Buffer.from(code), {
+  // TODO `import("@swc/html").Options`
+  const options = /** @type {*} */ ({
     ...minimizerOptions,
   });
 
-  return { code: result };
+  const [[, code]] = Object.entries(input);
+  const result = await swcMinifier.minify(Buffer.from(code), options);
+
+  let errors;
+
+  if (typeof result.errors !== "undefined") {
+    errors = result.errors.map((diagnostic) => {
+      const error = new Error(diagnostic.message);
+
+      // @ts-ignore
+      error.span = diagnostic.span;
+      // @ts-ignore
+      error.level = diagnostic.level;
+
+      return error;
+    });
+  }
+
+  return { code: result.code, errors };
 }
 
 module.exports = { throttleAll, htmlMinifierTerser, swcMinify };
diff --git a/test/__snapshots__/minify-option.test.js.snap b/test/__snapshots__/minify-option.test.js.snap
@@ -71,29 +71,64 @@ exports[`"minify" option should work minify function: warnings 1`] = `[]`;
 
 exports[`"minify" option should work with 'swcMinify' and options: assets 1`] = `
 {
-  "simple.html": "<!doctype html><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width,user-scalable=no,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"><meta http-equiv=X-UA-Compatible content="ie=edge"><title>Document</title><h1>My First Heading</h1>
-<p>My first paragraph.</p>
-<h2>An Unordered HTML List</h2>
+  "simple.html": "<!doctype html><html lang=en><meta charset=UTF-8><meta name=viewport content="width=device-width,user-scalable=no,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"><meta http-equiv=X-UA-Compatible content="ie=edge"><title>Document</title><h1>My First Heading</h1> <p>My first paragraph.</p> <h2>An Unordered HTML List</h2> <ul> <li>Coffee</li> <li>Tea</li> <li>Milk</li> </ul> <h2>An Ordered HTML List</h2> <ol> <li>Coffee</li> <li>Tea</li> <li>Milk</li> </ol>",
+}
+`;
 
-<ul>
-  <li>Coffee</li>
-  <li>Tea</li>
-  <li>Milk</li>
-</ul>
+exports[`"minify" option should work with 'swcMinify' and options: errors 1`] = `[]`;
 
-<h2>An Ordered HTML List</h2>
+exports[`"minify" option should work with 'swcMinify' and options: warnings 1`] = `[]`;
 
-<ol>
-  <li>Coffee</li>
-  <li>Tea</li>
-  <li>Milk</li>
-</ol>",
+exports[`"minify" option should work with 'swcMinify' and throw errors: assets 1`] = `
+{
+  "broken-html-syntax.html": "Text &lt; img src="image.png" >
+Text &lt;<img src=image.png>
+Text ><img src=image.png>
+
+<a foo><bar></bar></a><boo>boohay
+&lt;&lt;&lt;&lt;>foo
+>>&lt;</boo>",
 }
 `;
 
-exports[`"minify" option should work with 'swcMinify' and options: errors 1`] = `[]`;
+exports[`"minify" option should work with 'swcMinify' and throw errors: errors 1`] = `
+[
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Abrupt closing of empty comment",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Cdata in html content",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+End of file seen and there were open elements",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+End tag "a" violates nesting rules",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Eof in tag",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Incorrectly opened comment",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Invalid first character of tag name",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Non void html element start tag with trailing solidus",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Non-space characters found without seeing a doctype first, expected "<!DOCTYPE html>"",
+  "Error: broken-html-syntax.html from Html Minimizer plugin
+Unexpected question mark instead of tag name",
+]
+`;
 
-exports[`"minify" option should work with 'swcMinify' and options: warnings 1`] = `[]`;
+exports[`"minify" option should work with 'swcMinify' and throw errors: warnings 1`] = `[]`;
 
 exports[`"minify" option should work with 'swcMinify': assets 1`] = `
 {

diff --git a/test/helpers/getCompiler.js b/test/helpers/getCompiler.js
@@ -16,6 +16,7 @@ export default function getCompiler(htmlFixture, config = {}) {
           entry: path.resolve(__dirname, "../fixtures/entry.js"),
           optimization: {
             minimize: false,
+            emitOnErrors: true,
           },
           output: {
             pathinfo: false,

diff --git a/test/minify-option.test.js b/test/minify-option.test.js
@@ -206,13 +206,28 @@ describe('"minify" option', () => {
     expect(getWarnings(stats)).toMatchSnapshot("warnings");
   });
 
+  it("should work with 'swcMinify' and throw errors", async () => {
+    const testHtmlId = "./broken-html-syntax.html";
+    const compiler = getCompiler(testHtmlId);
+
+    new HtmlMinimizerPlugin({
+      minify: HtmlMinimizerPlugin.swcMinify,
+    }).apply(compiler);
+
+    const stats = await compile(compiler);
+
+    expect(readAssets(compiler, stats, /\.html$/i)).toMatchSnapshot("assets");
+    expect(getErrors(stats)).toMatchSnapshot("errors");
+    expect(getWarnings(stats)).toMatchSnapshot("warnings");
+  });
+
   it("should work with 'swcMinify' and options", async () => {
     const testHtmlId = "./simple.html";
     const compiler = getCompiler(testHtmlId);
 
     new HtmlMinimizerPlugin({
       minimizerOptions: {
-        collapseBooleanAttributes: false,
+        collapseWhitespaces: "advanced-conservative",
       },
       minify: HtmlMinimizerPlugin.swcMinify,
     }).apply(compiler);