dotcom-tool-kit 4.3.4 → 4.3.6

package/lib/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,cAAc,EACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AASzD,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAOzE,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAezE,eAAO,MAAM,0BAA0B,cAAe,SAAS,WAAW,CAAC,EAAE,KAAG,MAQ/E,CAAA;AAOD,eAAO,MAAM,2BAA2B,cAAe,SAAS,gBAAgB,CAAC,EAAE,KAAG,MAUrF,CAAA;AAOD,eAAO,MAAM,yBAAyB,cAAe,SAAS,cAAc,CAAC,EAAE,KAAG,MAUjF,CAAA;AAKD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhD,eAAO,MAAM,mBAAmB,kCAAiC,MAC4G,CAAA;AAE7K,eAAO,MAAM,0BAA0B,mBACrB,aAAa,EAAE,KAC9B,MAG2F,CAAA;AAE9F,eAAO,MAAM,yBAAyB,kBACrB,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,CAAA;AAED,eAAO,MAAM,sBAAsB,qBACf,IAAI,EAAE,KACvB,MAKF,CAAA;AAED,KAAK,OAAO,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,cAAc,EAAE,CAAA;CAAE,CAAA;AAOhE,eAAO,MAAM,kBAAkB,iBACf,OAAO,EAAE,SAChB,MAAM,EAAE,KACd,MAOF,CAAA;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAezD;AAED,eAAO,MAAM,aAAa,YAAa,MAAM,KAAG,MAAwC,CAAA;AAExF,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,UA4BvC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,cAAc,EACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AASzD,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAOzE,eAAO,MAAM,mBAAmB,cAAe,CAAC,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,EAAE,KAAG,MAKT,CAAA;AAezE,eAAO,MAAM,0BAA0B,cAAe,SAAS,WAAW,CAAC,EAAE,KAAG,MAQ/E,CAAA;AAOD,eAAO,MAAM,2BAA2B,cAAe,SAAS,gBAAgB,CAAC,EAAE,KAAG,MAUrF,CAAA;AAOD,eAAO,MAAM,yBAAyB,cAAe,SAAS,cAAc,CAAC,EAAE,KAAG,MAUjF,CAAA;AAKD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhD,eAAO,MAAM,mBAAmB,kCAAiC,MAKrD,CAAA;AAEZ,eAAO,MAAM,0BAA0B,mBACrB,aAAa,EAAE,KAC9B,MAG2F,CAAA;AAE9F,eAAO,MAAM,yBAAyB,kBACrB,MAAM,EAAE,kBACP,MAAM,EAAE,KACvB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,CAAA;AAED,eAAO,MAAM,uBAAuB,kBACnB,MAAM,EAAE,gBACT,MAAM,EAAE,KACrB,MAaF,CAAA;AAED,eAAO,MAAM,sBAAsB,qBACf,IAAI,EAAE,KACvB,MAKF,CAAA;AAED,KAAK,OAAO,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,cAAc,EAAE,CAAA;CAAE,CAAA;AAOhE,eAAO,MAAM,kBAAkB,iBACf,OAAO,EAAE,SAChB,MAAM,EAAE,KACd,MAOF,CAAA;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAezD;AAED,eAAO,MAAM,aAAa,YAAa,MAAM,KAAG,MAAwC,CAAA;AAMxF,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,UAiCvC"}

package/lib/messages.js

@@ -54,7 +54,11 @@ You must resolve this conflict by providing options in your app's Tool Kit confi
 `;
 exports.formatTaskOptionConflicts = formatTaskOptionConflicts;
 const formatPlugin = (plugin) => plugin.id === 'app root' ? logger_1.styles.app('your app') : `plugin ${logger_1.styles.plugin(plugin.id)}`;
-const formatInvalidOption = ([id, error]) => (0, zod_validation_error_1.fromZodError)(error, { prefix: `${logger_1.styles.warning((0, pluralize_1.default)('issue', error.issues.length, true))} in ${logger_1.styles.plugin(id)}`, prefixSeparator: ':\n- ', issueSeparator: '\n- ' }).message;
+const formatInvalidOption = ([id, error]) => (0, zod_validation_error_1.fromZodError)(error, {
+    prefix: `${logger_1.styles.warning((0, pluralize_1.default)('issue', error.issues.length, true))} in ${logger_1.styles.plugin(id)}`,
+    prefixSeparator: ':\n- ',
+    issueSeparator: '\n- '
+}).message;
 exports.formatInvalidOption = formatInvalidOption;
 const formatInvalidPluginOptions = (invalidOptions) => `Please update the options so that they are the expected types.
 ${invalidOptions.map(([plugin, error]) => (0, exports.formatInvalidOption)([logger_1.styles.plugin(plugin), error])).join('\n')}
