refactor: webpack v5 (#131)

BREAKING CHANGE: minimum supported webpack version is `5`, minimum supported Node.ks version is `14.15.0`

Author: alexander-akait

.eslintrc.js

@@ -4,15 +4,15 @@ module.exports = {
   extends: [
     "plugin:itgalaxy/script",
     "plugin:itgalaxy/esnext",
-    "plugin:itgalaxy/node"
+    "plugin:itgalaxy/node",
   ],
   overrides: [
     // Source
     {
       extends: ["plugin:itgalaxy/dirty"],
       // Exclude nested tests
       excludedFiles: ["**/__tests__/**/*", "**/__mocks__/**/*", "**/*.md"],
-      files: ["src/**/*"]
+      files: ["src/**/*"],
     },
 
     // Jest
@@ -22,26 +22,26 @@ module.exports = {
       files: ["**/__tests__/**/*", "**/__mocks__/**/*"],
       rules: {
         // Allow to use `console` (example - `mocking`)
-        "no-console": "off"
-      }
+        "no-console": "off",
+      },
     },
 
     // Markdown
     {
       extends: [
         // Documentation files can contain ECMA and CommonJS modules
         "plugin:itgalaxy/dirty",
-        "plugin:itgalaxy/markdown"
+        "plugin:itgalaxy/markdown",
       ],
       files: ["**/*.md"],
       rules: {
         "no-unused-vars": "off",
         "no-console": "off",
         "import/no-unresolved": "off",
         "node/no-unpublished-require": "off",
-        "node/no-unpublished-import": "off"
-      }
-    }
+        "node/no-unpublished-import": "off",
+      },
+    },
   ],
-  root: true
+  root: true,
 };

.remarkrc.js

@@ -1,5 +1,5 @@
 "use strict";
 
 module.exports = {
-  plugins: ["remark-preset-lint-itgalaxy"]
+  plugins: ["remark-preset-lint-itgalaxy"],
 };

__tests__/RobotstxtPlugin.test.js

