dotcom-tool-kit 2.0.0 → 2.2.0

package/bin/run

@@ -1,17 +1,19 @@
 #!/usr/bin/env node
 
 const argv = require('minimist')(process.argv.slice(2), {
-  boolean: ['help', 'install'],
+  boolean: ['help', 'install', 'listPlugins'],
   '--': true
 })
 
-const { runTasks, showHelp, installHooks } = require('../lib')
+const { runTasks, showHelp, installHooks, listPlugins } = require('../lib')
 const { rootLogger, styles } = require('@dotcom-tool-kit/logger')
 
 async function main() {
   try {
     if (argv.install) {
       await installHooks(rootLogger)
+    } else if (argv.listPlugins) {
+      await listPlugins(rootLogger)
     } else if (argv.help || argv._.length === 0) {
       await showHelp(rootLogger, argv._)
     } else {

package/lib/config.d.ts

@@ -1,7 +1,7 @@
 import type { Logger } from 'winston';
 import type { HookTask } from './hook';
 import { Conflict } from './conflict';
-import type { TaskClass, Hook, Plugin } from '@dotcom-tool-kit/types';
+import { TaskClass, Hook, Plugin } from '@dotcom-tool-kit/types';
 export interface PluginOptions {
     options: Record<string, unknown>;
     plugin: Plugin;
@@ -12,6 +12,7 @@ export interface Config {
     plugins: {
         [id: string]: Plugin;
     };
+    resolvedPlugins: Set<Plugin>;
     tasks: {
         [id: string]: TaskClass | Conflict<TaskClass>;
     };
@@ -39,7 +40,8 @@ export interface ValidConfig extends Config {
         [id: string]: Hook;
     };
 }
-export declare function validateConfig(config: Config): Promise<ValidConfig>;
+export declare const createConfig: () => Config;
+export declare function validateConfig(config: Config): asserts config is ValidConfig;
 export declare function checkInstall(config: ValidConfig): Promise<void>;
 export declare function loadConfig(logger: Logger, options?: {
     validate?: true;

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,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,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,MAAM,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,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAYhE,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,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,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;AAID,eAAO,MAAM,YAAY,QAAO,MAQ9B,CAAA;AAQF,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAuF5E;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,MAAM,CAAC,CAAA"}

package/lib/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.checkInstall = exports.validateConfig = void 0;
+exports.loadConfig = exports.checkInstall = exports.validateConfig = exports.createConfig = void 0;
 const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const plugin_1 = require("./plugin");
@@ -11,16 +11,18 @@ const coreRoot = path_1.default.resolve(__dirname, '../');
 const createConfig = () => ({
     root: coreRoot,
     plugins: {},
+    resolvedPlugins: new Set(),
     tasks: {},
     hookTasks: {},
     options: {},
     hooks: {}
 });
+exports.createConfig = createConfig;
 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) {
+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));
@@ -84,7 +86,6 @@ async function validateConfig(config) {
     if (shouldThrow) {
         throw error;
     }
-    return config;
 }
 exports.validateConfig = validateConfig;
 async function checkInstall(config) {
@@ -100,15 +101,14 @@ async function checkInstall(config) {
 }
 exports.checkInstall = checkInstall;
 async function loadConfig(logger, { validate = true } = {}) {
+    const config = (0, exports.createConfig)();
     // start loading config and child plugins, starting from the consumer app directory
-    const config = await (0, plugin_1.loadPluginConfig)(logger, {
-        id: 'app root',
-        root: process.cwd()
-    }, createConfig());
-    return validate ? validateConfig(config) : config;
+    const rootPlugin = await (0, plugin_1.loadPlugin)('app root', config, logger);
+    // collate root plugin and descendent hooks, options etc into config
+    (0, plugin_1.resolvePlugin)(rootPlugin, config, logger);
+    if (validate) {
+        validateConfig(config);
+    }
+    return config;
 }
 exports.loadConfig = loadConfig;
-// abstract class TestBase {}
-// class Test extends TestBase {}
-// const testBase = TestBase
-// const test = new testBase()

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import type { Logger } from 'winston';
 export declare function runTasks(logger: Logger, hooks: string[], files?: string[]): Promise<void>;
+export declare function listPlugins(logger: Logger): 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":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAQrC,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA8E/F;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":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AASrC,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA8E/F;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA"}

package/lib/index.js

@@ -3,11 +3,12 @@ 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.runTasks = void 0;
+exports.installHooks = exports.showHelp = exports.listPlugins = exports.runTasks = void 0;
 const error_1 = require("@dotcom-tool-kit/error");
 const config_1 = require("./config");
 const options_1 = require("@dotcom-tool-kit/options");
 const logger_1 = require("@dotcom-tool-kit/logger");
+const messages_1 = require("./messages");
 async function runTasks(logger, hooks, files) {
     const config = await (0, config_1.loadConfig)(logger);
     const availableHooks = Object.keys(config.hooks)
@@ -72,6 +73,14 @@ ${error.details}`
     }
 }
 exports.runTasks = runTasks;
+async function listPlugins(logger) {
+    const config = await (0, config_1.loadConfig)(logger, { validate: false });
+    const rootPlugin = config.plugins['app root'];
+    if (rootPlugin) {
+        logger.info((0, messages_1.formatPluginTree)(rootPlugin).join('\n'));
+    }
+}
+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");

package/lib/messages.d.ts

@@ -1,7 +1,7 @@
 import type { PluginOptions } from './config';
 import type { Conflict } from './conflict';
 import type { HookTask } from './hook';
-import type { Hook, TaskClass } from '@dotcom-tool-kit/types';
+import type { Plugin, Hook, TaskClass } from '@dotcom-tool-kit/types';
 export declare const formatTaskConflicts: (conflicts: Conflict<TaskClass>[]) => string;
 export declare const formatHookConflicts: (conflicts: Conflict<Hook>[]) => string;
 export declare const formatHookTaskConflicts: (conflicts: Conflict<HookTask>[]) => string;
@@ -14,5 +14,6 @@ declare type Missing = {
     tasks: string[];
 };
 export declare const formatMissingTasks: (missingTasks: Missing[], tasks: string[]) => string;
+export declare function formatPluginTree(plugin: Plugin): 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,EAAU,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,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"}
+{"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,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;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAezD"}

package/lib/messages.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.formatUndefinedHookTasks = exports.formatOptionConflicts = exports.formatHookTaskConflicts = exports.formatHookConflicts = exports.formatTaskConflicts = void 0;
 const logger_1 = require("@dotcom-tool-kit/logger");
 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'))
@@ -80,3 +80,17 @@ They could be misspelt, or defined by a Tool Kit plugin that isn't used by this
 Available tasks are: ${tasks.map(logger_1.styles.task).join(', ')}.
 `;
 exports.formatMissingTasks = formatMissingTasks;
+function formatPluginTree(plugin) {
+    var _a;
+    return [
+        logger_1.styles.plugin(plugin.id),
+        ...((_a = plugin.children) !== null && _a !== void 0 ? _a : []).flatMap((child, childIndex, children) => formatPluginTree(child).map((line, lineIndex) => lineIndex === 0
+            ? childIndex === children.length - 1
+                ? `└ ${line}`
+                : `├ ${line}`
+            : childIndex === children.length - 1
+                ? `  ${line}`
+                : `│ ${line}`))
+    ];
+}
+exports.formatPluginTree = formatPluginTree;

package/lib/plugin.d.ts

@@ -1,7 +1,7 @@
 import type { Logger } from 'winston';
 import { Config } from './config';
-import { Plugin } from '@dotcom-tool-kit/types';
-export declare function loadPluginConfig(logger: Logger, plugin: Plugin, config: Config): Promise<Config>;
-export declare function loadPlugin(logger: Logger, id: string, config: Config, parent?: Plugin): Promise<Plugin>;
-export declare function loadPlugins(logger: Logger, plugins: string[], config: Config, parent?: Plugin): Promise<Plugin[]>;
+import { Plugin, PluginModule } from '@dotcom-tool-kit/types';
+export declare function validatePlugin(plugin: unknown): asserts plugin is PluginModule;
+export declare function loadPlugin(id: string, config: Config, logger: Logger, parent?: Plugin): Promise<Plugin>;
+export declare function resolvePlugin(plugin: Plugin, config: Config, logger: Logger): void;
 //# sourceMappingURL=plugin.d.ts.map

package/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,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,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6FtG;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAkFjB;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,EAAE,CAAC,CAEnB"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAA;AAIhD,OAAO,EAAQ,MAAM,EAAE,YAAY,EAAQ,MAAM,wBAAwB,CAAA;AAezE,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,IAAI,YAAY,CAmB9E;AASD,wBAAsB,UAAU,CAC9B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAmCjB;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAsIlF"}

package/lib/plugin.js

@@ -1,138 +1,186 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPlugins = exports.loadPlugin = exports.loadPluginConfig = void 0;
+exports.resolvePlugin = exports.loadPlugin = exports.validatePlugin = void 0;
 const tslib_1 = require("tslib");
-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 rc_file_1 = require("./rc-file");
 const error_1 = require("@dotcom-tool-kit/error");
-const logger_1 = require("@dotcom-tool-kit/logger");
 const types_1 = require("@dotcom-tool-kit/types");
-async function loadPluginConfig(logger, plugin, config) {
-    const { plugins = [], hooks = {}, options = {} } = await (0, rc_file_1.loadToolKitRC)(plugin.root);
-    // load any plugins requested by this plugin
-    await loadPlugins(logger, plugins, config, plugin);
-    // load plugin hook tasks. do this after loading child plugins, so
-    // parent hooks get assigned after child hooks and can override them
-    (0, lodash_mergewith_1.default)(config.hookTasks, hooks, 
-    // handle conflicts between hooks from different plugins
-    (existingHookTask, configHookTask, id) => {
-        const newHookTask = {
-            id,
-            plugin,
-            tasks: Array.isArray(configHookTask) ? configHookTask : [configHookTask]
-        };
-        // this hook task might not have been set yet, in which case use the new one
-        if (!existingHookTask) {
-            return newHookTask;
-        }
-        const existingFromSibling = existingHookTask.plugin.parent && existingHookTask.plugin.parent === plugin.parent;
-        // if the existing hook was from a sibling, that's a conflict
-        // return a conflict either listing this hook and the siblings,
-        // or merging in a previously-generated hook
-        if (existingFromSibling) {
-            const conflicting = (0, conflict_1.isConflict)(existingHookTask) ? existingHookTask.conflicting : [existingHookTask];
-            const conflict = {
-                plugin,
-                conflicting: conflicting.concat(newHookTask)
-            };
-            return conflict;
-        }
-        // if we're here, any existing hook is from a child plugin,
-        // so the parent always overrides it
-        return newHookTask;
-    });
-    // merge options from this plugin's config with any options we've collected already
-    // TODO this is almost the exact same code as for hooks, refactor
-    (0, lodash_mergewith_1.default)(config.options, options, (existingOptions, configOptions, id) => {
-        const pluginOptions = {
-            options: configOptions,
-            plugin,
-            forPlugin: config.plugins[id]
-        };
-        // this options key might not have been set yet, in which case use the new one
-        if (!existingOptions) {
-            return pluginOptions;
-        }
-        const existingFromSibling = existingOptions.plugin.parent && existingOptions.plugin.parent === plugin.parent;
-        // if the existing options were from a sibling, that's a conflict
-        // return a conflict either listing these options and the sibling's,
-        // or merging in previously-generated options
-        if (existingFromSibling) {
-            const conflicting = (0, conflict_1.isConflict)(existingOptions) ? existingOptions.conflicting : [existingOptions];
-            const conflict = {
-                plugin,
-                conflicting: conflicting.concat(pluginOptions)
-            };
-            return conflict;
-        }
-        // if we're here, any existing options are from a child plugin,
-        // so merge in overrides from the parent
-        return { ...existingOptions, ...pluginOptions };
-    });
-    return config;
+const lodash_isplainobject_1 = (0, tslib_1.__importDefault)(require("lodash.isplainobject"));
+function isDescendent(possibleAncestor, possibleDescendent) {
+    if (!possibleDescendent.parent) {
+        return false;
+    }
+    else if (possibleDescendent.parent === possibleAncestor) {
+        return true;
+    }
+    else {
+        return isDescendent(possibleAncestor, possibleDescendent.parent);
+    }
+}
+function validatePlugin(plugin) {
+    const rawPlugin = plugin;
+    if (rawPlugin.tasks &&
+        !(Array.isArray(rawPlugin.tasks) && rawPlugin.tasks.every((task) => task.prototype instanceof types_1.Task))) {
+        throw new error_1.ToolKitError('tasks are not valid');
+    }
+    if (rawPlugin.hooks &&
+        !((0, lodash_isplainobject_1.default)(rawPlugin.hooks) &&
+            Object.values(rawPlugin.hooks).every((hook) => hook.prototype instanceof types_1.Hook))) {
+        throw new error_1.ToolKitError('hooks are not valid');
+    }
 }
-exports.loadPluginConfig = loadPluginConfig;
-async function loadPlugin(logger, id, config, parent) {
+exports.validatePlugin = validatePlugin;
+async function importPlugin(pluginPath) {
+    // 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)));
+    validatePlugin(pluginModule);
+    return pluginModule;
+}
+async function loadPlugin(id, config, logger, parent) {
     // don't load duplicate plugins
     if (id in config.plugins) {
         return config.plugins[id];
     }
-    const root = parent ? parent.root : process.cwd();
     // load plugin relative to the parent plugin
-    const pluginRoot = (0, resolve_from_1.default)(root, id);
-    const rawPlugin = (0, import_from_1.default)(root, id);
-    let basePlugin;
-    try {
-        basePlugin = (0, types_1.instantiatePlugin)(rawPlugin, logger);
-    }
-    catch (error) {
-        if (error instanceof error_1.ToolKitError) {
-            error.details = `the package ${logger_1.styles.plugin(id)} at ${logger_1.styles.filepath(pluginRoot)} is not a valid plugin`;
-        }
-        throw error;
-    }
+    const root = parent ? parent.root : process.cwd();
+    const pluginRoot = id === 'app root' ? root : (0, resolve_from_1.default)(root, id);
     const plugin = {
-        ...basePlugin,
         id,
         root: pluginRoot,
         parent
     };
     config.plugins[id] = plugin;
-    // add plugin tasks to our task registry, handling any conflicts
-    (0, lodash_mergewith_1.default)(config.tasks, Object.fromEntries((plugin.tasks || []).map((task) => [task.name, task])), (existingTask, newTask, taskId) => {
-        newTask.plugin = plugin;
-        newTask.id = taskId;
-        if (!existingTask) {
-            return newTask;
-        }
-        const conflicting = (0, conflict_1.isConflict)(existingTask) ? existingTask.conflicting : [existingTask];
-        return {
-            plugin,
-            conflicting: conflicting.concat(newTask)
-        };
-    });
-    // add hooks to the registry, handling any conflicts
-    // TODO refactor with command conflict handler
-    (0, lodash_mergewith_1.default)(config.hooks, plugin.hooks, (existingHook, newHook, hookId) => {
-        newHook.id = hookId;
-        newHook.plugin = plugin;
-        if (!existingHook) {
-            return newHook;
-        }
-        const conflicting = (0, conflict_1.isConflict)(existingHook) ? existingHook.conflicting : [existingHook];
-        return {
-            plugin,
-            conflicting: conflicting.concat(newHook)
-        };
-    });
-    await loadPluginConfig(logger, plugin, config);
+    // start loading rc file in the background
+    const rcFilePromise = (0, rc_file_1.loadToolKitRC)(pluginRoot);
+    // start loading module in the background
+    const pluginModulePromise = id === 'app root' ? Promise.resolve(undefined) : importPlugin(pluginRoot);
+    plugin.rcFile = await rcFilePromise;
+    // start loading child plugins in the background
+    const childrenPromise = Promise.all(plugin.rcFile.plugins.map((child) => loadPlugin(child, config, logger, plugin)));
+    [plugin.module, plugin.children] = await Promise.all([pluginModulePromise, childrenPromise]);
     return plugin;
 }
 exports.loadPlugin = loadPlugin;
-function loadPlugins(logger, plugins, config, parent) {
-    return Promise.all(plugins.map((plugin) => loadPlugin(logger, plugin, config, parent)));
+function resolvePlugin(plugin, config, logger) {
+    // don't resolve plugins that have already been resolved to prevent self-conflicts
+    // between plugins included at multiple points in the tree
+    if (config.resolvedPlugins.has(plugin)) {
+        return;
+    }
+    if (plugin.children) {
+        // resolve child plugins first so parents can override the things their children set
+        for (const child of plugin.children) {
+            resolvePlugin(child, config, logger);
+        }
+    }
+    if (plugin.module) {
+        // add plugin tasks to our task registry, handling any conflicts
+        for (const newTask of plugin.module.tasks || []) {
+            const taskId = newTask.name;
+            const existingTask = config.tasks[taskId];
+            newTask.plugin = plugin;
+            newTask.id = taskId;
+            if (existingTask) {
+                const conflicting = (0, conflict_1.isConflict)(existingTask) ? existingTask.conflicting : [existingTask];
+                config.tasks[taskId] = {
+                    plugin,
+                    conflicting: conflicting.concat(newTask)
+                };
+            }
+            else {
+                config.tasks[taskId] = newTask;
+            }
+        }
+        // add hooks to the registry, handling any conflicts
+        // TODO refactor with command conflict handler
+        for (const [hookId, hookClass] of Object.entries(plugin.module.hooks || [])) {
+            const existingHook = config.hooks[hookId];
+            const newHook = new hookClass(logger);
+            newHook.id = hookId;
+            newHook.plugin = plugin;
+            if (existingHook) {
+                const conflicting = (0, conflict_1.isConflict)(existingHook) ? existingHook.conflicting : [existingHook];
+                config.hooks[hookId] = {
+                    plugin,
+                    conflicting: conflicting.concat(newHook)
+                };
+            }
+            else {
+                config.hooks[hookId] = newHook;
+            }
+        }
+    }
+    if (plugin.rcFile) {
+        // load plugin hook tasks. do this after loading child plugins, so
+        // parent hooks get assigned after child hooks and can override them
+        for (const [id, configHookTask] of Object.entries(plugin.rcFile.hooks)) {
+            // handle conflicts between hooks from different plugins
+            const existingHookTask = config.hookTasks[id];
+            const newHookTask = {
+                id,
+                plugin,
+                tasks: Array.isArray(configHookTask) ? configHookTask : [configHookTask]
+            };
+            if (existingHookTask) {
+                const existingFromDescendent = isDescendent(plugin, existingHookTask.plugin);
+                // plugins can only override hook tasks from their descendents, otherwise that's a conflict
+                // return a conflict either listing this hook and the siblings,
+                // or merging in a previously-generated hook
+                if (!existingFromDescendent) {
+                    const conflicting = (0, conflict_1.isConflict)(existingHookTask) ? existingHookTask.conflicting : [existingHookTask];
+                    const conflict = {
+                        plugin,
+                        conflicting: conflicting.concat(newHookTask)
+                    };
+                    config.hookTasks[id] = conflict;
+                }
+                else {
+                    // if we're here, any existing hook is from a child plugin,
+                    // so the parent always overrides it
+                    config.hookTasks[id] = newHookTask;
+                }
+            }
+            else {
+                // this hook task might not have been set yet, in which case use the new one
+                config.hookTasks[id] = newHookTask;
+            }
+        }
+        // merge options from this plugin's config with any options we've collected already
+        // TODO this is almost the exact same code as for hooks, refactor
+        for (const [id, configOptions] of Object.entries(plugin.rcFile.options)) {
+            const existingOptions = config.options[id];
+            const pluginOptions = {
+                options: configOptions,
+                plugin,
+                forPlugin: config.plugins[id]
+            };
+            if (existingOptions) {
+                const existingFromDescendent = isDescendent(plugin, existingOptions.plugin);
+                // plugins can only override options from their descendents, otherwise it's a conflict
+                // return a conflict either listing these options and the sibling's,
+                // or merging in previously-generated options
+                if (!existingFromDescendent) {
+                    const conflicting = (0, conflict_1.isConflict)(existingOptions) ? existingOptions.conflicting : [existingOptions];
+                    const conflict = {
+                        plugin,
+                        conflicting: conflicting.concat(pluginOptions)
+                    };
+                    config.options[id] = conflict;
+                }
+                else {
+                    // if we're here, any existing options are from a child plugin,
+                    // so merge in overrides from the parent
+                    config.options[id] = { ...existingOptions, ...pluginOptions };
+                }
+            }
+            else {
+                // this options key might not have been set yet, in which case use the new one
+                config.options[id] = pluginOptions;
+            }
+        }
+    }
+    config.resolvedPlugins.add(plugin);
 }
-exports.loadPlugins = loadPlugins;
+exports.resolvePlugin = resolvePlugin;

package/lib/rc-file.d.ts

@@ -1,3 +1,4 @@
+import { RCFile } from '@dotcom-tool-kit/types/src';
 export declare const explorer: {
     readonly search: (searchFrom?: string | undefined) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
     readonly load: (filepath: string) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
@@ -5,14 +6,5 @@ export declare const explorer: {
     readonly clearSearchCache: () => void;
     readonly clearCaches: () => void;
 };
-export interface RCFile {
-    plugins: string[];
-    hooks: {
-        [id: string]: string | string[];
-    };
-    options: {
-        [id: string]: Record<string, unknown>;
-    };
-}
 export declare function loadToolKitRC(root: string): Promise<RCFile>;
 //# sourceMappingURL=rc-file.d.ts.map

package/lib/rc-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ;;;;;;CAA6D,CAAA;AAElF,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAA;IAC1C,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;CACnD;AAED,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAKjE"}
+{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAEnD,eAAO,MAAM,QAAQ;;;;;;CAA6D,CAAA;AAMlF,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CASjE"}

package/lib/rc-file.js

@@ -4,9 +4,14 @@ exports.loadToolKitRC = exports.explorer = void 0;
 const cosmiconfig_1 = require("cosmiconfig");
 exports.explorer = (0, cosmiconfig_1.cosmiconfig)('toolkit', { ignoreEmptySearchPlaces: false });
 async function loadToolKitRC(root) {
-    const result = await exports.explorer.search(root);
+    var _a, _b, _c;
+    const result = (await exports.explorer.search(root));
     if (!result || !result.config)
         return { plugins: [], hooks: {}, options: {} };
-    return result.config;
+    return {
+        plugins: (_a = result.config.plugins) !== null && _a !== void 0 ? _a : [],
+        hooks: (_b = result.config.hooks) !== null && _b !== void 0 ? _b : {},
+        options: (_c = result.config.options) !== null && _c !== void 0 ? _c : {}
+    };
 }
 exports.loadToolKitRC = loadToolKitRC;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -22,8 +22,18 @@
   "devDependencies": {
     "@jest/globals": "^27.4.6",
     "@types/lodash.merge": "^4.6.6",
-    "@types/lodash.mergewith": "^4.6.6",
     "@types/node": "^12.20.24",
+    "@dotcom-tool-kit/backend-app": "^2.0.3",
+    "@dotcom-tool-kit/heroku": "^2.0.2",
+    "@dotcom-tool-kit/webpack": "^2.1.1",
+    "@dotcom-tool-kit/babel": "^2.0.2",
+    "@dotcom-tool-kit/circleci": "^2.1.0",
+    "@dotcom-tool-kit/npm": "^2.0.3",
+    "@dotcom-tool-kit/circleci-heroku": "^2.0.3",
+    "@dotcom-tool-kit/frontend-app": "^2.1.1",
+    "@dotcom-tool-kit/eslint": "^2.1.0",
+    "@dotcom-tool-kit/mocha": "^2.0.2",
+    "@dotcom-tool-kit/n-test": "^2.0.2",
     "chai": "^4.3.4",
     "globby": "^10.0.2",
     "ts-node": "^8.10.2",
@@ -31,15 +41,12 @@
   },
   "dependencies": {
     "@dotcom-tool-kit/error": "^2.0.0",
-    "@dotcom-tool-kit/hook": "^2.0.0",
     "@dotcom-tool-kit/logger": "^2.0.0",
-    "@dotcom-tool-kit/options": "^2.0.0",
-    "@dotcom-tool-kit/types": "^2.0.0",
+    "@dotcom-tool-kit/options": "^2.0.2",
+    "@dotcom-tool-kit/types": "^2.2.0",
     "@dotcom-tool-kit/wait-for-ok": "^2.0.0",
     "cosmiconfig": "^7.0.0",
-    "import-from": "^3.0.0",
     "lodash.merge": "^4.6.2",
-    "lodash.mergewith": "^4.6.2",
     "minimist": "^1.2.5",
     "resolve-from": "^5.0.0",
     "tslib": "^1.14.1",