@dotcom-tool-kit/webpack 3.2.0 → 4.0.0-beta.0

package/.toolkitrc.yml

@@ -1,5 +1,10 @@
-hooks:
-  'build:local': WebpackDevelopment
-  'build:ci': WebpackProduction
-  'build:remote': WebpackProduction
-  'run:local': WebpackWatch
+tasks:
+  Webpack: './lib/tasks/webpack'
+
+commands:
+  'build:local': Webpack
+  'build:ci': Webpack
+  'build:remote': Webpack
+  'run:local': Webpack
+
+version: 2

package/lib/tasks/webpack.d.ts

@@ -0,0 +1,8 @@
+import { type WebpackSchema } from '@dotcom-tool-kit/schemas/lib/tasks/webpack';
+import { Task } from '@dotcom-tool-kit/base';
+export default class Webpack extends Task<{
+    task: typeof WebpackSchema;
+}> {
+    run(): Promise<void>;
+}
+//# sourceMappingURL=webpack.d.ts.map

package/lib/tasks/webpack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpack.d.ts","sourceRoot":"","sources":["../../src/tasks/webpack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,4CAA4C,CAAA;AAC/E,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAM5C,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,aAAa,CAAA;CAAE,CAAC;IACjE,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAuB3B"}

package/lib/tasks/webpack.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = require("@dotcom-tool-kit/base");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const child_process_1 = require("child_process");
+const webpackCLIPath = require.resolve('webpack-cli/bin/cli');
+class Webpack extends base_1.Task {
+    async run() {
+        this.logger.info('starting Webpack...');
+        const args = ['build', '--color', `--mode=${this.options.envName}`];
+        if (this.options.configPath) {
+            args.push(`--config=${this.options.configPath}`);
+        }
+        if (this.options.watch) {
+            args.push('--watch');
+        }
+        let { execArgv } = process;
+        if (process.allowedNodeEnvironmentFlags.has('--openssl-legacy-provider')) {
+            // webpack 4 uses a legacy hashing function that is no longer provided by
+            // default in OpenSSL 3: https://github.com/webpack/webpack/issues/14532
+            execArgv = [...execArgv, '--openssl-legacy-provider'];
+        }
+        const child = (0, child_process_1.fork)(webpackCLIPath, args, { silent: true, execArgv });
+        (0, logger_1.hookFork)(this.logger, 'webpack', child);
+        return (0, logger_1.waitOnExit)('webpack', child);
+    }
+}
+exports.default = Webpack;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/webpack",
-  "version": "3.2.0",
+  "version": "4.0.0-beta.0",
   "main": "lib",
   "description": "",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
@@ -17,17 +17,18 @@
     "test": "cd ../../ ; npx jest --silent --projects plugins/webpack"
   },
   "dependencies": {
-    "@dotcom-tool-kit/error": "^3.2.0",
-    "@dotcom-tool-kit/logger": "^3.4.0",
-    "@dotcom-tool-kit/types": "^3.6.0",
+    "@dotcom-tool-kit/base": "4.0.0-beta.0",
+    "@dotcom-tool-kit/error": "4.0.0-beta.0",
+    "@dotcom-tool-kit/logger": "4.0.0-beta.0",
     "webpack-cli": "^4.6.0",
     "tslib": "^2.3.1"
   },
   "peerDependencies": {
-    "webpack": "4.x.x || 5.x.x",
-    "dotcom-tool-kit": "3.x"
+    "dotcom-tool-kit": "4.0.0-beta.0",
+    "webpack": "4.x.x || 5.x.x"
   },
   "devDependencies": {
+    "@dotcom-tool-kit/schemas": "2.0.0-beta.0",
     "@jest/globals": "^27.4.6",
     "ts-node": "^10.0.0",
     "webpack": "^4.42.1",
@@ -41,7 +42,7 @@
     "extends": "../../package.json"
   },
   "engines": {
-    "node": "16.x || 18.x || 20.x",
+    "node": "18.x || 20.x",
     "npm": "7.x || 8.x || 9.x || 10.x"
   }
 }

package/readme.md

