dotcom-tool-kit 1.0.0 → 1.2.1

package/bin/run

@@ -2,33 +2,42 @@
 
 const c = require('ansi-colors')
 const argv = require('minimist')(process.argv.slice(2), {
-   boolean: ['help', 'install']
+  boolean: ['help', 'install'],
+  '--': true
 })
 
 const { runTasks, showHelp, installHooks } = require('../lib')
 const { styles } = require('../lib/messages')
 
 async function main() {
-   try {
-      if(argv.install) {
-         await installHooks()
-      } else if(argv.help || argv._.length === 0) {
-         await showHelp(argv._)
+  try {
+    if (argv.install) {
+      await installHooks()
+    } else if (argv.help || argv._.length === 0) {
+      await showHelp(argv._)
+    } else {
+      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
+        // lint-staged task is run it will identify the files that are staged
+        // and match its glob patterns and append them to the command, so that
+        // 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(argv._, argv['--'])
       } else {
-         await runTasks(argv._)
-      }
-   } catch(error) {
-      if(error.details) {
-         console.error(
-            styles.error(error.message) + '\n\n' +
-            error.details
-         )
-      } else {
-         console.error(error.stack)
+        await runTasks(argv._)
       }
+    }
+  } catch (error) {
+    if (error.details) {
+      console.error(styles.error(error.message) + '\n\n' + error.details)
+    } else {
+      console.error(error.stack)
+    }
 
-      process.exitCode = error.exitCode || 1
-   }
+    process.exitCode = error.exitCode || 1
+  }
 }
 
 main()

package/lib/config.d.ts

@@ -1,7 +1,6 @@
-import type { TaskClass } from '@dotcom-tool-kit/task';
-import type { HookTask, HookClass } from './hook';
-import { Plugin } from './plugin';
+import type { HookTask } from './hook';
 import { Conflict } from './conflict';
+import type { TaskClass, Hook, Plugin } from '@dotcom-tool-kit/types';
 export interface PluginOptions {
     options: Record<string, unknown>;
     plugin: Plugin;
@@ -22,7 +21,7 @@ export interface Config {
         [id: string]: PluginOptions | Conflict<PluginOptions> | undefined;
     };
     hooks: {
-        [id: string]: HookClass | Conflict<HookClass>;
+        [id: string]: Hook | Conflict<Hook>;
     };
 }
 export interface ValidConfig extends Config {
@@ -36,18 +35,15 @@ export interface ValidConfig extends Config {
         [id: string]: PluginOptions;
     };
     hooks: {
-        [id: string]: HookClass;
+        [id: string]: Hook;
     };
 }
-export declare function validateConfig(config: Config, { checkInstall }?: {
-    checkInstall?: boolean | undefined;
-}): Promise<ValidConfig>;
+export declare function validateConfig(config: Config): Promise<ValidConfig>;
+export declare function checkInstall(config: ValidConfig): Promise<void>;
 export declare function loadConfig(options?: {
     validate?: true;
-    checkInstall?: boolean;
 }): Promise<ValidConfig>;
 export declare function loadConfig(options?: {
     validate?: false;
-    checkInstall?: boolean;
 }): Promise<Config>;
 //# sourceMappingURL=config.d.ts.map

package/lib/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AACjD,OAAO,EAAoB,MAAM,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAmC,MAAM,YAAY,CAAA;AAYtE,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,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACjC,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,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAA;KAAE,CAAA;CACzD;AAED,MAAM,WAAW,WAAY,SAAQ,MAAM;IACzC,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,SAAS,CAAA;KAAE,CAAA;CACnC;AAmBD,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,YAAmB,EAAE;;CAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CA2FvG;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AACvG,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,EAAE,QAAQ,EAA+C,MAAM,YAAY,CAAA;AAElF,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAYrE,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,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACjC,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,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;KAAE,CAAA;CAC/C;AAED,MAAM,WAAW,WAAY,SAAQ,MAAM;IACzC,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,CAAA;KAAE,CAAA;CAC9B;AAmBD,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAyFzE;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAWrE;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC/E,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA"}

package/lib/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.validateConfig = void 0;
+exports.loadConfig = exports.checkInstall = exports.validateConfig = void 0;
 const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const plugin_1 = require("./plugin");
@@ -20,7 +20,7 @@ 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);
 }
