dotcom-tool-kit 1.3.0 → 1.4.3

package/bin/run

@@ -1,20 +1,19 @@
 #!/usr/bin/env node
 
-const c = require('ansi-colors')
 const argv = require('minimist')(process.argv.slice(2), {
   boolean: ['help', 'install'],
   '--': true
 })
 
 const { runTasks, showHelp, installHooks } = require('../lib')
-const { styles } = require('../lib/messages')
+const { rootLogger, styles } = require('@dotcom-tool-kit/logger')
 
 async function main() {
   try {
     if (argv.install) {
-      await installHooks()
+      await installHooks(rootLogger)
     } else if (argv.help || argv._.length === 0) {
-      await showHelp(argv._)
+      await showHelp(rootLogger, argv._)
     } else {
       if (argv['--'].length > 0) {
         // The `--` in a command such as `dotcom-tool-kit test:staged --`
@@ -24,16 +23,19 @@ async function main() {
         // 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['--'])
+        await runTasks(rootLogger, argv._, argv['--'])
       } else {
-        await runTasks(argv._)
+        await runTasks(rootLogger, argv._)
       }
     }
   } catch (error) {
     if (error.details) {
-      console.error(styles.error(error.message) + '\n\n' + error.details)
+      rootLogger.error('', { skipformat: true })
+      rootLogger.error(error.message)
+      rootLogger.error(styles.ruler(), { skipformat: true })
+      rootLogger.error(error.details, { skipformat: true })
     } else {
-      console.error(error.stack)
+      rootLogger.error(error.stack)
     }
 
     process.exitCode = error.exitCode || 1

package/lib/config.d.ts

@@ -1,3 +1,4 @@
+import type { Logger } from 'winston';
 import type { HookTask } from './hook';
 import { Conflict } from './conflict';
 import type { TaskClass, Hook, Plugin } from '@dotcom-tool-kit/types';
@@ -40,10 +41,10 @@ export interface ValidConfig extends Config {
 }
 export declare function validateConfig(config: Config): Promise<ValidConfig>;
 export declare function checkInstall(config: ValidConfig): Promise<void>;
-export declare function loadConfig(options?: {
+export declare function loadConfig(logger: Logger, options?: {
     validate?: true;
 }): Promise<ValidConfig>;
-export declare function loadConfig(options?: {
+export declare function loadConfig(logger: Logger, options?: {
     validate?: false;
 }): 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,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"}
+{"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"}

package/lib/config.js

@@ -99,9 +99,9 @@ async function checkInstall(config) {
     }
 }
 exports.checkInstall = checkInstall;
-async function loadConfig({ validate = true } = {}) {
+async function loadConfig(logger, { validate = true } = {}) {
     // start loading config and child plugins, starting from the consumer app directory
-    const config = await (0, plugin_1.loadPluginConfig)({
+    const config = await (0, plugin_1.loadPluginConfig)(logger, {
         id: 'app root',
         root: process.cwd()
     }, createConfig());

package/lib/help.d.ts

@@ -1,2 +1,3 @@
-export default function showHelp(hooks: string[]): Promise<void>;
+import type { Logger } from 'winston';
+export default function showHelp(logger: Logger, hooks: string[]): Promise<void>;
 //# sourceMappingURL=help.d.ts.map

package/lib/help.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,wBAA8B,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiErF"}

package/lib/help.js

@@ -2,9 +2,9 @@
 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)();
+const logger_1 = require("@dotcom-tool-kit/logger");
+async function showHelp(logger, hooks) {
+    const config = await (0, config_1.loadConfig)(logger);
     if (hooks.length === 0) {
         hooks = Object.keys(config.hooks).sort();
     }
@@ -15,17 +15,17 @@ async function showHelp(hooks) {
     }
     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')}!`)}
+    logger.info(`
+🧰 ${logger_1.styles.title(`welcome to ${logger_1.styles.app('Tool Kit')}!`)}
 
 Tool Kit is modern, maintainable & modular developer tooling for FT.com projects.
 
-${messages_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit')}
+${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit')}
 
-${messages_1.styles.ruler()}
+${logger_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
+        : logger_1.styles.dim(hooks.length === 0
             ? 'available hooks'
             : `help for ${hooks.length - missingHooks.length} ${hooks.length - missingHooks.length > 1 ? 'hooks' : 'hook'}`)}:
 `);
@@ -34,21 +34,21 @@ ${Object.keys(config.hooks).length === 0
         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)}
+            logger.info(`${logger_1.styles.heading(hook)}
 ${Hook.constructor.description ? Hook.constructor.description + '\n' : ''}
 ${tasks && tasks.tasks.length
                 ? `runs ${tasks.tasks.length > 1 ? 'these tasks' : 'this task'}:
 ${tasks.tasks
-                    .map((task) => `- ${messages_1.styles.task(task)} ${messages_1.styles.dim(config.tasks[task].description)}`)
+                    .map((task) => `- ${logger_1.styles.task(task)} ${logger_1.styles.dim(config.tasks[task].description)}`)
                     .join('\n')}`
-                : messages_1.styles.dim('no tasks configured to run on this hook.')}
-${messages_1.styles.ruler()}
+                : logger_1.styles.dim('no tasks configured to run on this hook.')}
+${logger_1.styles.ruler()}
 `);
             /*eslint-enable @typescript-eslint/no-explicit-any */
         }
     }
     if (missingHooks.length) {
-        console.warn(messages_1.styles.warning(`no such ${missingHooks.length > 1 ? 'hooks' : 'hook'} ${missingHooks.map(messages_1.styles.hook).join(', ')}`));
+        logger.warn(`no such ${missingHooks.length > 1 ? 'hooks' : 'hook'} ${missingHooks.map(logger_1.styles.hook).join(', ')}`);
     }
 }
 exports.default = showHelp;

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-export declare function runTasks(hooks: string[], files?: string[]): Promise<void>;
+import type { Logger } from 'winston';
+export declare function runTasks(logger: Logger, 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":"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,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"}

package/lib/index.js

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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");
 const options_1 = require("@dotcom-tool-kit/options");
-async function runTasks(hooks, files) {
-    const config = await (0, config_1.loadConfig)();
+const logger_1 = require("@dotcom-tool-kit/logger");
+async function runTasks(logger, hooks, files) {
+    const config = await (0, config_1.loadConfig)(logger);
     const availableHooks = Object.keys(config.hooks)
         .sort()
         .map((id) => `- ${id}`)
@@ -32,7 +32,7 @@ ${availableHooks}`;
     for (const hook of hooks) {
         const errors = [];
         if (!config.hookTasks[hook]) {
-            console.warn(messages_1.styles.warning(`no task configured for ${hook}: skipping assignment...}`));
+            logger.warn(`no task configured for ${hook}: skipping assignment...`);
             continue;
         }
         const assignment = config.hookTasks[hook];
@@ -42,7 +42,7 @@ ${availableHooks}`;
             // `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);
+            const task = new Task(logger, options);
             try {
                 await task.run(files);
             }
@@ -56,16 +56,16 @@ ${availableHooks}`;
             }
         }
         if (errors.length > 0) {
-            const error = new error_1.ToolKitError(`error running tasks for ${messages_1.styles.hook(hook)}`);
+            const error = new error_1.ToolKitError(`error running tasks for ${logger_1.styles.hook(hook)}`);
             error.details = errors
-                .map(({ hook, task, error }) => `${messages_1.styles.heading(`${messages_1.styles.task(task)}:`)}
+                .map(({ hook, task, error }) => `${logger_1.styles.heading(`${logger_1.styles.task(task)}:`)}
 
 ${error.message}${error instanceof error_1.ToolKitError
                 ? `
 
 ${error.details}`
                 : ''}`)
-                .join(`\n${messages_1.styles.dim(messages_1.styles.ruler())}\n`);
+                .join(`${logger_1.styles.dim(logger_1.styles.ruler())}\n`);
             error.exitCode = errors.length + 1;
             throw error;
         }

package/lib/install.d.ts

@@ -1,3 +1,4 @@
+import type { Logger } from 'winston';
 import { Config } from './config';
-export default function installHooks(): Promise<Config>;
+export default function installHooks(logger: Logger): Promise<Config>;
 //# sourceMappingURL=install.d.ts.map

package/lib/install.d.ts.map

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

package/lib/install.js

@@ -3,8 +3,8 @@ 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)();
+async function installHooks(logger) {
+    const config = await (0, config_1.loadConfig)(logger);
     const tasks = Object.values(config.hooks).map((hook) => async () => {
         if (!(await hook.check())) {
             await hook.install();
@@ -31,7 +31,7 @@ async function installHooks() {
     }
     if (errors.length) {
         const error = new error_1.ToolKitError('could not automatically install hooks:');
-        error.details = errors.map((error) => error.message).join('\n\n');
+        error.details = errors.map((error) => `- ${error.message}`).join('\n');
         throw error;
     }
     return config;

package/lib/messages.d.ts

@@ -1,25 +1,7 @@
-import colours from 'ansi-colors';
 import type { PluginOptions } from './config';
 import type { Conflict } from './conflict';
 import type { HookTask } from './hook';
 import type { Hook, TaskClass } from '@dotcom-tool-kit/types';
-declare const s: {
-    hook: colours.StyleFunction;
-    task: colours.StyleFunction;
-    plugin: colours.StyleFunction;
-    URL: colours.StyleFunction;
-    filepath: colours.StyleFunction;
-    app: colours.StyleFunction;
-    option: colours.StyleFunction;
-    makeTarget: colours.StyleFunction;
-    heading: colours.StyleFunction;
-    dim: colours.StyleFunction;
-    title: colours.StyleFunction;
-    error: (string: string) => string;
-    warning: (string: string) => string;
-    ruler: () => string;
-};
-export { s as styles };
 export declare const formatTaskConflicts: (conflicts: Conflict<TaskClass>[]) => string;
 export declare const formatHookConflicts: (conflicts: Conflict<Hook>[]) => string;
 export declare const formatHookTaskConflicts: (conflicts: Conflict<HookTask>[]) => string;
@@ -32,4 +14,5 @@ declare type Missing = {
     tasks: string[];
 };
 export declare const formatMissingTasks: (missingTasks: Missing[], tasks: string[]) => string;
+export {};
 //# sourceMappingURL=messages.d.ts.map

package/lib/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,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"}
+{"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"}

package/lib/messages.js

@@ -1,102 +1,82 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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
-// don't use ansi-colors directly, define a style please
-const s = {
-    hook: ansi_colors_1.default.magenta,
-    task: ansi_colors_1.default.blueBright,
-    plugin: ansi_colors_1.default.cyan,
-    URL: ansi_colors_1.default.cyan.underline,
-    filepath: ansi_colors_1.default.italic,
-    app: ansi_colors_1.default.green,
-    option: ansi_colors_1.default.blue,
-    makeTarget: ansi_colors_1.default.grey.italic,
-    heading: ansi_colors_1.default.bold,
-    dim: ansi_colors_1.default.grey,
-    title: ansi_colors_1.default.bold.underline,
-    error: (string) => `${ansi_colors_1.default.red.bold('‼︎')} ${s.title(string)}`,
-    warning: (string) => `${ansi_colors_1.default.yellow.bold('⚠︎')} ${s.title(string)}`,
-    ruler: () => s.dim('─'.repeat(process.stdout.columns / 2))
-};
-exports.styles = s;
-const formatTaskConflict = (conflict) => `- ${s.task(conflict.conflicting[0].id || 'unknown task')} ${s.dim('from plugins')} ${conflict.conflicting
-    .map((task) => s.plugin(task.plugin ? task.plugin.id : 'unknown plugin'))
-    .join(s.dim(', '))}`;
-const formatTaskConflicts = (conflicts) => `${s.heading('There are multiple plugins that include the same tasks')}:
+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'))
+    .join(logger_1.styles.dim(', '))}`;
+const formatTaskConflicts = (conflicts) => `${logger_1.styles.heading('There are multiple plugins that include the same tasks')}:
 ${conflicts.map(formatTaskConflict).join('\n')}
 
 You must resolve this conflict by removing all but one of these plugins.`;
 exports.formatTaskConflicts = formatTaskConflicts;
-const formatHookConflict = (conflict) => `- ${s.hook(conflict.conflicting[0].id || 'unknown event')} ${s.dim('from plugins')} ${conflict.conflicting
-    .map((task) => s.plugin(task.plugin ? task.plugin.id : 'unknown plugin'))
-    .join(s.dim(', '))}`;
-const formatHookConflicts = (conflicts) => `${s.heading('There are multiple plugins that include the same hooks')}:
+const formatHookConflict = (conflict) => `- ${logger_1.styles.hook(conflict.conflicting[0].id || 'unknown event')} ${logger_1.styles.dim('from plugins')} ${conflict.conflicting
+    .map((task) => logger_1.styles.plugin(task.plugin ? task.plugin.id : 'unknown plugin'))
+    .join(logger_1.styles.dim(', '))}`;
+const formatHookConflicts = (conflicts) => `${logger_1.styles.heading('There are multiple plugins that include the same hooks')}:
 ${conflicts.map(formatHookConflict).join('\n')}
 
 You must resolve this conflict by removing all but one of these plugins.`;
 exports.formatHookConflicts = formatHookConflicts;
-const formatHookTaskConflict = (conflict) => `${s.hook(conflict.conflicting[0].id)}:
+const formatHookTaskConflict = (conflict) => `${logger_1.styles.hook(conflict.conflicting[0].id)}:
 ${conflict.conflicting
-    .map((hook) => `- ${hook.tasks.map(s.task).join(s.dim(', '))} ${s.dim('by plugin')} ${s.plugin(hook.plugin.id)}`)
+    .map((hook) => `- ${hook.tasks.map(logger_1.styles.task).join(logger_1.styles.dim(', '))} ${logger_1.styles.dim('by plugin')} ${logger_1.styles.plugin(hook.plugin.id)}`)
     .join('\n')}
 `;
-const formatHookTaskConflicts = (conflicts) => `${s.heading('These hooks are configured to run different tasks by multiple plugins')}:
+const formatHookTaskConflicts = (conflicts) => `${logger_1.styles.heading('These hooks are configured to run different tasks by multiple plugins')}:
 ${conflicts.map(formatHookTaskConflict).join('\n')}
-You must resolve this conflict by explicitly configuring which task to run for these hooks. See ${s.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 hooks. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/docs/resolving-hook-conflicts.md')} for more details.
 
 `;
 exports.formatHookTaskConflicts = formatHookTaskConflicts;
-const formatOptionConflict = (conflict) => `${s.plugin(conflict.conflicting[0].forPlugin.id)}, configured by:
-${conflict.conflicting.map((option) => `- ${s.plugin(option.plugin.id)}`)}`;
-const formatOptionConflicts = (conflicts) => `${s.heading('These plugins have conflicting options')}:
+const formatOptionConflict = (conflict) => `${logger_1.styles.plugin(conflict.conflicting[0].forPlugin.id)}, configured by:
+${conflict.conflicting.map((option) => `- ${logger_1.styles.plugin(option.plugin.id)}`)}`;
+const formatOptionConflicts = (conflicts) => `${logger_1.styles.heading('These plugins have conflicting options')}:
 
 ${conflicts.map(formatOptionConflict).join('\n')}
 
-You must resolve this conflict by providing options in your app's Tool Kit configuration for these plugins, or installing a use-case plugin that provides these options. See ${s.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/readme.md#options')} for more details.
+You must resolve this conflict by providing options in your app's Tool Kit configuration for these plugins, or installing a use-case plugin that provides these options. See ${logger_1.styles.URL('https://github.com/financial-times/dotcom-tool-kit/tree/main/readme.md#options')} for more details.
 
 `;
 exports.formatOptionConflicts = formatOptionConflicts;
-const formatPlugin = (plugin) => plugin.id === 'app root' ? s.app('your app') : `plugin ${s.plugin(plugin.id)}`;
+const formatPlugin = (plugin) => plugin.id === 'app root' ? logger_1.styles.app('your app') : `plugin ${logger_1.styles.plugin(plugin.id)}`;
 // TODO text similarity "did you mean...?"
 const formatUndefinedHookTasks = (undefinedHooks, definedHooks) => `Hooks must be defined by a plugin before you can configure a task to run for them. In your Tool Kit configuration you've configured hooks that aren't defined:
 
-${undefinedHooks.map((hook) => `- ${s.hook(hook.id)}`).join('\n')}
+${undefinedHooks.map((hook) => `- ${logger_1.styles.hook(hook.id)}`).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 available for tasks are: ${definedHooks.map(s.hook).join(', ')}`
+    ? `Hooks that are defined and available for tasks are: ${definedHooks.map(logger_1.styles.hook).join(', ')}`
     : `There are no hooks defined by this app's plugins. You probably need to install some plugins to define hooks.`}.
 `;
 exports.formatUndefinedHookTasks = formatUndefinedHookTasks;
 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')}
+${unusedOptions.map((optionName) => `- ${logger_1.styles.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(', ')}`
+    ? `Plugins that are defined and can have options set are: ${definedPlugins.map(logger_1.styles.plugin).join(', ')}`
     : `There are no plugins installed currently. You'll need to install some plugins before options can be set.`}.
 `;
 exports.formatUnusedOptions = formatUnusedOptions;
 const formatUninstalledHooks = (uninstalledHooks) => `These hooks aren't installed into your app:
 
-${uninstalledHooks.map((hook) => `- ${s.hook(hook.id || 'unknown event')}`).join('\n')}
+${uninstalledHooks.map((hook) => `- ${logger_1.styles.hook(hook.id || 'unknown event')}`).join('\n')}
 
-Run ${s.task('dotcom-tool-kit --install')} to install these hooks.
+Run ${logger_1.styles.task('dotcom-tool-kit --install')} to install these hooks.
 `;
 exports.formatUninstalledHooks = formatUninstalledHooks;
-const formatMissingTask = (missing) => `- ${missing.tasks.map(s.task).join(', ')} ${s.dim(`(assigned to ${s.hook(missing.hook.id)} by ${formatPlugin(missing.hook.plugin)})`)}`;
+const formatMissingTask = (missing) => `- ${missing.tasks.map(logger_1.styles.task).join(', ')} ${logger_1.styles.dim(`(assigned to ${logger_1.styles.hook(missing.hook.id)} by ${formatPlugin(missing.hook.plugin)})`)}`;
 const formatMissingTasks = (missingTasks, tasks) => `These tasks don't exist, but are configured to run from hooks:
 
 ${missingTasks.map(formatMissingTask).join('\n')}
 
 They could be misspelt, or defined by a Tool Kit plugin that isn't used by this app.
 
-Available tasks are: ${tasks.map(s.task).join(', ')}.
+Available tasks are: ${tasks.map(logger_1.styles.task).join(', ')}.
 `;
 exports.formatMissingTasks = formatMissingTasks;

package/lib/plugin.d.ts

@@ -1,6 +1,7 @@
+import type { Logger } from 'winston';
 import { Config } from './config';
 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[]>;
+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[]>;
 //# 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":"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"}
+{"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"}

package/lib/plugin.js

@@ -6,14 +6,14 @@ 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 logger_1 = require("@dotcom-tool-kit/logger");
 const types_1 = require("@dotcom-tool-kit/types");
-async function loadPluginConfig(plugin, config) {
+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(plugins, config, 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, 
@@ -75,7 +75,7 @@ async function loadPluginConfig(plugin, config) {
     return config;
 }
 exports.loadPluginConfig = loadPluginConfig;
-async function loadPlugin(id, config, parent) {
+async function loadPlugin(logger, id, config, parent) {
     // don't load duplicate plugins
     if (id in config.plugins) {
         return config.plugins[id];
@@ -86,11 +86,11 @@ async function loadPlugin(id, config, parent) {
     const rawPlugin = (0, import_from_1.default)(root, id);
     let basePlugin;
     try {
-        basePlugin = (0, types_1.instantiatePlugin)(rawPlugin);
+        basePlugin = (0, types_1.instantiatePlugin)(rawPlugin, logger);
     }
     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`;
+            error.details = `the package ${logger_1.styles.plugin(id)} at ${logger_1.styles.filepath(pluginRoot)} is not a valid plugin`;
         }
         throw error;
     }
@@ -128,11 +128,11 @@ async function loadPlugin(id, config, parent) {
             conflicting: conflicting.concat(newHook)
         };
     });
-    await loadPluginConfig(plugin, config);
+    await loadPluginConfig(logger, plugin, config);
     return plugin;
 }
 exports.loadPlugin = loadPlugin;
-function loadPlugins(plugins, config, parent) {
-    return Promise.all(plugins.map((plugin) => loadPlugin(plugin, config, parent)));
+function loadPlugins(logger, plugins, config, parent) {
+    return Promise.all(plugins.map((plugin) => loadPlugin(logger, plugin, config, parent)));
 }
 exports.loadPlugins = loadPlugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "1.3.0",
+  "version": "1.4.3",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -25,15 +25,16 @@
     "@types/node": "^12.20.24",
     "chai": "^4.3.4",
     "globby": "^10.0.2",
-    "ts-node": "^8.10.2"
+    "ts-node": "^8.10.2",
+    "winston": "^3.5.1"
   },
   "dependencies": {
-    "@dotcom-tool-kit/error": "^1.3.0",
-    "@dotcom-tool-kit/hook": "^1.3.0",
-    "@dotcom-tool-kit/options": "^1.3.0",
-    "@dotcom-tool-kit/types": "^1.3.0",
-    "@dotcom-tool-kit/wait-for-ok": "^1.3.0",
-    "ansi-colors": "^4.1.1",
+    "@dotcom-tool-kit/error": "^1.4.3",
+    "@dotcom-tool-kit/hook": "^1.4.3",
+    "@dotcom-tool-kit/logger": "^1.4.3",
+    "@dotcom-tool-kit/options": "^1.4.3",
+    "@dotcom-tool-kit/types": "^1.4.3",
+    "@dotcom-tool-kit/wait-for-ok": "^1.4.3",
     "cosmiconfig": "^7.0.0",
     "import-from": "^3.0.0",
     "lodash.mergewith": "^4.6.2",