dotcom-tool-kit 4.9.0 → 4.10.1

package/bin/run

@@ -30,7 +30,7 @@ async function main() {
       const showHelp = require('../lib/help').default
       await showHelp(rootLogger, argv._)
     } else {
-      const { runTasks } = require('../lib')
+      const { runCommands } = require('../lib')
       if (argv['--'].length > 0) {
         // The `--` in a command such as `dotcom-tool-kit test:staged --`
         // delineates between hooks and file patterns. For example, when the
@@ -39,9 +39,9 @@ async function main() {
         // the command becomes something like `dotcom-tool-kit test:staged --
         // index.js`. When this command is executed it runs the configured task
         // where the file path arguments would then be extracted.
-        await runTasks(rootLogger, argv._, argv['--'])
+        await runCommands(rootLogger, argv._, argv['--'])
       } else {
-        await runTasks(rootLogger, argv._)
+        await runCommands(rootLogger, argv._)
       }
     }
   } catch (error) {

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import type { Logger } from 'winston';
-export { runTasks } from './tasks';
+export { runCommands } from './tasks';
 export { shouldDisableNativeFetch } from './fetch';
 export declare function listPlugins(logger: Logger): Promise<void>;
 export declare function printConfig(logger: Logger): Promise<void>;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/D;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBtE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/D;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBtE"}

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldDisableNativeFetch = exports.runTasks = void 0;
+exports.shouldDisableNativeFetch = exports.runCommands = void 0;
 exports.listPlugins = listPlugins;
 exports.printConfig = printConfig;
 exports.printMergedOptions = printMergedOptions;
@@ -10,7 +10,7 @@ const util_1 = tslib_1.__importDefault(require("util"));
 const messages_1 = require("./messages");
 const install_1 = require("./install");
 var tasks_1 = require("./tasks");
-Object.defineProperty(exports, "runTasks", { enumerable: true, get: function () { return tasks_1.runTasks; } });
+Object.defineProperty(exports, "runCommands", { enumerable: true, get: function () { return tasks_1.runCommands; } });
 var fetch_1 = require("./fetch");
 Object.defineProperty(exports, "shouldDisableNativeFetch", { enumerable: true, get: function () { return fetch_1.shouldDisableNativeFetch; } });
 async function listPlugins(logger) {

package/lib/plugin/entry-point.d.ts

@@ -2,10 +2,11 @@ import type { Base } from '@dotcom-tool-kit/base';
 import type { EntryPoint } from '@dotcom-tool-kit/plugin';
 import { Validated } from '@dotcom-tool-kit/validated';
 import type * as z from 'zod';
+import type { ReadonlyDeep } from 'type-fest';
 export declare function importSchemaEntryPoint(entryPoint: EntryPoint, exportName?: string): Promise<Validated<z.ZodSchema>>;
 export declare function importEntryPoint<T extends {
     name: string;
-} & Omit<typeof Base, 'new'>>(type: T, entryPoint: EntryPoint): Promise<Validated<{
+} & Omit<typeof Base, 'new'>>(type: T, entryPoint: ReadonlyDeep<EntryPoint>): Promise<Validated<{
     baseClass: T;
     schema?: z.ZodSchema;
 }>>;

package/lib/plugin/entry-point.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAkB,MAAM,4BAA4B,CAAA;AAEtE,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAsC7B,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAYjC;AAID,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC;IAAE,SAAS,EAAE,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAA;CAAE,CAAC,CAAC,CAiC5D"}
+{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAkB,MAAM,4BAA4B,CAAA;AAEtE,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAqC7C,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAYjC;AAID,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,YAAY,CAAC,UAAU,CAAC,GACnC,OAAO,CAAC,SAAS,CAAC;IAAE,SAAS,EAAE,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAA;CAAE,CAAC,CAAC,CAiC5D"}

package/lib/tasks.d.ts

@@ -1,5 +1,16 @@
 import type { ValidConfig } from '@dotcom-tool-kit/config';
+import { Task } from '@dotcom-tool-kit/base';
+import { Validated } from '@dotcom-tool-kit/validated';
 import type { Logger } from 'winston';
-export declare function runTasksFromConfig(logger: Logger, config: ValidConfig, commands: string[], files?: string[]): Promise<void>;
-export declare function runTasks(logger: Logger, commands: string[], files?: string[]): Promise<void>;
+import { OptionsForTask } from '@dotcom-tool-kit/plugin';
+import type { ReadonlyDeep } from 'type-fest';
+export type ErrorSummary = {
+    task: string;
+    error: Error;
+};
+export declare function loadTasks(logger: Logger, tasks: OptionsForTask[], config: ReadonlyDeep<ValidConfig>): Promise<Validated<Task[]>>;
+export declare function handleTaskErrors(errors: ErrorSummary[], command: string): void;
+export declare function runTasks(logger: Logger, config: ValidConfig, tasks: Task[], command: string, files?: string[]): Promise<void>;
+export declare function runCommandsFromConfig(logger: Logger, config: ValidConfig, commands: string[], files?: string[]): Promise<void>;
+export declare function runCommands(logger: Logger, commands: string[], files?: string[]): Promise<void>;
 //# sourceMappingURL=tasks.d.ts.map

package/lib/tasks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAyDrC,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CA8Df;AAED,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIlG"}
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAmB,MAAM,uBAAuB,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AACvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAUrC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,cAAc,EAAE,EACvB,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,GAChC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAiC5B;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,MAAM,QAQvE;AAED,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EAAE,iBA8BjB;AAED,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CA6Bf;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrG"}

package/lib/tasks.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTasksFromConfig = runTasksFromConfig;
+exports.loadTasks = loadTasks;
+exports.handleTaskErrors = handleTaskErrors;
 exports.runTasks = runTasks;
+exports.runCommandsFromConfig = runCommandsFromConfig;
+exports.runCommands = runCommands;
 const tslib_1 = require("tslib");
 const base_1 = require("@dotcom-tool-kit/base");
 const validated_1 = require("@dotcom-tool-kit/validated");
@@ -15,8 +18,8 @@ const init_1 = require("./init");
 const messages_1 = require("./messages");
 const schemas_1 = require("@dotcom-tool-kit/schemas");
 const pluralize_1 = tslib_1.__importDefault(require("pluralize"));
-const loadTasks = async (logger, tasks, config) => {
-    const taskResults = await Promise.all(tasks.map(async ({ task: taskId, options }) => {
+async function loadTasks(logger, tasks, config) {
+    const taskResults = await Promise.all(tasks.map(async ({ task: taskId, options, plugin }) => {
         const entryPoint = config.tasks[taskId];
         const taskResult = await (0, entry_point_1.importEntryPoint)(base_1.Task, entryPoint);
         return taskResult.flatMap((taskModule) => {
@@ -27,7 +30,7 @@ const loadTasks = async (logger, tasks, config) => {
                 data: mergedOptions
             };
             if (parsedOptions.success) {
-                const task = new taskModule.baseClass(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data);
+                const task = new taskModule.baseClass(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data, plugin);
                 return (0, validated_1.valid)(task);
             }
             else {
@@ -36,8 +39,41 @@ const loadTasks = async (logger, tasks, config) => {
         });
     }));
     return (0, validated_1.reduceValidated)(taskResults);
-};
-async function runTasksFromConfig(logger, config, commands, files) {
+}
+function handleTaskErrors(errors, command) {
+    throw new AggregateError(errors.map(({ task, error }) => {
+        error.name = `${logger_1.styles.task(task)} → ${error.name}`;
+        return error;
+    }), `${(0, pluralize_1.default)('error', errors.length, true)} running tasks for ${logger_1.styles.command(command)}`);
+}
+async function runTasks(logger, config, tasks, command, files) {
+    const errors = [];
+    if (tasks.length === 0) {
+        logger.warn(`no task configured for ${command}: skipping assignment...`);
+    }
+    for (const task of tasks) {
+        try {
+            logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(task.id)} task`));
+            await task.run({ files, command, cwd: config.root, config });
+        }
+        catch (error) {
+            // if there's an exit code, that's a request from the task to exit early
+            if (error instanceof error_1.ToolKitError && error.exitCode) {
+                throw error;
+            }
+            // if not, we allow subsequent hook tasks to run on error
+            // TODO use validated for this
+            errors.push({
+                task: task.id,
+                error: error
+            });
+        }
+    }
+    if (errors.length > 0) {
+        handleTaskErrors(errors, command);
+    }
+}
+async function runCommandsFromConfig(logger, config, commands, files) {
     await (0, init_1.runInit)(logger, config);
     await (0, install_1.checkInstall)(logger, config);
     if ((0, fetch_1.shouldDisableNativeFetch)(config.pluginOptions['app root'].options) &&
@@ -53,37 +89,10 @@ async function runTasksFromConfig(logger, config, commands, files) {
     // passing it into task run contexts so that plugins can't do crimes
     Object.freeze(config);
     for (const { command, tasks } of commandTasks) {
-        const errors = [];
-        if (tasks.length === 0) {
-            logger.warn(`no task configured for ${command}: skipping assignment...`);
-        }
-        for (const task of tasks) {
-            try {
-                logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(task.id)} task`));
-                await task.run({ files, command, cwd: config.root, config });
-            }
-            catch (error) {
-                // if there's an exit code, that's a request from the task to exit early
-                if (error instanceof error_1.ToolKitError && error.exitCode) {
-                    throw error;
-                }
-                // if not, we allow subsequent hook tasks to run on error
-                // TODO use validated for this
-                errors.push({
-                    task: task.id,
-                    error: error
-                });
-            }
-        }
-        if (errors.length > 0) {
-            throw new AggregateError(errors.map(({ task, error }) => {
-                error.name = `${logger_1.styles.task(task)} → ${error.name}`;
-                return error;
-            }), `${(0, pluralize_1.default)('error', errors.length, true)} running tasks for ${logger_1.styles.command(command)}`);
-        }
+        await runTasks(logger, config, tasks, command, files);
     }
 }
-async function runTasks(logger, commands, files) {
+async function runCommands(logger, commands, files) {
     const config = await (0, config_1.loadConfig)(logger, { root: process.cwd() });
-    return runTasksFromConfig(logger, config, commands, files);
+    return runCommandsFromConfig(logger, config, commands, files);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "4.9.0",
+  "version": "4.10.1",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -25,11 +25,12 @@
     "@types/lodash": "^4.17.20",
     "@types/pluralize": "^0.0.33",
     "globby": "^10.0.2",
+    "type-fest": "^4.41.0",
     "winston": "^3.17.0",
     "zod": "^3.24.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "^1.2.3",
+    "@dotcom-tool-kit/base": "^1.3.1",
     "@dotcom-tool-kit/config": "^1.1.1",
     "@dotcom-tool-kit/conflict": "^1.0.1",
     "@dotcom-tool-kit/error": "^4.1.1",