-async function validateConfig(config, { checkInstall = true } = {}) {
+async function validateConfig(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));
@@ -53,7 +53,6 @@ async function validateConfig(config, { checkInstall = true } = {}) {
         }
     }
     const configuredHookTasks = (0, conflict_1.withoutConflicts)(Object.values(config.hookTasks));
-    const definedHooks = (0, conflict_1.withoutConflicts)(Object.values(config.hooks));
     const definedHookIds = new Set(Object.keys(config.hooks));
     const undefinedHookTasks = configuredHookTasks.filter((hookTask) => {
         // we only care about undefined hooks that were configured by the app, not default config from plugins
@@ -65,6 +64,13 @@ async function validateConfig(config, { checkInstall = true } = {}) {
         shouldThrow = true;
         error.details += (0, messages_1.formatUndefinedHookTasks)(undefinedHookTasks, Array.from(definedHookIds));
     }
+    const unusedOptions = Object.entries(config.options)
+        .filter(([, option]) => option && !(0, conflict_1.isConflict)(option) && !option.forPlugin && option.plugin.root === process.cwd())
+        .map(([id]) => id);
+    if (unusedOptions.length > 0) {
+        shouldThrow = true;
+        error.details += (0, messages_1.formatUnusedOptions)(unusedOptions, Object.keys(config.plugins));
+    }
     const missingTasks = configuredHookTasks
         .map((hook) => ({
         hook,
@@ -75,28 +81,34 @@ async function validateConfig(config, { checkInstall = true } = {}) {
         shouldThrow = true;
         error.details += (0, messages_1.formatMissingTasks)(missingTasks, Object.keys(config.tasks));
     }
-    if (checkInstall) {
-        const uninstalledHooks = await asyncFilter(definedHooks, async (Hook) => {
-            const hook = new Hook();
-            return !(await hook.check());
-        });
-        if (uninstalledHooks.length > 0) {
-            shouldThrow = true;
-            error.details += (0, messages_1.formatUninstalledHooks)(uninstalledHooks);
-        }
-    }
     if (shouldThrow) {
         throw error;
     }
     return config;
 }
 exports.validateConfig = validateConfig;
-async function loadConfig({ validate = true, checkInstall = true } = {}) {
+async function checkInstall(config) {
+    const definedHooks = (0, conflict_1.withoutConflicts)(Object.values(config.hooks));
+    const uninstalledHooks = await asyncFilter(definedHooks, async (hook) => {
+        return !(await hook.check());
+    });
+    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;
+    }
+}
+exports.checkInstall = checkInstall;
+async function loadConfig({ validate = true } = {}) {
     // start loading config and child plugins, starting from the consumer app directory
     const config = await (0, plugin_1.loadPluginConfig)({
         id: 'app root',
         root: process.cwd()
     }, createConfig());
-    return validate ? validateConfig(config, { checkInstall }) : config;
+    return validate ? validateConfig(config) : config;
 }
 exports.loadConfig = loadConfig;
+// abstract class TestBase {}
+// class Test extends TestBase {}
+// const testBase = TestBase
+// const test = new testBase()

package/lib/conflict.d.ts

@@ -1,4 +1,4 @@
-import type { Plugin } from './plugin';
+import type { Plugin } from '@dotcom-tool-kit/types';
 export interface Conflict<T> {
     plugin: Plugin;
     conflicting: T[];

package/lib/conflict.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"conflict.d.ts","sourceRoot":"","sources":["../src/conflict.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,CAAC,EAAE,CAAA;CACjB;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAElE;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAU7E;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAUtE"}
+{"version":3,"file":"conflict.d.ts","sourceRoot":"","sources":["../src/conflict.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAEpD,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,CAAC,EAAE,CAAA;CACjB;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAElE;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAU7E;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAUtE"}

package/lib/help.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAGA,wBAA8B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqDrE"}
+{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAIA,wBAA8B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAmErE"}

package/lib/help.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const config_1 = require("./config");
+const options_1 = require("@dotcom-tool-kit/options");
 const messages_1 = require("./messages");
 async function showHelp(hooks) {
     const config = await (0, config_1.loadConfig)();
     if (hooks.length === 0) {
         hooks = Object.keys(config.hooks).sort();
     }
+    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);
     const missingHooks = hooks.filter((hook) => !config.hooks[hook]);
     console.log(`
 🧰 ${messages_1.styles.title(`welcome to ${messages_1.styles.app('Tool Kit')}!`)}
@@ -16,16 +23,19 @@ Tool Kit is modern, maintainable & modular developer tooling for FT.com projects
 ${messages_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit')}
 
 ${messages_1.styles.ruler()}
-${Object.keys(config.hooks).length === 0 ? `there are no hooks available. you'll need to install plugins that define hooks to be able to run Tool Kit tasks.` : messages_1.styles.dim(hooks.length === 0
-        ? 'available hooks'
-        : `help for ${hooks.length - missingHooks.length} ${hooks.length - missingHooks.length > 1 ? 'hooks' : 'hook'}`)}:
+${Object.keys(config.hooks).length === 0
+        ? `there are no hooks available. you'll need to install plugins that define hooks to be able to run Tool Kit tasks.`
+        : messages_1.styles.dim(hooks.length === 0
+            ? 'available hooks'
+            : `help for ${hooks.length - missingHooks.length} ${hooks.length - missingHooks.length > 1 ? 'hooks' : 'hook'}`)}:
 `);
     for (const hook of hooks) {
         const Hook = config.hooks[hook];
         if (Hook) {
             const tasks = config.hookTasks[hook];
+            /* eslint-disable @typescript-eslint/no-explicit-any -- Object.constructor does not consider static properties */
             console.log(`${messages_1.styles.heading(hook)}
-${Hook.description ? Hook.description + '\n' : ''}
+${Hook.constructor.description ? Hook.constructor.description + '\n' : ''}
 ${tasks && tasks.tasks.length
                 ? `runs ${tasks.tasks.length > 1 ? 'these tasks' : 'this task'}:
 ${tasks.tasks
@@ -34,6 +44,7 @@ ${tasks.tasks
                 : messages_1.styles.dim('no tasks configured to run on this hook.')}
 ${messages_1.styles.ruler()}
 `);
+            /*eslint-enable @typescript-eslint/no-explicit-any */
         }
     }
     if (missingHooks.length) {

package/lib/hook.d.ts

@@ -1,17 +1,7 @@
-import type { Plugin } from './plugin';
+import type { Plugin } from '@dotcom-tool-kit/types';
 export interface HookTask {
     id: string;
     plugin: Plugin;
     tasks: string[];
 }
-export interface HookClass {
-    id?: string;
-    plugin?: Plugin;
-    description?: string;
-    new (): Hook;
-}
-export interface Hook {
-    check(): Promise<boolean>;
-    install(): Promise<void>;
-}
 //# sourceMappingURL=hook.d.ts.map

package/lib/hook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../src/hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,IAAI,CAAA;CACb;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB"}
+{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../src/hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAEpD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB"}

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export declare function runTasks(hooks: string[]): Promise<void>;
+export declare function runTasks(hooks: string[], files?: string[]): Promise<void>;
 export { default as showHelp } from './help';
 export { default as installHooks } from './install';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,wBAAsB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAsE7D;AAED,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,wBAAsB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA8E/E;AAED,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA"}

package/lib/index.js

@@ -7,8 +7,8 @@ exports.installHooks = exports.showHelp = exports.runTasks = void 0;
 const error_1 = require("@dotcom-tool-kit/error");
 const config_1 = require("./config");
 const messages_1 = require("./messages");
-async function runTasks(hooks) {
-    var _a;
+const options_1 = require("@dotcom-tool-kit/options");
+async function runTasks(hooks, files) {
     const config = await (0, config_1.loadConfig)();
     const availableHooks = Object.keys(config.hooks)
         .sort()
@@ -23,6 +23,12 @@ 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);
     for (const hook of hooks) {
         const errors = [];
         if (!config.hookTasks[hook]) {
@@ -32,13 +38,13 @@ ${availableHooks}`;
         const assignment = config.hookTasks[hook];
         for (const id of assignment.tasks) {
             const Task = config.tasks[id];
-            const options = Task.plugin ? (_a = config.options[Task.plugin.id]) === null || _a === void 0 ? void 0 : _a.options : {};
+            const options = Task.plugin ? (0, options_1.getOptions)(Task.plugin.id) : {};
             // `Task` is an abstract class. here we know it's a concrete subclass
             // but typescript doesn't, so cast it to any.
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             const task = new Task(options);
             try {
-                await task.run();
+                await task.run(files);
             }
             catch (error) {
                 // allow subsequent hook tasks to run on error

package/lib/install.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAA;AAE7C,wBAA8B,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CA+B5D"}
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAA;AAE7C,wBAA8B,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAmC5D"}

package/lib/install.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const error_1 = require("@dotcom-tool-kit/error");
+const options_1 = require("@dotcom-tool-kit/options");
 const config_1 = require("./config");
 async function installHooks() {
-    const config = await (0, config_1.loadConfig)({ checkInstall: false });
-    const tasks = Object.values(config.hooks).map((Hook) => async () => {
-        const hook = new Hook();
+    const config = await (0, config_1.loadConfig)();
+    const tasks = Object.values(config.hooks).map((hook) => async () => {
         if (!(await hook.check())) {
             await hook.install();
         }
     });
+    for (const pluginOptions of Object.values(config.options)) {
+        if (pluginOptions.forPlugin) {
+            (0, options_1.setOptions)(pluginOptions.forPlugin.id, pluginOptions.options);
+        }
+    }
     const errors = [];
     for (const task of tasks) {
         try {

package/lib/messages.d.ts

@@ -1,8 +1,8 @@
 import colours from 'ansi-colors';
 import type { PluginOptions } from './config';
 import type { Conflict } from './conflict';
-import type { HookTask, HookClass } from './hook';
-import type { TaskClass } from '@dotcom-tool-kit/task';
+import type { HookTask } from './hook';
+import type { Hook, TaskClass } from '@dotcom-tool-kit/types';
 declare const s: {
     hook: colours.StyleFunction;
     task: colours.StyleFunction;
@@ -21,11 +21,12 @@ declare const s: {
 };
 export { s as styles };
 export declare const formatTaskConflicts: (conflicts: Conflict<TaskClass>[]) => string;
-export declare const formatHookConflicts: (conflicts: Conflict<HookClass>[]) => string;
+export declare const formatHookConflicts: (conflicts: Conflict<Hook>[]) => 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 declare const formatUninstalledHooks: (uninstalledHooks: HookClass[]) => string;
+export declare const formatUnusedOptions: (unusedOptions: string[], definedPlugins: string[]) => string;
+export declare const formatUninstalledHooks: (uninstalledHooks: Hook[]) => string;
 declare 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,OAAO,MAAM,aAAa,CAAA;AAEjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAItD,QAAA,MAAM,CAAC;;;;;;;;;;;;oBAYW,MAAM,KAAG,MAAM;sBACb,MAAM,KAAG,MAAM;iBACtB,MAAM;CAClB,CAAA;AAED,OAAO,EAAE,CAAC,IAAI,MAAM,EAAE,CAAA;AAStB,eAAO,MAAM,mBAAmB,cAAe,SAAS,SAAS,CAAC,EAAE,KAAG,MAKE,CAAA;AASzE,eAAO,MAAM,mBAAmB,cAAe,SAAS,SAAS,CAAC,EAAE,KAAG,MAKE,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,sBAAsB,qBACf,SAAS,EAAE,KAC5B,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"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAA;AAEjC,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;AACtC,OAAO,KAAK,EAAU,IAAI,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAIrE,QAAA,MAAM,CAAC;;;;;;;;;;;;oBAYW,MAAM,KAAG,MAAM;sBACb,MAAM,KAAG,MAAM;iBACtB,MAAM;CAClB,CAAA;AAED,OAAO,EAAE,CAAC,IAAI,MAAM,EAAE,CAAA;AAStB,eAAO,MAAM,mBAAmB,cAAe,SAAS,SAAS,CAAC,EAAE,KAAG,MAKE,CAAA;AASzE,eAAO,MAAM,mBAAmB,cAAe,SAAS,IAAI,CAAC,EAAE,KAAG,MAKO,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,IAAI,EAAE,KACvB,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"}

package/lib/messages.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = exports.styles = void 0;
+exports.formatMissingTasks = exports.formatUninstalledHooks = exports.formatUnusedOptions = exports.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = exports.styles = void 0;
 const tslib_1 = require("tslib");
 const ansi_colors_1 = (0, tslib_1.__importDefault)(require("ansi-colors"));
 // consistent styling use cases for terminal colours
@@ -72,6 +72,17 @@ ${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 formatUnusedOptions = (unusedOptions, definedPlugins) => `Options are defined in your Tool Kit configuration for plugins that don't exist:
+
+${unusedOptions.map((optionName) => `- ${s.plugin(optionName)}`).join('\n')}
+
+They could be misspelt, or defined by a Tool Kit plugin that isn't installed in this app.
+
+${definedPlugins.length > 0
+    ? `Plugins that are defined and can have options set are: ${definedPlugins.map(s.plugin).join(', ')}`
+    : `There are no plugins installed currently. You'll need to install some plugins before options can be set.`}.
+`;
+exports.formatUnusedOptions = formatUnusedOptions;
 const formatUninstalledHooks = (uninstalledHooks) => `These hooks aren't installed into your app:
 
 ${uninstalledHooks.map((hook) => `- ${s.hook(hook.id || 'unknown event')}`).join('\n')}

package/lib/plugin.d.ts

@@ -1,15 +1,5 @@
-import type { TaskClass } from '@dotcom-tool-kit/task';
-import type { HookClass } from './hook';
 import { Config } from './config';
-export interface Plugin {
-    id: string;
-    root: string;
-    parent?: Plugin;
-    tasks?: TaskClass[];
-    hooks?: {
-        [id: string]: HookClass;
-    };
-}
+import { Plugin } from '@dotcom-tool-kit/types';
 export declare function loadPluginConfig(plugin: Plugin, config: Config): Promise<Config>;
 export declare function loadPlugin(id: string, config: Config, parent?: Plugin): Promise<Plugin>;
 export declare function loadPlugins(plugins: string[], config: Config, parent?: Plugin): Promise<Plugin[]>;

package/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAY,SAAS,EAAE,MAAM,QAAQ,CAAA;AAEjD,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAA;AAGhD,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE;QACN,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;KACxB,CAAA;CACF;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6FtF;AAED,wBAAsB,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA2E7F;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAEjG"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAA;AAKhD,OAAO,EAA2B,MAAM,EAAa,MAAM,wBAAwB,CAAA;AAEnF,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6FtF;AAED,wBAAsB,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAkF7F;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAEjG"}

package/lib/plugin.js

@@ -6,7 +6,10 @@ const import_from_1 = (0, tslib_1.__importDefault)(require("import-from"));
 const resolve_from_1 = (0, tslib_1.__importDefault)(require("resolve-from"));
 const lodash_mergewith_1 = (0, tslib_1.__importDefault)(require("lodash.mergewith"));
 const conflict_1 = require("./conflict");
+const messages_1 = require("./messages");
 const rc_file_1 = require("./rc-file");
+const error_1 = require("@dotcom-tool-kit/error");
+const types_1 = require("@dotcom-tool-kit/types");
 async function loadPluginConfig(plugin, config) {
     const { plugins = [], hooks = {}, options = {} } = await (0, rc_file_1.loadToolKitRC)(plugin.root);
     // load any plugins requested by this plugin
@@ -80,7 +83,17 @@ async function loadPlugin(id, config, parent) {
     const root = parent ? parent.root : process.cwd();
     // load plugin relative to the parent plugin
     const pluginRoot = (0, resolve_from_1.default)(root, id);
-    const basePlugin = (0, import_from_1.default)(root, id);
+    const rawPlugin = (0, import_from_1.default)(root, id);
+    let basePlugin;
+    try {
+        basePlugin = (0, types_1.instantiatePlugin)(rawPlugin);
+    }
+    catch (error) {
+        if (error instanceof error_1.ToolKitError) {
+            error.details = `the package ${messages_1.styles.plugin(id)} at ${messages_1.styles.filepath(pluginRoot)} is not a valid plugin`;
+        }
+        throw error;
+    }
     const plugin = {
         ...basePlugin,
         id,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "1.0.0",
+  "version": "1.2.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,7 +20,6 @@
     "test": "cd ../../ ; npx jest --silent --projects packages/cli"
   },
   "devDependencies": {
-    "@dotcom-tool-kit/task": "file:../task",
     "@jest/globals": "^26.6.2",
     "@types/lodash.mergewith": "^4.6.6",
     "@types/node": "^12.20.24",
@@ -29,8 +28,11 @@
     "ts-node": "^8.10.2"
   },
   "dependencies": {
-    "@dotcom-tool-kit/error": "^1.0.0",
-    "@dotcom-tool-kit/wait-for-ok": "^1.0.0",
+    "@dotcom-tool-kit/error": "^1.2.1",
+    "@dotcom-tool-kit/hook": "^1.2.1",
+    "@dotcom-tool-kit/options": "^1.2.1",
+    "@dotcom-tool-kit/types": "^1.2.1",
+    "@dotcom-tool-kit/wait-for-ok": "^1.2.1",
     "ansi-colors": "^4.1.1",
     "cosmiconfig": "^7.0.0",
     "import-from": "^3.0.0",