dotcom-tool-kit 4.0.3 → 4.0.4

package/lib/install.js

@@ -13,7 +13,6 @@ 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");
@@ -40,9 +39,9 @@ const loadHookEntrypoints = async (logger, config) => {
 };
 const loadHookInstallations = async (logger, config) => {
     const hookClassResults = await loadHookEntrypoints(logger, config);
-    const installationResults = await hookClassResults
+    const installationResults = (await hookClassResults
         .map((hookClasses) => (0, reduce_installations_1.reducePluginHookInstallations)(logger, config, hookClasses, config.plugins['app root']))
-        .awaitValue();
+        .awaitValue()).flatMap((installation) => installation);
     const installationsWithoutConflicts = installationResults.flatMap((installations) => {
         const conflicts = (0, conflict_1.findConflicts)(installations);
         if (conflicts.length) {
@@ -53,11 +52,7 @@ const loadHookInstallations = async (logger, config) => {
         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);
-        });
+        return installations.map(({ hookConstructor, forHook, options }) => new hookConstructor(logger, forHook, options));
     });
 };
 exports.loadHookInstallations = loadHookInstallations;

package/lib/messages.d.ts

@@ -12,6 +12,7 @@ export declare const formatInvalidOption: ([id, error]: InvalidOption) => string
 export declare const formatInvalidPluginOptions: (invalidOptions: InvalidOption[]) => string;
 export declare const formatUnusedPluginOptions: (unusedOptions: string[], definedPlugins: string[]) => string;
 export declare const formatUnusedTaskOptions: (unusedOptions: string[], definedTasks: string[]) => string;