@@ -1,48 +1,66 @@
+import path from "path";
 import { webpack } from "./helpers";
 import RobotstxtPlugin from "../src/RobotstxtPlugin";
 
 describe("plugin", () => {
   it("should execute successfully", async () => {
-    const stats = await webpack("entry.js");
-
-    const { warnings, errors, assets } = stats.compilation;
+    const { stats, compiler } = await webpack("entry.js");
+    const { warnings, errors } = stats.compilation;
 
     expect(warnings).toMatchSnapshot("warnings");
     expect(errors).toMatchSnapshot("errors");
-    expect(assets["robots.txt"].source()).toMatchSnapshot();
+    expect(
+      // eslint-disable-next-line no-sync
+      compiler.outputFileSystem.readFileSync(
+        path.resolve(compiler.outputPath, "robots.txt"),
+        "utf-8"
+      )
+    ).toMatchSnapshot();
   });
 
   it("should execute successfully #2", async () => {
-    const stats = await webpack("entry.js", {
-      plugins: [new RobotstxtPlugin()]
+    const { stats, compiler } = await webpack("entry.js", {
+      plugins: [new RobotstxtPlugin()],
     });
 
-    const { warnings, errors, assets } = stats.compilation;
+    const { warnings, errors } = stats.compilation;
 
     expect(warnings).toMatchSnapshot("warnings");
     expect(errors).toMatchSnapshot("errors");
-    expect(assets["robots.txt"].source()).toMatchSnapshot();
+    expect(
+      // eslint-disable-next-line no-sync
+      compiler.outputFileSystem.readFileSync(
+        path.resolve(compiler.outputPath, "robots.txt"),
+        "utf-8"
+      )
+    ).toMatchSnapshot();
   });
 
   it("should execute successfully with `filePath` option", async () => {
-    const stats = await webpack("entry.js", {
+    const { stats, compiler } = await webpack("entry.js", {
       pluginOptions: {
-        filePath: "robots.dev.txt"
-      }
+        filePath: "robots.dev.txt",
+      },
     });
 
-    const { warnings, errors, assets } = stats.compilation;
+    const { warnings, errors } = stats.compilation;
 
     expect(warnings).toMatchSnapshot("warnings");
     expect(errors).toMatchSnapshot("errors");
-    expect(assets["robots.dev.txt"].source()).toMatchSnapshot();
+    expect(
+      // eslint-disable-next-line no-sync
+      compiler.outputFileSystem.readFileSync(
+        path.resolve(compiler.outputPath, "robots.dev.txt"),
+        "utf-8"
+      )
+    ).toMatchSnapshot();
   });
 
   it("should throw error on invalid `generate-robotstxt` options", async () => {
-    const stats = await webpack("entry.js", {
+    const { stats } = await webpack("entry.js", {
       pluginOptions: {
-        policy: {}
-      }
+        policy: {},
+      },
     });
 
     const { warnings, errors } = stats.compilation;

__tests__/__snapshots__/RobotstxtPlugin.test.js.snap

@@ -6,9 +6,9 @@ Allow: /
 "
 `;
 
-exports[`plugin should execute successfully #2: errors 1`] = `Array []`;
+exports[`plugin should execute successfully #2: errors 1`] = `[]`;
 
-exports[`plugin should execute successfully #2: warnings 1`] = `Array []`;
+exports[`plugin should execute successfully #2: warnings 1`] = `[]`;
 
 exports[`plugin should execute successfully 1`] = `
 "User-agent: *
@@ -22,18 +22,18 @@ Allow: /
 "
 `;
 
-exports[`plugin should execute successfully with \`filePath\` option: errors 1`] = `Array []`;
+exports[`plugin should execute successfully with \`filePath\` option: errors 1`] = `[]`;
 
-exports[`plugin should execute successfully with \`filePath\` option: warnings 1`] = `Array []`;
+exports[`plugin should execute successfully with \`filePath\` option: warnings 1`] = `[]`;
 
-exports[`plugin should execute successfully: errors 1`] = `Array []`;
+exports[`plugin should execute successfully: errors 1`] = `[]`;
 
-exports[`plugin should execute successfully: warnings 1`] = `Array []`;
+exports[`plugin should execute successfully: warnings 1`] = `[]`;
 
 exports[`plugin should throw error on invalid \`generate-robotstxt\` options: errors 1`] = `
-Array [
+[
   [Error: Options \`policy\` must be array],
 ]
 `;
 
-exports[`plugin should throw error on invalid \`generate-robotstxt\` options: warnings 1`] = `Array []`;
+exports[`plugin should throw error on invalid \`generate-robotstxt\` options: warnings 1`] = `[]`;

__tests__/helpers.js

@@ -4,19 +4,19 @@ import del from "del";
 import webpack from "webpack";
 import RobotstxtPlugin from "../src/RobotstxtPlugin";
 
-const outputConfig = config => ({
+const outputConfig = (config) => ({
   path: path.resolve(
     __dirname,
     `../outputs/${config.output ? config.output : ""}`
   ),
-  filename: "[name].bundle.js"
+  filename: "[name].bundle.js",
 });
 
-const moduleConfig = config => ({
-  rules: config.rules ? config.rules : []
+const moduleConfig = (config) => ({
+  rules: config.rules ? config.rules : [],
 });
 
-const pluginsConfig = config =>
+const pluginsConfig = (config) =>
   [].concat(
     config.plugins || [new RobotstxtPlugin(config.pluginOptions || {})]
   );
@@ -26,12 +26,12 @@ function compile(fixture, config = {}, options = {}) {
   // eslint-disable-next-line no-param-reassign
   config = {
     mode: "development",
-    devtool: config.devtool || "sourcemap",
+    devtool: false,
     context: path.resolve(__dirname, "fixtures"),
     entry: path.resolve(__dirname, "fixtures", fixture),
     output: outputConfig(config),
     module: moduleConfig(config),
-    plugins: pluginsConfig(config)
+    plugins: pluginsConfig(config),
   };
 
   // Compiler Options
@@ -54,7 +54,7 @@ function compile(fixture, config = {}, options = {}) {
         return reject(error);
       }
 
-      return resolve(stats);
+      return resolve({ stats, compiler });
     })
   );
 }

babel.config.js

@@ -2,7 +2,7 @@
 
 const MIN_BABEL_VERSION = 7;
 
-module.exports = api => {
+module.exports = (api) => {
   api.assertVersion(MIN_BABEL_VERSION);
   api.cache(true);
 
@@ -12,10 +12,10 @@ module.exports = api => {
         "@babel/preset-env",
         {
           targets: {
-            node: "10.13.0"
-          }
-        }
-      ]
-    ]
+            node: "10.13.0",
+          },
+        },
+      ],
+    ],
   };
 };

husky.config.js

@@ -2,6 +2,6 @@
 
 module.exports = {
   hooks: {
-    "pre-commit": "lint-staged"
-  }
+    "pre-commit": "lint-staged",
+  },
 };

jest.config.js

@@ -2,5 +2,5 @@
 
 module.exports = {
   collectCoverageFrom: ["src/**/*.{js,mjs,jsx}"],
-  testPathIgnorePatterns: ["/node_modules/", "/fixtures/", "helpers.js"]
+  testPathIgnorePatterns: ["/node_modules/", "/fixtures/", "helpers.js"],
 };

lint-staged.config.js

@@ -4,12 +4,12 @@ module.exports = {
   "*.{js,jsx}": [
     "prettier --list-different",
     "eslint --report-unused-disable-directives",
-    "git add"
+    "git add",
   ],
   "!(CHANGELOG).{md,markdown,mdown,mkdn,mkd,mdwn,mkdown,ron}": [
     "prettier --list-different",
     "remark -f -q",
-    "git add"
+    "git add",
   ],
-  "*.{yml,yaml}": ["prettier --list-different", "git add"]
+  "*.{yml,yaml}": ["prettier --list-different", "git add"],
 };