@@ -17,37 +17,40 @@ plugins:
   - '@dotcom-tool-kit/webpack'
 ```
 
-You will need plugins that provides hooks to run the `Webpack*` tasks.
-
 ### Building with Webpack locally
 
-For local development, by default the `WebpackDevelopment` task runs on the `build:local` hook, and `WebpackWatch` runs on `run:local`. One plugin that provides these hooks is [`npm`](../npm), allowing you to run Webpack with `npm run build` and `npm start`. `WebpackWatch` runs Webpack in the background, allowing it to run alongside your other tasks that run on `run:local`, which lets you run e.g. your app with the [`node`](../node) plugin in parallel with Webpack.
+For local development, by default the `WebpackDevelopment` task runs on the `build:local` command, and `WebpackWatch` runs on `run:local`. One plugin that provides these commands is [`npm`](../npm), allowing you to run Webpack with `npm run build` and `npm start`. `WebpackWatch` runs Webpack in the background, allowing it to run alongside your other tasks that run on `run:local`, which lets you run e.g. your app with the [`node`](../node) plugin in parallel with Webpack.
 
 ### Building with Webpack on CI and remote apps
 
-The `WebpackProduction` task runs on the `build:ci` and `build:remote` hooks by default. `build:ci` is for compiling an app's source in CI jobs, and is provided by plugins like [`circleci`](../circleci/). `build:remote` compiles an app for running on a production or testing server, and can be provided by plugins like [`heroku`](../heroku/).
+The `WebpackProduction` task runs on the `build:ci` and `build:remote` commands by default. `build:ci` is for compiling an app's source in CI jobs, and is provided by plugins like [`circleci`](../circleci/). `build:remote` compiles an app for running on a production or testing server, and can be provided by plugins like [`heroku`](../heroku/).
 
-### Running on another hook
-You can also configure Webpack to run on any other hook; for example, if you want to run it with `npm run test` via the `npm` plugin, you can manually configure Webpack to run on `npm`'s `test:local` hook:
+### Running on another command
+You can also configure Webpack to run on any other command; for example, if you want to run it with `npm run test` via the `npm` plugin, you can manually configure Webpack to run on `npm`'s `test:local` command:
 
 ```yml
 plugins:
   - '@dotcom-tool-kit/webpack'
   - '@dotcom-tool-kit/npm'
