@dotcom-tool-kit/webpack 2.0.0 → 2.1.0

package/.toolkitrc.yml

@@ -2,3 +2,4 @@ hooks:
   'build:local': WebpackDevelopment
   'build:ci': WebpackProduction
   'build:remote': WebpackProduction
+  'run:local': WebpackWatch

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,qBAAqB,CAAA;AAGpD,eAAO,MAAM,KAAK,+BAA0C,CAAA"}
+{"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

@@ -4,4 +4,5 @@ exports.tasks = void 0;
 const tslib_1 = require("tslib");
 const development_1 = (0, tslib_1.__importDefault)(require("./tasks/development"));
 const production_1 = (0, tslib_1.__importDefault)(require("./tasks/production"));
-exports.tasks = [development_1.default, production_1.default];
+const watch_1 = (0, tslib_1.__importDefault)(require("./tasks/watch"));
+exports.tasks = [development_1.default, production_1.default, watch_1.default];

package/lib/run-webpack.d.ts

@@ -1,4 +1,8 @@
 import { Logger } from 'winston';
 import type { WebpackOptions } from '@dotcom-tool-kit/types/lib/schema/webpack';
-export default function runWebpack(logger: Logger, options: WebpackOptions): Promise<void>;
+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 +1 @@
-{"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,CAAC,OAAO,UAAU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CASzF"}
+{"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,CAAC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAe7G"}

package/lib/run-webpack.js

@@ -9,6 +9,9 @@ function runWebpack(logger, options) {
     if (options.configPath) {
         args.push(`--config=${options.configPath}`);
     }
+    if (options.watch) {
+        args.push('--watch');
+    }
     const child = (0, child_process_1.fork)(webpackCLIPath, args, { silent: true });
     (0, logger_1.hookFork)(logger, 'webpack', child);
     return (0, logger_1.waitOnExit)('webpack', child);

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

@@ -1 +1 @@
-{"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,SAAkB;IAE9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAM3B"}
+{"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

@@ -12,4 +12,4 @@ class WebpackDevelopment extends types_1.Task {
     }
 }
 exports.default = WebpackDevelopment;
-WebpackDevelopment.description = 'build webpack';
+WebpackDevelopment.description = 'Run Webpack in development mode';

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

@@ -1 +1 @@
-{"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,SAAkB;IAE9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAM3B"}
+{"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

@@ -12,4 +12,4 @@ class WebpackProduction extends types_1.Task {
     }
 }
 exports.default = WebpackProduction;
-WebpackProduction.description = 'build webpack';
+WebpackProduction.description = 'Run Webpack in production mode';

package/lib/tasks/watch.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,17 @@
+"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 = (0, 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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/webpack",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "main": "lib",
   "description": "",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
@@ -19,7 +19,7 @@
   "dependencies": {
     "@dotcom-tool-kit/error": "^2.0.0",
     "@dotcom-tool-kit/logger": "^2.0.0",
-    "@dotcom-tool-kit/types": "^2.0.0",
+    "@dotcom-tool-kit/types": "^2.1.0",
     "webpack-cli": "^4.6.0"
   },
   "peerDependencies": {

package/readme.md

@@ -0,0 +1,47 @@
+# @dotcom-tool-kit/webpack
+
+Tool Kit plugin to run [Webpack](https://webpack.js.org)
+
+## Installation & usage
+
+With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/webpack
+```
+
+And add it to your repo's `.toolkitrc.yml`:
+
+```yml
+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.
+
+### 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/).
+
+### 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:
+
+```yml
+plugins:
+  - '@dotcom-tool-kit/webpack'
+  - '@dotcom-tool-kit/npm'
+hooks:
+  'test:local': WebpackDevelopment
+```
+
+## Tasks
+
+| 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` |