dotcom-tool-kit 3.5.0 → 4.0.0-beta.0

package/lib/index.js

@@ -1,102 +1,14 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installHooks = exports.showHelp = exports.listPlugins = exports.runTasks = exports.shouldDisableNativeFetch = void 0;
-const error_1 = require("@dotcom-tool-kit/error");
+exports.printConfig = exports.listPlugins = exports.shouldDisableNativeFetch = exports.runTasks = void 0;
+const tslib_1 = require("tslib");
 const config_1 = require("./config");
-const options_1 = require("@dotcom-tool-kit/options");
-const logger_1 = require("@dotcom-tool-kit/logger");
+const util_1 = tslib_1.__importDefault(require("util"));
 const messages_1 = require("./messages");
-// function that plugins can check if they need to implement their own logic to
-// disable Node 18's native fetch
-const shouldDisableNativeFetch = () => {
-    // disable Node 18's native fetch if the Node runtime supports it (older
-    // runtimes don't support the flag, implying they also don't use native
-    // fetch) and the user hasn't opted out of the behaviour
-    return (
-    /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion --
-     * the root plugin has default options and it always exists so is always
-     * defined
-     **/
-    !(0, options_1.getOptions)('app root').allowNativeFetch &&
-        process.allowedNodeEnvironmentFlags.has('--no-experimental-fetch'));
-};
-exports.shouldDisableNativeFetch = shouldDisableNativeFetch;
-async function runTasks(logger, hooks, files) {
-    const config = await (0, config_1.loadConfig)(logger);
-    const availableHooks = Object.keys(config.hooks)
-        .sort()
-        .map((id) => `- ${id}`)
-        .join('\n');
-    const missingHooks = hooks.filter((id) => !config.hooks[id]);
-    if (missingHooks.length > 0) {
-        const error = new error_1.ToolKitError(`hooks ${missingHooks} do not exist`);
-        error.details = `maybe you need to install a plugin to handle these hooks, or configure them in your Tool Kit configuration.
-
-hooks that are available are:
-${availableHooks}`;
-        throw error;
-    }
-    for (const pluginOptions of Object.values(config.options)) {
-        if (pluginOptions.forPlugin) {
-            (0, options_1.setOptions)(pluginOptions.forPlugin.id, pluginOptions.options);
-        }
-    }
-    await (0, config_1.checkInstall)(config);
-    if ((0, exports.shouldDisableNativeFetch)()) {
-        process.execArgv.push('--no-experimental-fetch');
-    }
-    for (const hook of hooks) {
-        const errors = [];
-        if (!config.hookTasks[hook]) {
-            logger.warn(`no task configured for ${hook}: skipping assignment...`);
-            continue;
-        }
-        const assignment = config.hookTasks[hook];
-        for (const id of assignment.tasks) {
-            const Task = config.tasks[id];
-            const options = Task.plugin ? (0, options_1.getOptions)(Task.plugin.id) : {};
-            /* eslint-disable-next-line @typescript-eslint/no-explicit-any --
-             * `Task` is an abstract class. Here we know it's a concrete subclass
-             * but typescript doesn't, so cast it to any.
-             **/
-            const task = new Task(logger, options);
-            logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(id)} task`));
-            try {
-                await task.run(files);
-            }
-            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
-                errors.push({
-                    hook,
-                    task: id,
-                    error: error
-                });
-            }
-        }
-        if (errors.length > 0) {
-            const error = new error_1.ToolKitError(`error running tasks for ${logger_1.styles.hook(hook)}`);
-            error.details = errors
-                .map(({ task, error }) => `${logger_1.styles.heading(`${logger_1.styles.task(task)}:`)}
-
-${error.message}${error instanceof error_1.ToolKitError
-                ? `
-
-${error.details}`
-                : ''}`)
-                .join(`${logger_1.styles.dim(logger_1.styles.ruler())}\n`);
-            error.exitCode = errors.length + 1;
-            throw error;
-        }
-    }
-}
-exports.runTasks = runTasks;
+var tasks_1 = require("./tasks");
+Object.defineProperty(exports, "runTasks", { enumerable: true, get: function () { return tasks_1.runTasks; } });
+var fetch_1 = require("./fetch");
+Object.defineProperty(exports, "shouldDisableNativeFetch", { enumerable: true, get: function () { return fetch_1.shouldDisableNativeFetch; } });
 async function listPlugins(logger) {
     const config = await (0, config_1.loadConfig)(logger, { validate: false });
     const rootPlugin = config.plugins['app root'];
@@ -105,7 +17,8 @@ async function listPlugins(logger) {
     }
 }
 exports.listPlugins = listPlugins;
-var help_1 = require("./help");
-Object.defineProperty(exports, "showHelp", { enumerable: true, get: function () { return __importDefault(help_1).default; } });
-var install_1 = require("./install");
-Object.defineProperty(exports, "installHooks", { enumerable: true, get: function () { return __importDefault(install_1).default; } });
+async function printConfig(logger) {
+    const config = await (0, config_1.loadConfig)(logger, { validate: false });
+    logger.info(util_1.default.inspect(config, { depth: null, colors: true }));
+}
+exports.printConfig = printConfig;

package/lib/init.d.ts

@@ -0,0 +1,4 @@
+import type { ValidConfig } from '@dotcom-tool-kit/config';
+import type { Logger } from 'winston';
+export declare function runInit(logger: Logger, config: ValidConfig): Promise<void>;
+//# sourceMappingURL=init.d.ts.map

package/lib/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAWrC,wBAAsB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhF"}

package/lib/init.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runInit = void 0;
+const base_1 = require("@dotcom-tool-kit/base");
+const validated_1 = require("@dotcom-tool-kit/validated");
+const entry_point_1 = require("./plugin/entry-point");
+const loadInitEntrypoints = async (logger, config) => {
+    const initClassResults = (0, validated_1.reduceValidated)(await Promise.all(config.inits.map((entryPoint) => (0, entry_point_1.importEntryPoint)(base_1.Init, entryPoint))));
+    return initClassResults.map((initClasses) => initClasses.map((initClass) => new initClass(logger)));
+};
+async function runInit(logger, config) {
+    const initResults = await loadInitEntrypoints(logger, config);
+    const inits = initResults.unwrap('plugin initialisation classes were invalid!');
+    await Promise.all(inits.map(async (init) => init.init()));
+}
+exports.runInit = runInit;

package/lib/install.d.ts

@@ -1,4 +1,9 @@
+import type { z } from 'zod';
 import type { Logger } from 'winston';
-import { ValidConfig } from './config';
+import type { ValidConfig } from '@dotcom-tool-kit/config';
+import { Hook } from '@dotcom-tool-kit/base';
+import { Validated } from '@dotcom-tool-kit/validated';
+export declare const loadHookInstallations: (logger: Logger, config: ValidConfig) => Promise<Validated<Hook<z.ZodType, unknown>[]>>;
+export declare function checkInstall(logger: Logger, config: ValidConfig): Promise<void>;
 export default function installHooks(logger: Logger): Promise<ValidConfig>;
 //# sourceMappingURL=install.d.ts.map

package/lib/install.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAc,WAAW,EAAE,MAAM,UAAU,CAAA;AAalD,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAyD/E"}
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAI5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAa,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AAyCvF,eAAO,MAAM,qBAAqB,WACxB,MAAM,UACN,WAAW,KAClB,QAAQ,UAAU,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,CA+B/C,CAAA;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBrF;AAED,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAuD/E"}

package/lib/install.js

@@ -1,12 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkInstall = exports.loadHookInstallations = void 0;
 const tslib_1 = require("tslib");
 const error_1 = require("@dotcom-tool-kit/error");
 const options_1 = require("@dotcom-tool-kit/options");
 const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const config_1 = require("./config");
-const postInstall_1 = require("./postInstall");
-// implementation of the Array.every method that supports asynchronous predicates
+const hash_1 = require("./config/hash");
+const base_1 = require("@dotcom-tool-kit/base");
+const validated_1 = require("@dotcom-tool-kit/validated");
+const reduce_installations_1 = require("./plugin/reduce-installations");
+const conflict_1 = require("@dotcom-tool-kit/conflict");
+const schemas_1 = require("@dotcom-tool-kit/schemas");
+const messages_1 = require("./messages");
+const entry_point_1 = require("./plugin/entry-point");
+const init_1 = require("./init");
+// implementation of the Array#every method that supports asynchronous predicates
 async function asyncEvery(arr, pred) {
     for (const val of arr) {
         if (!(await pred(val))) {
@@ -15,21 +24,74 @@ async function asyncEvery(arr, pred) {
     }
     return true;
 }
+// implementation of the Array#filter method that supports asynchronous predicates
+async function asyncFilter(items, predicate) {
+    const results = await Promise.all(items.map(async (item) => ({ item, keep: await predicate(item) })));
+    return results.filter(({ keep }) => keep).map(({ item }) => item);
+}
+const loadHookEntrypoints = async (logger, config) => {
+    const hookResultEntries = (0, validated_1.reduceValidated)(await Promise.all(Object.entries(config.hooks).map(async ([hookName, entryPoint]) => {
+        const hookResult = await (0, entry_point_1.importEntryPoint)(base_1.Hook, entryPoint);
+        return hookResult.map((hookClass) => [hookName, hookClass]);
+    })));
+    return hookResultEntries.map((hookEntries) => Object.fromEntries(hookEntries));
+};
+const loadHookInstallations = async (logger, config) => {
+    const hookClassResults = await loadHookEntrypoints(logger, config);
+    const installationResults = await hookClassResults
+        .map((hookClasses) => (0, reduce_installations_1.reducePluginHookInstallations)(logger, config, hookClasses, config.plugins['app root']))
+        .awaitValue();
+    const installationsWithoutConflicts = installationResults.flatMap((installations) => {
+        const conflicts = (0, conflict_1.findConflicts)(installations);
+        if (conflicts.length) {
+            return (0, validated_1.invalid)(conflicts.map(
+            // TODO:20240429:IM format a more helpful error message here
+            (conflict) => `conflicts between ${conflict.conflicting.map((installation) => installation.forHook).join(', ')}`));
+        }
+        return (0, validated_1.valid)((0, conflict_1.withoutConflicts)(installations));
+    });
+    return installationsWithoutConflicts.map((installations) => {
+        return installations.map(({ hookConstructor, forHook, options }) => {
+            const schema = schemas_1.HookSchemas[forHook];
+            const parsedOptions = schema ? schema.parse(options) : {};
+            return new hookConstructor(logger, forHook, parsedOptions);
+        });
+    });
+};
+exports.loadHookInstallations = loadHookInstallations;
+async function checkInstall(logger, config) {
+    if (!(await (0, hash_1.hasConfigChanged)(logger, config))) {
+        return;
+    }
+    const hooks = (await (0, exports.loadHookInstallations)(logger, config)).unwrap('hooks are invalid');
+    const uninstalledHooks = await asyncFilter(hooks, async (hook) => {
+        return !(await hook.isInstalled());
+    });
+    if (uninstalledHooks.length > 0) {
+        const error = new error_1.ToolKitError('There are problems with your Tool Kit installation.');
+        error.details = (0, messages_1.formatUninstalledHooks)(uninstalledHooks);
+        throw error;
+    }
+    await (0, hash_1.updateHashes)(config);
+}
+exports.checkInstall = checkInstall;
 async function installHooks(logger) {
     const config = await (0, config_1.loadConfig)(logger);
-    for (const pluginOptions of Object.values(config.options)) {
+    for (const pluginOptions of Object.values(config.pluginOptions)) {
         if (pluginOptions.forPlugin) {
             (0, options_1.setOptions)(pluginOptions.forPlugin.id, pluginOptions.options);
         }
     }
+    await (0, init_1.runInit)(logger, config);
     const errors = [];
+    const hooks = (await (0, exports.loadHookInstallations)(logger, config)).unwrap('hooks are invalid');
     // group hooks without an installGroup separately so that their check()
     // method runs independently
-    const groups = (0, groupBy_1.default)(config.hooks, (hook) => hook.installGroup ?? '__' + hook.id);
+    const groups = (0, groupBy_1.default)(hooks, (hook) => hook.installGroup ?? '__' + hook.id);
     for (const group of Object.values(groups)) {
         try {
-            const allChecksPassed = await asyncEvery(group, (hook) => hook.check());
-            if (!allChecksPassed) {
+            const allHooksInstalled = await asyncEvery(group, (hook) => hook.isInstalled());
+            if (!allHooksInstalled) {
                 let state = undefined;
                 for (const hook of group) {
                     state = await hook.install(state);
@@ -58,18 +120,12 @@ async function installHooks(logger) {
             }
         }
     }
-    // HACK: achieve backwards compatibility with older versions of the circleci
-    // plugin that required a postinstall function to run instead of the new
-    // commitInstall method. remove in major update of cli.
-    const usesNewCircleCIGroup = Object.keys(groups).includes('circleci');
-    if (!usesNewCircleCIGroup) {
-        await (0, postInstall_1.postInstall)(logger);
-    }
     if (errors.length) {
         const error = new error_1.ToolKitError('could not automatically install hooks:');
         error.details = errors.map((error) => `- ${error.message}`).join('\n');
         throw error;
     }
+    await (0, hash_1.updateHashes)(config);
     return config;
 }
 exports.default = installHooks;

package/lib/messages.d.ts

@@ -1,22 +1,23 @@
-import type { PluginOptions } from './config';
-import type { Conflict } from './conflict';
-import type { HookTask } from './hook';
-import type { Plugin, Hook, TaskClass } from '@dotcom-tool-kit/types';
+import type { Hook } from '@dotcom-tool-kit/base';
+import type { CommandTask, EntryPoint, Plugin, OptionsForPlugin, OptionsForTask } from '@dotcom-tool-kit/plugin';
 import type { z } from 'zod';
-export declare const formatTaskConflicts: (conflicts: Conflict<TaskClass>[]) => string;
-export declare const formatHookConflicts: (conflicts: Conflict<Hook<unknown>>[]) => string;
-export declare const formatHookTaskConflicts: (conflicts: Conflict<HookTask>[]) => string;
-export declare const formatOptionConflicts: (conflicts: Conflict<PluginOptions>[]) => string;
-export declare const formatUndefinedHookTasks: (undefinedHooks: HookTask[], definedHooks: string[]) => string;
+import type { Conflict } from '@dotcom-tool-kit/conflict';
+export declare const formatTaskConflicts: (conflicts: [string, Conflict<EntryPoint>][]) => string;
+export declare const formatHookConflicts: (conflicts: [string, Conflict<EntryPoint>][]) => string;
+export declare const formatCommandTaskConflicts: (conflicts: Conflict<CommandTask>[]) => string;
+export declare const formatPluginOptionConflicts: (conflicts: Conflict<OptionsForPlugin>[]) => string;
+export declare const formatTaskOptionConflicts: (conflicts: Conflict<OptionsForTask>[]) => string;
 export type InvalidOption = [string, z.ZodError];
 export declare const formatInvalidOptions: (invalidOptions: InvalidOption[]) => string;
-export declare const formatUnusedOptions: (unusedOptions: string[], definedPlugins: string[]) => string;
-export declare const formatUninstalledHooks: (uninstalledHooks: Hook<unknown>[]) => string;
+export declare const formatUnusedPluginOptions: (unusedOptions: string[], definedPlugins: string[]) => string;
+export declare const formatUnusedTaskOptions: (unusedOptions: string[], definedTasks: string[]) => string;
+export declare const formatUninstalledHooks: (uninstalledHooks: Hook<z.ZodTypeAny, unknown>[]) => string;
 type Missing = {
-    hook: HookTask;
-    tasks: string[];
+    command: CommandTask;
+    tasks: OptionsForTask[];
 };
 export declare const formatMissingTasks: (missingTasks: Missing[], tasks: string[]) => string;
 export declare function formatPluginTree(plugin: Plugin): string[];
+export declare const indentReasons: (reasons: string) => string;
 export {};
 //# sourceMappingURL=messages.d.ts.map

package/lib/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACrE,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAU5B,eAAO,MAAM,mBAAmB,cAAe,SAAS,SAAS,CAAC,EAAE,KAAG,MAKE,CAAA;AASzE,eAAO,MAAM,mBAAmB,cAAe,SAAS,KAAK,OAAO,CAAC,CAAC,EAAE,KAAG,MAKF,CAAA;AAazE,eAAO,MAAM,uBAAuB,cAAe,SAAS,QAAQ,CAAC,EAAE,KAAG,MAQzE,CAAA;AAOD,eAAO,MAAM,qBAAqB,cAAe,SAAS,aAAa,CAAC,EAAE,KAAG,MAU5E,CAAA;AAMD,eAAO,MAAM,wBAAwB,mBACnB,QAAQ,EAAE,gBACZ,MAAM,EAAE,KACrB,MAWF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhD,eAAO,MAAM,oBAAoB,mBACf,aAAa,EAAE,KAC9B,MAOF,CAAA;AAED,eAAO,MAAM,mBAAmB,kBACf,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAWF,CAAA;AAED,eAAO,MAAM,sBAAsB,qBACf,KAAK,OAAO,CAAC,EAAE,KAChC,MAKF,CAAA;AAED,KAAK,OAAO,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAOlD,eAAO,MAAM,kBAAkB,iBACf,OAAO,EAAE,SAChB,MAAM,EAAE,KACd,MAOF,CAAA;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAezD"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,cAAc,EACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAOzD,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAOzE,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAezE,eAAO,MAAM,0BAA0B,cAAe,SAAS,WAAW,CAAC,EAAE,KAAG,MAQ/E,CAAA;AAOD,eAAO,MAAM,2BAA2B,cAAe,SAAS,gBAAgB,CAAC,EAAE,KAAG,MAUrF,CAAA;AAOD,eAAO,MAAM,yBAAyB,cAAe,SAAS,cAAc,CAAC,EAAE,KAAG,MAUjF,CAAA;AAKD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhD,eAAO,MAAM,oBAAoB,mBACf,aAAa,EAAE,KAC9B,MAOF,CAAA;AAED,eAAO,MAAM,yBAAyB,kBACrB,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAWF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAWF,CAAA;AAED,eAAO,MAAM,sBAAsB,qBACf,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,KAC9C,MAKF,CAAA;AAED,KAAK,OAAO,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,cAAc,EAAE,CAAA;CAAE,CAAA;AAOhE,eAAO,MAAM,kBAAkB,iBACf,OAAO,EAAE,SAChB,MAAM,EAAE,KACd,MAOF,CAAA;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAezD;AAED,eAAO,MAAM,aAAa,YAAa,MAAM,KAAG,MAAwC,CAAA"}

package/lib/messages.js

@@ -1,58 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedOptions = exports.formatInvalidOptions = exports.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = void 0;
+exports.indentReasons = exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedTaskOptions = exports.formatUnusedPluginOptions = exports.formatInvalidOptions = exports.formatTaskOptionConflicts = exports.formatPluginOptionConflicts = exports.formatCommandTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = void 0;
 const logger_1 = require("@dotcom-tool-kit/logger");
 const zod_validation_error_1 = require("zod-validation-error");
-const formatTaskConflict = (conflict) => `- ${logger_1.styles.task(conflict.conflicting[0].id || 'unknown task')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
-    .map((task) => logger_1.styles.plugin(task.plugin ? task.plugin.id : 'unknown plugin'))
+const formatTaskConflict = ([key, conflict]) => `- ${logger_1.styles.task(key ?? 'unknown task')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
+    .map((entryPoint) => logger_1.styles.plugin(entryPoint.plugin.id ?? 'unknown plugin'))
     .join(logger_1.styles.dim(', '))}`;
 const formatTaskConflicts = (conflicts) => `${logger_1.styles.heading('There are multiple plugins that include the same tasks')}:
 ${conflicts.map(formatTaskConflict).join('\n')}
 
 You must resolve this conflict by removing all but one of these plugins.`;
 exports.formatTaskConflicts = formatTaskConflicts;
-const formatHookConflict = (conflict) => `- ${logger_1.styles.hook(conflict.conflicting[0].id || 'unknown event')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
-    .map((task) => logger_1.styles.plugin(task.plugin ? task.plugin.id : 'unknown plugin'))
+const formatHookConflict = ([key, conflict]) => `- ${logger_1.styles.hook(key ?? 'unknown hook')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
+    .map((entryPoint) => logger_1.styles.plugin(entryPoint.plugin.id ?? 'unknown plugin'))
     .join(logger_1.styles.dim(', '))}`;
 const formatHookConflicts = (conflicts) => `${logger_1.styles.heading('There are multiple plugins that include the same hooks')}:
 ${conflicts.map(formatHookConflict).join('\n')}
 
 You must resolve this conflict by removing all but one of these plugins.`;
 exports.formatHookConflicts = formatHookConflicts;
-const formatHookTaskConflict = (conflict) => `${logger_1.styles.hook(conflict.conflicting[0].id)}:
+const formatCommandTaskConflict = (conflict) => `${logger_1.styles.hook(conflict.conflicting[0].id)}:
 ${conflict.conflicting
-    .map((hook) => `- ${hook.tasks.map(logger_1.styles.task).join(logger_1.styles.dim(', '))} ${logger_1.styles.dim('by plugin')} ${logger_1.styles.plugin(hook.plugin.id)}`)
+    .map((command) => `- ${command.tasks.map((task) => logger_1.styles.task(task.task)).join(logger_1.styles.dim(', '))} ${logger_1.styles.dim('by plugin')} ${logger_1.styles.plugin(command.plugin.id)}`)
     .join('\n')}
 `;
-const formatHookTaskConflicts = (conflicts) => `${logger_1.styles.heading('These hooks are configured to run different tasks by multiple plugins')}:
-${conflicts.map(formatHookTaskConflict).join('\n')}
-You must resolve this conflict by explicitly configuring which task to run for these hooks. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/docs/resolving-hook-conflicts.md')} for more details.
+const formatCommandTaskConflicts = (conflicts) => `${logger_1.styles.heading('These commands are configured to run different tasks by multiple plugins')}:
+${conflicts.map(formatCommandTaskConflict).join('\n')}
+You must resolve this conflict by explicitly configuring which task to run for these commands. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/docs/resolving-hook-conflicts.md')} for more details.
 
 `;
-exports.formatHookTaskConflicts = formatHookTaskConflicts;
-const formatOptionConflict = (conflict) => `${logger_1.styles.plugin(conflict.conflicting[0].forPlugin.id)}, configured by:
+exports.formatCommandTaskConflicts = formatCommandTaskConflicts;
+const formatPluginOptionConflict = (conflict) => `${logger_1.styles.plugin(conflict.conflicting[0].forPlugin.id)}, configured by:
 ${conflict.conflicting.map((option) => `- ${logger_1.styles.plugin(option.plugin.id)}`)}`;
-const formatOptionConflicts = (conflicts) => `${logger_1.styles.heading('These plugins have conflicting options')}:
+const formatPluginOptionConflicts = (conflicts) => `${logger_1.styles.heading('These plugins have conflicting options')}:
 
-${conflicts.map(formatOptionConflict).join('\n')}
+${conflicts.map(formatPluginOptionConflict).join('\n')}
 
 You must resolve this conflict by providing options in your app's Tool Kit configuration for these plugins, or installing a use-case plugin that provides these options. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/readme.md#options')} for more details.
 
 `;
-exports.formatOptionConflicts = formatOptionConflicts;
-const formatPlugin = (plugin) => plugin.id === 'app root' ? logger_1.styles.app('your app') : `plugin ${logger_1.styles.plugin(plugin.id)}`;
-// TODO text similarity "did you mean...?"
-const formatUndefinedHookTasks = (undefinedHooks, definedHooks) => `Hooks must be defined by a plugin before you can configure a task to run for them. In your Tool Kit configuration you've configured hooks that aren't defined:
+exports.formatPluginOptionConflicts = formatPluginOptionConflicts;
+const formatTaskOptionConflict = (conflict) => `${logger_1.styles.task(conflict.conflicting[0].task)}, configured by:
+${conflict.conflicting.map((option) => `- ${logger_1.styles.plugin(option.plugin.id)}`)}`;
+const formatTaskOptionConflicts = (conflicts) => `${logger_1.styles.heading('These tasks have conflicting options')}:
 
-${undefinedHooks.map((hook) => `- ${logger_1.styles.hook(hook.id)}`).join('\n')}
+${conflicts.map(formatTaskOptionConflict).join('\n')}
 
-They could be misspelt, or defined by a Tool Kit plugin that isn't installed in this app.
+You must resolve this conflict by providing options in your app's Tool Kit configuration for these tasks, or installing a use-case plugin that provides these options. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/readme.md#options')} for more details.
 
-${definedHooks.length > 0
-    ? `Hooks that are defined and available for tasks are: ${definedHooks.map(logger_1.styles.hook).join(', ')}`
-    : `There are no hooks defined by this app's plugins. You probably need to install some plugins to define hooks.`}.
 `;
-exports.formatUndefinedHookTasks = formatUndefinedHookTasks;
+exports.formatTaskOptionConflicts = formatTaskOptionConflicts;
+const formatPlugin = (plugin) => plugin.id === 'app root' ? logger_1.styles.app('your app') : `plugin ${logger_1.styles.plugin(plugin.id)}`;
 const formatInvalidOptions = (invalidOptions) => `Options are defined in your Tool Kit configuration that are the wrong types:
 
 ${invalidOptions
@@ -62,7 +60,7 @@ ${invalidOptions
 Please update the options so that they are the expected types. You can refer to the README for the plugin for examples and descriptions of the options used.
 `;
 exports.formatInvalidOptions = formatInvalidOptions;
-const formatUnusedOptions = (unusedOptions, definedPlugins) => `Options are defined in your Tool Kit configuration for plugins that don't exist:
+const formatUnusedPluginOptions = (unusedOptions, definedPlugins) => `Options are defined in your Tool Kit configuration for plugins that don't exist:
 
 ${unusedOptions.map((optionName) => `- ${logger_1.styles.plugin(optionName)}`).join('\n')}
 
@@ -72,7 +70,18 @@ ${definedPlugins.length > 0
     ? `Plugins that are defined and can have options set are: ${definedPlugins.map(logger_1.styles.plugin).join(', ')}`
     : `There are no plugins installed currently. You'll need to install some plugins before options can be set.`}.
 `;
-exports.formatUnusedOptions = formatUnusedOptions;
+exports.formatUnusedPluginOptions = formatUnusedPluginOptions;
+const formatUnusedTaskOptions = (unusedOptions, definedTasks) => `Options are defined in your Tool Kit configuration for tasks that don't exist:
+
+${unusedOptions.map((optionName) => `- ${logger_1.styles.task(optionName)}`).join('\n')}
+
+They could be misspelt, or defined by a Tool Kit plugin that isn't installed in this app.
+
+${definedTasks.length > 0
+    ? `Task that are defined and can have options set are: ${definedTasks.map(logger_1.styles.task).join(', ')}`
+    : `You don't have currently any plugins installed that provide tasks. You'll need to install some plugins before options can be set.`}.
+`;
+exports.formatUnusedTaskOptions = formatUnusedTaskOptions;
 const formatUninstalledHooks = (uninstalledHooks) => `These hooks aren't installed into your app:
 
 ${uninstalledHooks.map((hook) => `- ${logger_1.styles.hook(hook.id || 'unknown event')}`).join('\n')}
@@ -80,7 +89,7 @@ ${uninstalledHooks.map((hook) => `- ${logger_1.styles.hook(hook.id || 'unknown e
 Run ${logger_1.styles.task('dotcom-tool-kit --install')} to install these hooks.
 `;
 exports.formatUninstalledHooks = formatUninstalledHooks;
-const formatMissingTask = (missing) => `- ${missing.tasks.map(logger_1.styles.task).join(', ')} ${logger_1.styles.dim(`(assigned to ${logger_1.styles.hook(missing.hook.id)} by ${formatPlugin(missing.hook.plugin)})`)}`;
+const formatMissingTask = (missing) => `- ${missing.tasks.map((task) => logger_1.styles.task(task.task)).join(', ')} ${logger_1.styles.dim(`(assigned to ${logger_1.styles.hook(missing.command.id)} by ${formatPlugin(missing.command.plugin)})`)}`;
 const formatMissingTasks = (missingTasks, tasks) => `These tasks don't exist, but are configured to run from hooks:
 
 ${missingTasks.map(formatMissingTask).join('\n')}
@@ -103,3 +112,5 @@ function formatPluginTree(plugin) {
     ];
 }
 exports.formatPluginTree = formatPluginTree;
+const indentReasons = (reasons) => reasons.replace(/\n/g, '\n  ');
+exports.indentReasons = indentReasons;

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

@@ -0,0 +1,7 @@
+import type { Base } from '@dotcom-tool-kit/base';
+import type { EntryPoint } from '@dotcom-tool-kit/plugin';
+import { Validated } from '@dotcom-tool-kit/validated';
+export declare function importEntryPoint<T extends {
+    name: string;
+} & Omit<typeof Base, 'new'>>(type: T, entryPoint: EntryPoint): Promise<Validated<T>>;
+//# sourceMappingURL=entry-point.d.ts.map

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

@@ -0,0 +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,EAAW,MAAM,4BAA4B,CAAA;AAU/D,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,CAAC,CAAC,CAAC,CA4CvB"}

package/lib/plugin/entry-point.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.importEntryPoint = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const validated_1 = require("@dotcom-tool-kit/validated");
+const resolve_from_1 = tslib_1.__importDefault(require("resolve-from"));
+const lodash_1 = require("lodash");
+const messages_1 = require("../messages");
+const isPlainObjectGuard = (value) => (0, lodash_1.isPlainObject)(value);
+// the subclasses of Base have different constructor signatures so we need to omit
+// the constructor from the type bound here so you can actually pass in a subclass
+async function importEntryPoint(type, entryPoint) {
+    const resolvedPath = resolve_from_1.default.silent(entryPoint.plugin.root, entryPoint.modulePath);
+    if (!resolvedPath) {
+        return (0, validated_1.invalid)([
+            `could not find entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}`
+        ]);
+    }
+    let pluginModule;
+    try {
+        pluginModule = await Promise.resolve(`${resolvedPath}`).then(s => tslib_1.__importStar(require(s)));
+    }
+    catch (e) {
+        const err = e;
+        return (0, validated_1.invalid)([
+            `an error was thrown when loading entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}:\n  ${logger_1.styles.code((0, messages_1.indentReasons)(err.toString()))}`
+        ]);
+    }
+    if (isPlainObjectGuard(pluginModule) &&
+        'default' in pluginModule &&
+        typeof pluginModule.default === 'function') {
+        const name = pluginModule.default.name;
+        return type
+            .isCompatible(pluginModule.default)
+            .mapError((reasons) => [
+            `the ${type.name.toLowerCase()} ${logger_1.styles.hook(name)} is not a compatible instance of ${logger_1.styles.code(type.name)}:\n  - ${reasons.join('\n  - ')}`
+        ]);
+    }
+    else {
+        return (0, validated_1.invalid)([
+            `entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)} does not have a ${logger_1.styles.code('default')} export`
+        ]);
+    }
+}
+exports.importEntryPoint = importEntryPoint;

package/lib/plugin/is-descendent.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '@dotcom-tool-kit/plugin';
+export declare function isDescendent(possibleAncestor: Plugin, possibleDescendent: Plugin): boolean;
+//# sourceMappingURL=is-descendent.d.ts.map

package/lib/plugin/is-descendent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-descendent.d.ts","sourceRoot":"","sources":["../../src/plugin/is-descendent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,wBAAgB,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAQ1F"}

package/lib/plugin/is-descendent.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDescendent = void 0;
+function isDescendent(possibleAncestor, possibleDescendent) {
+    if (!possibleDescendent.parent) {
+        return false;
+    }
+    else if (possibleDescendent.parent === possibleAncestor) {
+        return true;
+    }
+    else {
+        return isDescendent(possibleAncestor, possibleDescendent.parent);
+    }
+}
+exports.isDescendent = isDescendent;

package/lib/plugin/merge-commands.d.ts

@@ -0,0 +1,5 @@
+import type { Plugin } from '@dotcom-tool-kit/plugin';
+import type { ValidPluginsConfig } from '@dotcom-tool-kit/config';
+import { Logger } from 'winston';
+export declare const mergeCommands: (config: ValidPluginsConfig, plugin: Plugin, logger: Logger) => void;
+//# sourceMappingURL=merge-commands.d.ts.map

package/lib/plugin/merge-commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-commands.d.ts","sourceRoot":"","sources":["../../src/plugin/merge-commands.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAGjE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAIhC,eAAO,MAAM,aAAa,WAAY,kBAAkB,UAAU,MAAM,UAAU,MAAM,SA4DvF,CAAA"}

package/lib/plugin/merge-commands.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeCommands = void 0;
+const tslib_1 = require("tslib");
+const conflict_1 = require("@dotcom-tool-kit/conflict");
+const is_descendent_1 = require("./is-descendent");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const path_1 = tslib_1.__importDefault(require("path"));
+const mergeCommands = (config, plugin, logger) => {
+    if (plugin.rcFile) {
+        let commands = plugin.rcFile.commands;
+        // TODO:KB:20240410 remove this legacy hooks field handling and the associated
+        // field in the type definitions in a future major version
+        if (plugin.rcFile.hooks) {
+            commands = plugin.rcFile.hooks;
+            logger.warn(`${logger_1.styles.code('hooks')} is deprecated in ${logger_1.styles.filepath('.toolkitrc.yml')}. please rename ${logger_1.styles.code('hooks')} to ${logger_1.styles.code('commands')} in ${logger_1.styles.filepath(path_1.default.join(plugin.root, '.toolkitrc.yml'))}.`);
+        }
+        for (const [id, configCommandTask] of Object.entries(commands)) {
+            // handle conflicts between commands from different plugins
+            const existingCommandTask = config.commandTasks[id];
+            const newCommandTask = {
+                id,
+                plugin,
+                tasks: (Array.isArray(configCommandTask) ? configCommandTask : [configCommandTask]).flatMap((commandTask) => {
+                    if (typeof commandTask === 'string') {
+                        return [{ task: commandTask, options: {}, plugin }];
+                    }
+                    return Object.entries(commandTask).map(([task, options]) => ({ task, options, plugin }));
+                })
+            };
+            if (existingCommandTask) {
+                const existingFromDescendent = (0, is_descendent_1.isDescendent)(plugin, existingCommandTask.plugin);
+                // plugins can only override command tasks from their descendents, otherwise that's a conflict
+                // return a conflict either listing this command and the siblings,
+                // or merging in a previously-generated command
+                if (!existingFromDescendent) {
+                    const conflicting = (0, conflict_1.isConflict)(existingCommandTask)
+                        ? existingCommandTask.conflicting
+                        : [existingCommandTask];
+                    const conflict = {
+                        plugin,
+                        conflicting: conflicting.concat(newCommandTask)
+                    };
+                    config.commandTasks[id] = conflict;
+                }
+                else {
+                    // if we're here, any existing command is from a child plugin,
+                    // so the parent always overrides it
+                    config.commandTasks[id] = newCommandTask;
+                }
+            }
+            else {
+                // this command task might not have been set yet, in which case use the new one
+                config.commandTasks[id] = newCommandTask;
+            }
+        }
+    }
+};
+exports.mergeCommands = mergeCommands;

package/lib/plugin/merge-hooks.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from '@dotcom-tool-kit/plugin';
+import type { ValidPluginsConfig } from '@dotcom-tool-kit/config';
+export declare const mergeHooks: (config: ValidPluginsConfig, plugin: Plugin) => void;
+//# sourceMappingURL=merge-hooks.d.ts.map