+export declare const formatUnusedHookOptions: (unusedOptions: string[], definedHooks: string[]) => string;
 export declare const formatUninstalledHooks: (uninstalledHooks: Hook<z.ZodTypeAny, unknown>[]) => string;
 type Missing = {
     command: CommandTask;

package/lib/messages.d.ts.map

@@ -1 +1 @@
-{"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,mBAAmB,kCAAiC,MACI,CAAA;AAErE,eAAO,MAAM,0BAA0B,mBACrB,aAAa,EAAE,KAC9B,MAKF,CAAA;AAED,eAAO,MAAM,yBAAyB,kBACrB,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,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"}
+{"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,mBAAmB,kCAAiC,MACI,CAAA;AAErE,eAAO,MAAM,0BAA0B,mBACrB,aAAa,EAAE,KAC9B,MAKF,CAAA;AAED,eAAO,MAAM,yBAAyB,kBACrB,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.indentReasons = exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedTaskOptions = exports.formatUnusedPluginOptions = exports.formatInvalidPluginOptions = exports.formatInvalidOption = exports.formatTaskOptionConflicts = exports.formatPluginOptionConflicts = exports.formatCommandTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = void 0;
+exports.indentReasons = exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedHookOptions = exports.formatUnusedTaskOptions = exports.formatUnusedPluginOptions = exports.formatInvalidPluginOptions = exports.formatInvalidOption = 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 = ([key, conflict]) => `- ${logger_1.styles.task(key ?? 'unknown task')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
@@ -19,14 +19,14 @@ ${conflicts.map(formatHookConflict).join('\n')}
 
 You must resolve this conflict by removing all but one of these plugins.`;
 exports.formatHookConflicts = formatHookConflicts;
-const formatCommandTaskConflict = (conflict) => `${logger_1.styles.hook(conflict.conflicting[0].id)}:
+const formatCommandTaskConflict = (conflict) => `${logger_1.styles.command(conflict.conflicting[0].id)}:
 ${conflict.conflicting
     .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 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.
+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-plugin-conflicts.md')} for more details.
 
 `;
 exports.formatCommandTaskConflicts = formatCommandTaskConflicts;
@@ -86,6 +86,19 @@ ${definedTasks.length > 0
     : `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 formatUnusedHookOptions = (unusedOptions, definedHooks) => `Options are defined in your Tool Kit configuration for hooks that don't exist:
+
+${unusedOptions.map((optionName) => `- ${logger_1.styles.hook(optionName)}`).join('\n')}
+
+They could be misspelt, or defined by a Tool Kit plugin that isn't installed in this app.
+
+${definedHooks.length > 0
+    ? `Hooks that are defined and can have options set are: ${definedHooks
+        .map((hook) => logger_1.styles.hook(hook))
+        .join(', ')}`
+    : `You don't have currently any plugins installed that provide hooks. You'll need to install some plugins before options can be set.`}.
+`;
+exports.formatUnusedHookOptions = formatUnusedHookOptions;
 const formatUninstalledHooks = (uninstalledHooks) => `These hooks aren't installed into your app:
 
 ${uninstalledHooks.map((hook) => `- ${logger_1.styles.hook(hook.id || 'unknown event')}`).join('\n')}
@@ -93,8 +106,8 @@ ${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((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:
+const formatMissingTask = (missing) => `- ${missing.tasks.map((task) => logger_1.styles.task(task.task)).join(', ')} ${logger_1.styles.dim(`(assigned to ${logger_1.styles.command(missing.command.id)} by ${formatPlugin(missing.command.plugin)})`)}`;
+const formatMissingTasks = (missingTasks, tasks) => `These tasks don't exist, but are configured to run from commands:
 
 ${missingTasks.map(formatMissingTask).join('\n')}
 

package/lib/plugin/reduce-installations.d.ts

@@ -1,7 +1,8 @@
 import type { Logger } from 'winston';
 import type { HookClass, HookInstallation } from '@dotcom-tool-kit/base';
-import type { Plugin } from '@dotcom-tool-kit/plugin';
 import type { ValidConfig } from '@dotcom-tool-kit/config';
 import { Conflict } from '@dotcom-tool-kit/conflict';
-export declare function reducePluginHookInstallations(logger: Logger, config: ValidConfig, hookClasses: Record<string, HookClass>, plugin: Plugin): Promise<(HookInstallation | Conflict<HookInstallation>)[]>;
+import type { Plugin } from '@dotcom-tool-kit/plugin';
+import { Validated } from '@dotcom-tool-kit/validated';
+export declare function reducePluginHookInstallations(logger: Logger, config: ValidConfig, hookClasses: Record<string, HookClass>, plugin: Plugin): Promise<Validated<(HookInstallation | Conflict<HookInstallation>)[]>>;
 //# sourceMappingURL=reduce-installations.d.ts.map

package/lib/plugin/reduce-installations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reduce-installations.d.ts","sourceRoot":"","sources":["../../src/plugin/reduce-installations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAgChE,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAwC5D"}
+{"version":3,"file":"reduce-installations.d.ts","sourceRoot":"","sources":["../../src/plugin/reduce-installations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AAiCvF,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,SAAS,CAAC,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAgEvE"}

package/lib/plugin/reduce-installations.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.reducePluginHookInstallations = void 0;
-const schemas_1 = require("@dotcom-tool-kit/schemas");
-const conflict_1 = require("@dotcom-tool-kit/conflict");
 const lodash_1 = require("lodash");
+const conflict_1 = require("@dotcom-tool-kit/conflict");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const schemas_1 = require("@dotcom-tool-kit/schemas");
+const validated_1 = require("@dotcom-tool-kit/validated");
+const messages_1 = require("../messages");
 const extractForHook = (installation) => (0, conflict_1.isConflict)(installation) ? installation.conflicting[0].forHook : installation.forHook;
 // this function recursively collects all the hook installation requests from all plugins,
 // and merges them into a single, flat array of HookInstallation objects and/or Conflicts.
@@ -32,28 +35,42 @@ const extractForHook = (installation) => (0, conflict_1.isConflict)(installation
 //     the resulting installations and/or conflicts from `Hook.mergeChildInstallations` and `p`
 async function reducePluginHookInstallations(logger, config, hookClasses, plugin) {
     if (!plugin.rcFile || config.resolutionTrackers.reducedInstallationPlugins.has(plugin.id)) {
-        return [];
+        return (0, validated_1.valid)([]);
     }
     config.resolutionTrackers.reducedInstallationPlugins.add(plugin.id);
-    const rawChildInstallations = await Promise.all((plugin.children ?? []).map((child) => reducePluginHookInstallations(logger, config, hookClasses, child))).then((installations) => installations.flat());
-    const childInstallations = Object.entries((0, lodash_1.groupBy)(rawChildInstallations, extractForHook)).flatMap(([forHook, installations]) => {
+    const rawChildInstallations = (0, validated_1.reduceValidated)(await Promise.all((plugin.children ?? []).map((child) => reducePluginHookInstallations(logger, config, hookClasses, child)))).map((installations) => installations.flat());
+    if (!rawChildInstallations.valid) {
+        return rawChildInstallations;
+    }
+    const childInstallations = Object.entries((0, lodash_1.groupBy)(rawChildInstallations.value, extractForHook)).flatMap(([forHook, installations]) => {
         const hookClass = hookClasses[forHook];
         return hookClass.mergeChildInstallations(plugin, installations);
     });
     if (plugin.rcFile.options.hooks.length === 0) {
-        return childInstallations;
+        return (0, validated_1.valid)(childInstallations);
+    }
+    const unusedHookOptions = plugin.rcFile.options.hooks
+        .flatMap(Object.keys)
+        .filter((hookId) => !(hookId in hookClasses))
+        .map((hookId) => logger_1.styles.hook(hookId));
+    if (unusedHookOptions.length > 0) {
+        return (0, validated_1.invalid)([(0, messages_1.formatUnusedHookOptions)(unusedHookOptions, Object.keys(hookClasses))]);
     }
-    return plugin.rcFile.options.hooks.flatMap((hookEntry) => Object.entries(hookEntry).flatMap(([id, configHookOptions]) => {
+    const validatedInstallations = plugin.rcFile.options.hooks.flatMap((hookEntry) => Object.entries(hookEntry).map(([id, configHookOptions]) => {
         const hookClass = hookClasses[id];
-        const parsedOptions = schemas_1.HookSchemas[id].parse(configHookOptions);
+        const parsedOptions = schemas_1.HookSchemas[id]?.safeParse(configHookOptions);
+        if (parsedOptions && !parsedOptions.success) {
+            return (0, validated_1.invalid)([(0, messages_1.formatInvalidOption)([logger_1.styles.hook(id), parsedOptions.error])]);
+        }
         const installation = {
-            options: parsedOptions,
+            options: parsedOptions ?? configHookOptions,
             plugin,
             forHook: id,
             hookConstructor: hookClass
         };
         const childInstallationsForHook = childInstallations.filter((childInstallation) => id === extractForHook(childInstallation));
-        return hookClass.overrideChildInstallations(plugin, installation, childInstallationsForHook);
+        return (0, validated_1.valid)(hookClass.overrideChildInstallations(plugin, installation, childInstallationsForHook));
     }));
+    return (0, validated_1.reduceValidated)(validatedInstallations).map((installations) => installations.flat());
 }
 exports.reducePluginHookInstallations = reducePluginHookInstallations;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",