-hooks:
-  'test:local': WebpackDevelopment
+command:
+  'test:local':
+    Webpack:
+      mode: development
 ```
 
-## Options
+<!-- begin autogenerated docs -->
+## Tasks
+
+### `Webpack`
 
-| Key | Description | Default value |
-|-|-|-|
-| `configPath` | An optional path to your Webpack config file | none |
+Bundle code with `webpack`.
+#### Task options
 
-## Tasks
+| Property           | Description                                                                 | Type                            |
+| :----------------- | :-------------------------------------------------------------------------- | :------------------------------ |
+| `configPath`       | path to a Webpack config file. Webpack will default to `webpack.config.js`. | `string`                        |
+| **`envName`** (\*) | set Webpack's [mode](https://webpack.js.org/configuration/mode/).           | `'production' \| 'development'` |
+| `watch`            | run Webpack in watch mode                                                   | `boolean`                       |
 
-| Task | Description | Default hooks |
-|-|-|-|
-| `WebpackDevelopment` | Run Webpack in development mode | `build:local` |
-| `WebpackProduction` | Run Webpack in production mode | `build:ci`, `build:remote` |
-| `WebpackWatch` | Run Webpack in watch mode in the background | `run:local` |
+_(\*) Required._
+<!-- end autogenerated docs -->

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-import WebpackDevelopment from './tasks/development';
-export declare const tasks: (typeof WebpackDevelopment)[];
-//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,qBAAqB,CAAA;AAIpD,eAAO,MAAM,KAAK,+BAAwD,CAAA"}

package/lib/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tasks = void 0;
-const tslib_1 = require("tslib");
-const development_1 = tslib_1.__importDefault(require("./tasks/development"));
-const production_1 = tslib_1.__importDefault(require("./tasks/production"));
-const watch_1 = tslib_1.__importDefault(require("./tasks/watch"));
-exports.tasks = [development_1.default, production_1.default, watch_1.default];

package/lib/run-webpack.d.ts

@@ -1,8 +0,0 @@
-import { Logger } from 'winston';
-import type { WebpackOptions } from '@dotcom-tool-kit/types/lib/schema/webpack';
-export interface RunWebpackOptions {
-    mode: 'production' | 'development';
-    watch?: boolean;
-}
-export default function runWebpack(logger: Logger, options: WebpackOptions & RunWebpackOptions): Promise<void>;
-//# sourceMappingURL=run-webpack.d.ts.map

package/lib/run-webpack.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"run-webpack.d.ts","sourceRoot":"","sources":["../src/run-webpack.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAK/E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,YAAY,GAAG,aAAa,CAAA;IAClC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,GAAG,iBAAiB,GAC1C,OAAO,CAAC,IAAI,CAAC,CAsBf"}

package/lib/run-webpack.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = require("child_process");
-const logger_1 = require("@dotcom-tool-kit/logger");
-const webpackCLIPath = require.resolve('webpack-cli/bin/cli');
-function runWebpack(logger, options) {
-    logger.info('starting Webpack...');
-    const args = ['build', '--color', `--mode=${options.mode}`];
-    if (options.configPath) {
-        args.push(`--config=${options.configPath}`);
-    }
-    if (options.watch) {
-        args.push('--watch');
-    }
-    let { execArgv } = process;
-    if (process.allowedNodeEnvironmentFlags.has('--openssl-legacy-provider')) {
-        // webpack 4 uses a legacy hashing function that is no longer provided by
-        // default in OpenSSL 3: https://github.com/webpack/webpack/issues/14532
-        execArgv = [...execArgv, '--openssl-legacy-provider'];
-    }
-    const child = (0, child_process_1.fork)(webpackCLIPath, args, { silent: true, execArgv });
-    (0, logger_1.hookFork)(logger, 'webpack', child);
-    return (0, logger_1.waitOnExit)('webpack', child);
-}
-exports.default = runWebpack;

package/lib/tasks/development.d.ts

@@ -1,7 +0,0 @@
-import { Task } from '@dotcom-tool-kit/types';
-import { WebpackSchema } from '@dotcom-tool-kit/types/lib/schema/webpack';
-export default class WebpackDevelopment extends Task<typeof WebpackSchema> {
-    static description: string;
-    run(): Promise<void>;
-}
-//# sourceMappingURL=development.d.ts.map

package/lib/tasks/development.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"development.d.ts","sourceRoot":"","sources":["../../src/tasks/development.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAA;AAGzE,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,IAAI,CAAC,OAAO,aAAa,CAAC;IACxE,MAAM,CAAC,WAAW,SAAoC;IAEhD,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAM3B"}

package/lib/tasks/development.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const types_1 = require("@dotcom-tool-kit/types");
-const run_webpack_1 = tslib_1.__importDefault(require("../run-webpack"));
-class WebpackDevelopment extends types_1.Task {
-    async run() {
-        await (0, run_webpack_1.default)(this.logger, {
-            ...this.options,
-            mode: 'development'
-        });
-    }
-}
-exports.default = WebpackDevelopment;
-WebpackDevelopment.description = 'Run Webpack in development mode';

package/lib/tasks/production.d.ts

@@ -1,7 +0,0 @@
-import { Task } from '@dotcom-tool-kit/types';
-import { WebpackSchema } from '@dotcom-tool-kit/types/lib/schema/webpack';
-export default class WebpackProduction extends Task<typeof WebpackSchema> {
-    static description: string;
-    run(): Promise<void>;
-}
-//# sourceMappingURL=production.d.ts.map

package/lib/tasks/production.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"production.d.ts","sourceRoot":"","sources":["../../src/tasks/production.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAA;AAGzE,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,IAAI,CAAC,OAAO,aAAa,CAAC;IACvE,MAAM,CAAC,WAAW,SAAmC;IAE/C,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAM3B"}

package/lib/tasks/production.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const types_1 = require("@dotcom-tool-kit/types");
-const run_webpack_1 = tslib_1.__importDefault(require("../run-webpack"));
-class WebpackProduction extends types_1.Task {
-    async run() {
-        await (0, run_webpack_1.default)(this.logger, {
-            ...this.options,
-            mode: 'production'
-        });
-    }
-}
-exports.default = WebpackProduction;
-WebpackProduction.description = 'Run Webpack in production mode';

package/lib/tasks/watch.d.ts

@@ -1,7 +0,0 @@
-import { Task } from '@dotcom-tool-kit/types';
-import { WebpackSchema } from '@dotcom-tool-kit/types/lib/schema/webpack';
-export default class WebpackWatch extends Task<typeof WebpackSchema> {
-    static description: string;
-    run(): Promise<void>;
-}
-//# sourceMappingURL=watch.d.ts.map

package/lib/tasks/watch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/tasks/watch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAA;AAGzE,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,IAAI,CAAC,OAAO,aAAa,CAAC;IAClE,MAAM,CAAC,WAAW,SAAgD;IAE5D,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ3B"}

package/lib/tasks/watch.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const types_1 = require("@dotcom-tool-kit/types");
-const run_webpack_1 = tslib_1.__importDefault(require("../run-webpack"));
-class WebpackWatch extends types_1.Task {
-    async run() {
-        // don't wait for Webpack to exit, to leave it running in the background
-        (0, run_webpack_1.default)(this.logger, {
-            ...this.options,
-            mode: 'development',
-            watch: true
-        });
-    }
-}
-exports.default = WebpackWatch;
-WebpackWatch.description = 'Run Webpack in watch mode in the background';