dotcom-tool-kit 2.5.0 → 2.6.1

package/lib/config.d.ts

@@ -2,6 +2,7 @@ import type { Logger } from 'winston';
 import type { HookTask } from './hook';
 import { Conflict } from './conflict';
 import { TaskClass, Hook, Plugin, Validated } from '@dotcom-tool-kit/types';
+import { Options as SchemaOptions } from '@dotcom-tool-kit/types/lib/schema';
 export interface PluginOptions {
     options: Record<string, unknown>;
     plugin: Plugin;
@@ -26,27 +27,31 @@ export interface RawConfig {
         [id: string]: Hook<unknown> | Conflict<Hook<unknown>>;
     };
 }
-export declare type ValidPluginsConfig = Omit<RawConfig, 'plugins'> & {
+export type ValidPluginsConfig = Omit<RawConfig, 'plugins'> & {
     plugins: {
         [id: string]: Plugin;
     };
 };
-export interface ValidConfig extends ValidPluginsConfig {
+export type ValidPluginOptions<Id extends keyof SchemaOptions> = Omit<PluginOptions, 'options'> & {
+    options: SchemaOptions[Id];
+};
+export type ValidOptions = {
+    [Id in keyof SchemaOptions]: ValidPluginOptions<Id>;
+};
+export type ValidConfig = Omit<ValidPluginsConfig, 'tasks' | 'hookTasks' | 'options' | 'hooks'> & {
     tasks: {
         [id: string]: TaskClass;
     };
     hookTasks: {
         [id: string]: HookTask;
     };
-    options: {
-        [id: string]: PluginOptions;
-    };
+    options: ValidOptions;
     hooks: {
         [id: string]: Hook<unknown>;
     };
-}
+};
 export declare const createConfig: () => RawConfig;
-export declare function validateConfig(config: ValidPluginsConfig): asserts config is ValidConfig;
+export declare function validateConfig(config: ValidPluginsConfig, logger: Logger): ValidConfig;
 export declare function validatePlugins(config: RawConfig): Validated<ValidPluginsConfig>;
 export declare function checkInstall(config: ValidConfig): Promise<void>;
 export declare function loadConfig(logger: Logger, options?: {

package/lib/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,EAAE,QAAQ,EAA+C,MAAM,YAAY,CAAA;AAElF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAgB,MAAM,EAAmB,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAY1G,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;KAAE,CAAA;IAC5C,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAA;KAAE,CAAA;IACxD,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAA;IAC1D,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;KAAE,CAAA;IAC9E,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;KAAE,CAAA;CACjE;AAED,oBAAY,kBAAkB,GAAG,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG;IAC5D,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CAClC,CAAA;AAED,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;IAClC,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAA;IACrC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAA;IACxC,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;KAAE,CAAA;CACvC;AAID,eAAO,MAAM,YAAY,QAAO,SAQ9B,CAAA;AAQF,wBAAgB,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAuFxF;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAKhF;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAWrE;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC/F,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,EAAE,QAAQ,EAA+C,MAAM,YAAY,CAAA;AAElF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAgB,MAAM,EAAmB,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAC1G,OAAO,EAAE,OAAO,IAAI,aAAa,EAAW,MAAM,mCAAmC,CAAA;AAcrF,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;KAAE,CAAA;IAC5C,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAA;KAAE,CAAA;IACxD,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAA;IAC1D,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;KAAE,CAAA;IAC9E,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;KAAE,CAAA;CACjE;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG;IAC5D,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,EAAE,SAAS,MAAM,aAAa,IAAI,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG;IAChG,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;KACxB,EAAE,IAAI,MAAM,aAAa,GAAG,kBAAkB,CAAC,EAAE,CAAC;CACpD,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG;IAChG,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;IAClC,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAA;IACrC,OAAO,EAAE,YAAY,CAAA;IACrB,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;KAAE,CAAA;CACvC,CAAA;AAID,eAAO,MAAM,YAAY,QAAO,SAQ9B,CAAA;AAQF,wBAAgB,cAAc,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,CAkItF;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAKhF;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAWrE;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC/F,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA"}

package/lib/config.js

@@ -2,11 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfig = exports.checkInstall = exports.validatePlugins = exports.validateConfig = exports.createConfig = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const plugin_1 = require("./plugin");
 const conflict_1 = require("./conflict");
 const error_1 = require("@dotcom-tool-kit/error");
 const types_1 = require("@dotcom-tool-kit/types");
+const schema_1 = require("@dotcom-tool-kit/types/lib/schema");
 const messages_1 = require("./messages");
 const coreRoot = path_1.default.resolve(__dirname, '../');
 const createConfig = () => ({
@@ -23,7 +24,9 @@ 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);
 }
-function validateConfig(config) {
+function validateConfig(config, logger) {
+    var _a;
+    const validConfig = config;
     const hookTaskConflicts = (0, conflict_1.findConflicts)(Object.values(config.hookTasks));
     const hookConflicts = (0, conflict_1.findConflicts)(Object.values(config.hooks));
     const taskConflicts = (0, conflict_1.findConflicts)(Object.values(config.tasks));
@@ -67,6 +70,45 @@ function validateConfig(config) {
         shouldThrow = true;
         error.details += (0, messages_1.formatUndefinedHookTasks)(undefinedHookTasks, Array.from(definedHookIds));
     }
+    const invalidOptions = [];
+    for (const [id, plugin] of Object.entries(config.plugins)) {
+        const pluginId = id;
+        const pluginOptions = config.options[pluginId];
+        if (pluginOptions && (0, conflict_1.isConflict)(pluginOptions)) {
+            continue;
+        }
+        const pluginSchema = schema_1.Schemas[pluginId];
+        if (!pluginSchema) {
+            logger.silly(`skipping validation of ${pluginId} plugin as no schema can be found`);
+            continue;
+        }
+        const result = pluginSchema.safeParse((_a = pluginOptions === null || pluginOptions === void 0 ? void 0 : pluginOptions.options) !== null && _a !== void 0 ? _a : {});
+        if (result.success) {
+            // Set up options entry for plugins that don't have options specified
+            // explicitly. They could still have default options that are set by zod.
+            if (!pluginOptions) {
+                // TypeScript struggles with this type as it sees one side as
+                // `Foo<a | b | c>` and the other as `Foo<a> | Foo<b> | Foo<c>` for
+                // some reason (something to do with the record indexing) and it can't
+                // unify them. But they are equivalent so let's force it with a cast.
+                config.options[pluginId] = {
+                    options: result.data,
+                    plugin: config.plugins['app root'],
+                    forPlugin: plugin
+                }; // eslint-disable-line @typescript-eslint/no-explicit-any
+            }
+            else {
+                pluginOptions.options = result.data;
+            }
+        }
+        else {
+            invalidOptions.push([id, result.error]);
+        }
+    }
+    if (invalidOptions.length > 0) {
+        shouldThrow = true;
+        error.details += (0, messages_1.formatInvalidOptions)(invalidOptions);
+    }
     const unusedOptions = Object.entries(config.options)
         .filter(([, option]) => option && !(0, conflict_1.isConflict)(option) && !option.forPlugin && option.plugin.root === process.cwd())
         .map(([id]) => id);
@@ -87,6 +129,7 @@ function validateConfig(config) {
     if (shouldThrow) {
         throw error;
     }
+    return validConfig;
 }
 exports.validateConfig = validateConfig;
 function validatePlugins(config) {
@@ -125,9 +168,6 @@ async function loadConfig(logger, { validate = true } = {}) {
     const validPluginConfig = validatedPluginConfig.value;
     // collate root plugin and descendent hooks, options etc into config
     (0, plugin_1.resolvePlugin)(validRootPlugin, validPluginConfig, logger);
-    if (validate) {
-        validateConfig(validPluginConfig);
-    }
-    return config;
+    return validate ? validateConfig(validPluginConfig, logger) : config;
 }
 exports.loadConfig = loadConfig;

package/lib/install.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const error_1 = require("@dotcom-tool-kit/error");
 const options_1 = require("@dotcom-tool-kit/options");
-const groupBy_1 = (0, tslib_1.__importDefault)(require("lodash/groupBy"));
+const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const config_1 = require("./config");
 const postInstall_1 = require("./postInstall");
 // implementation of the Array.some method that supports asynchronous predicates

package/lib/messages.d.ts

@@ -2,14 +2,17 @@ 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 { 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;
+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;
-declare type Missing = {
+type Missing = {
     hook: HookTask;
     tasks: string[];
 };

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;AASrE,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,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,aAAK,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":"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,MAM0J,CAAA;AAE7J,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"}

package/lib/messages.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedOptions = exports.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = void 0;
+exports.formatPluginTree = exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedOptions = exports.formatInvalidOptions = exports.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = 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'))
     .join(logger_1.styles.dim(', '))}`;
@@ -52,6 +53,14 @@ ${definedHooks.length > 0
     : `There are no hooks defined by this app's plugins. You probably need to install some plugins to define hooks.`}.
 `;
 exports.formatUndefinedHookTasks = formatUndefinedHookTasks;
+const formatInvalidOptions = (invalidOptions) => `Options are defined in your Tool Kit configuration that are the wrong types:
+
+${invalidOptions
+    .map(([plugin, error]) => (0, zod_validation_error_1.fromZodError)(error, { prefix: `- ${logger_1.styles.plugin(plugin)} has the issue(s)` }).message)
+    .join('\n')}
+
+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:
 
 ${unusedOptions.map((optionName) => `- ${logger_1.styles.plugin(optionName)}`).join('\n')}

package/lib/plugin.js

@@ -4,8 +4,8 @@ exports.resolvePlugin = exports.loadPlugin = exports.validatePlugin = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const types_1 = require("@dotcom-tool-kit/types");
-const isPlainObject_1 = (0, tslib_1.__importDefault)(require("lodash/isPlainObject"));
-const resolve_from_1 = (0, tslib_1.__importDefault)(require("resolve-from"));
+const isPlainObject_1 = tslib_1.__importDefault(require("lodash/isPlainObject"));
+const resolve_from_1 = tslib_1.__importDefault(require("resolve-from"));
 const conflict_1 = require("./conflict");
 const rc_file_1 = require("./rc-file");
 function isDescendent(possibleAncestor, possibleDescendent) {
@@ -60,9 +60,10 @@ function validatePlugin(plugin) {
 }
 exports.validatePlugin = validatePlugin;
 async function importPlugin(pluginPath) {
+    var _a;
     try {
         // pluginPath is an absolute resolved path to a plugin module as found from its parent
-        const pluginModule = (await Promise.resolve().then(() => (0, tslib_1.__importStar)(require(pluginPath))));
+        const pluginModule = (await (_a = pluginPath, Promise.resolve().then(() => tslib_1.__importStar(require(_a)))));
         return validatePlugin(pluginModule);
     }
     catch (e) {

package/lib/postInstall.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.postInstall = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const fs_1 = require("fs");
 const npm_1 = require("@dotcom-tool-kit/types/lib/npm");
-const YAML = (0, tslib_1.__importStar)(require("yaml"));
-const merge_1 = (0, tslib_1.__importDefault)(require("lodash/merge"));
+const YAML = tslib_1.__importStar(require("yaml"));
+const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
 const circleci_1 = require("@dotcom-tool-kit/types/lib/circleci");
 /**
  * This step adds the tags only filter to rest of the jobs in the workflow if there is a job that contains the semverRegex.

package/lib/rc-file.js

@@ -4,7 +4,7 @@ exports.loadToolKitRC = exports.explorer = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const cosmiconfig_1 = require("cosmiconfig");
-const path = (0, tslib_1.__importStar)(require("path"));
+const path = tslib_1.__importStar(require("path"));
 exports.explorer = (0, cosmiconfig_1.cosmiconfig)('toolkit', { ignoreEmptySearchPlaces: false });
 const emptyConfig = { plugins: [], hooks: {}, options: {} };
 let rootConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "2.5.0",
+  "version": "2.6.1",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -20,20 +20,20 @@
     "test": "cd ../../ ; npx jest --silent --projects core/cli"
   },
   "devDependencies": {
+    "@dotcom-tool-kit/babel": "^2.0.14",
+    "@dotcom-tool-kit/backend-heroku-app": "^1.0.2",
+    "@dotcom-tool-kit/circleci": "^4.0.1",
+    "@dotcom-tool-kit/circleci-deploy": "^2.0.1",
+    "@dotcom-tool-kit/eslint": "^2.3.1",
+    "@dotcom-tool-kit/frontend-app": "^2.2.2",
+    "@dotcom-tool-kit/heroku": "^2.1.5",
+    "@dotcom-tool-kit/mocha": "^2.3.1",
+    "@dotcom-tool-kit/n-test": "^2.1.9",
+    "@dotcom-tool-kit/npm": "^2.0.15",
+    "@dotcom-tool-kit/webpack": "^2.1.13",
     "@jest/globals": "^27.4.6",
     "@types/lodash": "^4.14.185",
     "@types/node": "^12.20.24",
-    "@dotcom-tool-kit/backend-heroku-app": "^1.0.0",
-    "@dotcom-tool-kit/heroku": "^2.1.3",
-    "@dotcom-tool-kit/webpack": "^2.1.11",
-    "@dotcom-tool-kit/babel": "^2.0.12",
-    "@dotcom-tool-kit/circleci": "^3.0.2",
-    "@dotcom-tool-kit/npm": "^2.0.13",
-    "@dotcom-tool-kit/circleci-deploy": "^1.0.0",
-    "@dotcom-tool-kit/frontend-app": "^2.2.0",
-    "@dotcom-tool-kit/eslint": "^2.2.5",
-    "@dotcom-tool-kit/mocha": "^2.2.1",
-    "@dotcom-tool-kit/n-test": "^2.1.7",
     "chai": "^4.3.4",
     "globby": "^10.0.2",
     "ts-node": "^8.10.2",
@@ -41,16 +41,17 @@
   },
   "dependencies": {
     "@dotcom-tool-kit/error": "^2.0.1",
-    "@dotcom-tool-kit/logger": "^2.2.0",
-    "@dotcom-tool-kit/options": "^2.0.12",
-    "@dotcom-tool-kit/types": "^2.8.0",
+    "@dotcom-tool-kit/logger": "^2.2.1",
+    "@dotcom-tool-kit/options": "^2.0.14",
+    "@dotcom-tool-kit/types": "^2.9.1",
     "@dotcom-tool-kit/wait-for-ok": "^2.0.1",
     "cosmiconfig": "^7.0.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.5",
     "resolve-from": "^5.0.0",
     "tslib": "^2.3.1",
-    "yaml": "^1.10.2"
+    "yaml": "^1.10.2",
+    "zod-validation-error": "^0.3.0"
   },
   "engines": {
     "node": ">=8.0.0"