@@ -132,6 +136,8 @@ function formatPluginTree(plugin) {
 exports.formatPluginTree = formatPluginTree;
 const indentReasons = (reasons) => reasons.replace(/\n/g, '\n  ');
 exports.indentReasons = indentReasons;
+// instanceof is unreliable across packages because of version mismatches so also use a heuristic to guess if it's a ToolKitError so we always log the details field if present
+const guessIfToolKitError = (error) => error instanceof error_1.ToolKitError || 'details' in error;
 function formatError(error) {
     let output = `${logger_1.styles.error(error.name)}: ${error.message}\n`;
     if (error instanceof AggregateError) {
@@ -140,11 +146,19 @@ function formatError(error) {
             .map((message, messageIndex) => {
             const lines = message.split('\n');
             // TODO:KB:20241125 refactor the tree formatter from this and formatPluginTree into a shared function
-            return lines.map((line, lineIndex) => (messageIndex === error.errors.length - 1 ? (lineIndex === 0 ? '╰─' : '  ') : lineIndex === 0 ? '├─' : '│ ') + line).join('\n');
+            return lines
+                .map((line, lineIndex) => (messageIndex === error.errors.length - 1
+                ? lineIndex === 0
+                    ? '╰─'
+                    : '  '
+                : lineIndex === 0
+                    ? '├─'
+                    : '│ ') + line)
+                .join('\n');
         })
             .join('\n');
     }
-    else if (error instanceof error_1.ToolKitError) {
+    else if (guessIfToolKitError(error)) {
         if (error.details) {
             output += logger_1.styles.info(error.details);
         }

package/lib/plugin/entry-point.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAW,MAAM,4BAA4B,CAAA;AAS/D,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CA0CvB"}
+{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAW,MAAM,4BAA4B,CAAA;AAS/D,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAwCvB"}

package/lib/plugin/entry-point.js

@@ -26,15 +26,13 @@ async function importEntryPoint(type, entryPoint) {
             `an error was thrown when loading entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}:\n  ${logger_1.styles.code((0, messages_1.indentReasons)(err.toString()))}`
         ]);
     }
-    if (isPlainObjectGuard(pluginModule)) {
-        const defaultExport = (0, tslib_1.__importDefault)(pluginModule).default;
-        if (typeof defaultExport === 'function') {
-            return type
-                .isCompatible(defaultExport)
-                .mapError((reasons) => [
-                `the ${type.name.toLowerCase()} ${logger_1.styles.hook(defaultExport.name)} is not a compatible instance of ${logger_1.styles.code(type.name)}:\n  - ${reasons.join('\n  -  ')}`
-            ]);
-        }
+    const defaultExport = (0, tslib_1.__importDefault)(pluginModule).default;
+    if (typeof defaultExport === 'function') {
+        return type
+            .isCompatible(defaultExport)
+            .mapError((reasons) => [
+            `the ${type.name.toLowerCase()} ${logger_1.styles.hook(defaultExport.name)} is not a compatible instance of ${logger_1.styles.code(type.name)}:\n  - ${reasons.join('\n  -  ')}`
+        ]);
     }
     return (0, validated_1.invalid)([
         `entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)} does not export a class as its ${logger_1.styles.code('default')} export or ${logger_1.styles.code('module.exports')}`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "4.3.4",
+  "version": "4.3.6",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -30,11 +30,11 @@
     "zod": "^3.22.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "^1.1.4",
-    "@dotcom-tool-kit/config": "^1.0.7",
+    "@dotcom-tool-kit/base": "^1.1.5",
+    "@dotcom-tool-kit/config": "^1.0.8",
     "@dotcom-tool-kit/conflict": "^1.0.0",
     "@dotcom-tool-kit/error": "^4.1.0",
-    "@dotcom-tool-kit/logger": "^4.1.0",
+    "@dotcom-tool-kit/logger": "^4.1.1",
     "@dotcom-tool-kit/plugin": "^1.0.0",
     "@dotcom-tool-kit/state": "^4.1.0",
     "@dotcom-tool-kit/validated": "^1.0.2",