dotcom-tool-kit 4.0.0-beta.4 → 4.0.0

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;AAU/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,CA4CvB"}
+{"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;AAQ/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,CA4CvB"}

package/lib/plugin/entry-point.js

@@ -1,17 +1,38 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.importEntryPoint = void 0;
-const tslib_1 = require("tslib");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const validated_1 = require("@dotcom-tool-kit/validated");
-const resolve_from_1 = tslib_1.__importDefault(require("resolve-from"));
 const lodash_1 = require("lodash");
 const messages_1 = require("../messages");
 const isPlainObjectGuard = (value) => (0, lodash_1.isPlainObject)(value);
 // the subclasses of Base have different constructor signatures so we need to omit
 // the constructor from the type bound here so you can actually pass in a subclass
 async function importEntryPoint(type, entryPoint) {
-    const resolvedPath = resolve_from_1.default.silent(entryPoint.plugin.root, entryPoint.modulePath);
+    const resolvedPath = require.resolve(entryPoint.modulePath, { paths: [entryPoint.plugin.root] });
     if (!resolvedPath) {
         return (0, validated_1.invalid)([
             `could not find entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}`
@@ -19,7 +40,7 @@ async function importEntryPoint(type, entryPoint) {
     }
     let pluginModule;
     try {
-        pluginModule = await Promise.resolve(`${resolvedPath}`).then(s => tslib_1.__importStar(require(s)));
+        pluginModule = await Promise.resolve(`${resolvedPath}`).then(s => __importStar(require(s)));
     }
     catch (e) {
         const err = e;

package/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAmC,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAUrC,wBAAsB,UAAU,CAC9B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAmD5B;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAiBrF;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAqB9F"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAmC,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAoBrC,wBAAsB,UAAU,CAC9B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAmD5B;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAiBrF;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAqB9F"}

package/lib/plugin.js

@@ -5,7 +5,7 @@ const tslib_1 = require("tslib");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const plugin_1 = require("@dotcom-tool-kit/plugin");
 const validated_1 = require("@dotcom-tool-kit/validated");
-const resolve_pkg_1 = tslib_1.__importDefault(require("resolve-pkg"));
+const path = tslib_1.__importStar(require("path"));
 const rc_file_1 = require("./rc-file");
 const messages_1 = require("./messages");
 const merge_tasks_1 = require("./plugin/merge-tasks");
@@ -14,6 +14,15 @@ const merge_commands_1 = require("./plugin/merge-commands");
 const merge_plugin_options_1 = require("./plugin/merge-plugin-options");
 const merge_inits_1 = require("./plugin/merge-inits");
 const merge_task_options_1 = require("./plugin/merge-task-options");
+function resolveRoot(id, root) {
+    const isPath = id.startsWith('.') || id.startsWith('/');
+    // resolve the package.json of a plugin as many plugins don't have valid
+    // entrypoints now that we're intending their tasks/hooks to be loaded via
+    // entrypoints defined in config
+    const modulePath = isPath ? id : path.join(id, 'package.json');
+    const resolvedPath = require.resolve(modulePath, { paths: [root] });
+    return path.dirname(resolvedPath);
+}
 async function loadPlugin(id, config, logger, parent) {
     // don't load duplicate plugins
     if (id in config.plugins) {
@@ -22,7 +31,7 @@ async function loadPlugin(id, config, logger, parent) {
     const isAppRoot = id === 'app root';
     // load plugin relative to the parent plugin
     const root = parent ? parent.root : process.cwd();
-    const pluginRoot = isAppRoot ? root : (0, resolve_pkg_1.default)(id, { cwd: root });
+    const pluginRoot = isAppRoot ? root : resolveRoot(id, root);
     if (!pluginRoot) {
         return (0, validated_1.invalid)([`could not find path for name ${logger_1.styles.filepath(id)}`]);
     }

package/lib/tasks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAsDrC,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA+DlG"}
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAuDrC,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA0ElG"}

package/lib/tasks.js

@@ -20,20 +20,21 @@ const loadTasks = async (logger, tasks, config) => {
         return taskResult.flatMap((Task) => {
             const taskSchema = schemas_1.TaskSchemas[taskId];
             const configOptions = config.taskOptions[taskId]?.options ?? {};
-            const parsedOptions = taskSchema?.safeParse({ ...configOptions, ...options }) ?? {
+            const mergedOptions = { ...configOptions, ...options };
+            const parsedOptions = taskSchema?.safeParse(mergedOptions) ?? {
                 success: true,
-                data: {}
+                data: mergedOptions
             };
             if (parsedOptions.success) {
                 const task = new Task(logger, taskId, (0, options_1.getOptions)(entryPoint.plugin.id) ?? {}, parsedOptions.data);
-                return (0, validated_1.valid)([taskId, task]);
+                return (0, validated_1.valid)(task);
             }
             else {
                 return (0, validated_1.invalid)([(0, messages_1.formatInvalidOption)([logger_1.styles.task(taskId), parsedOptions.error])]);
             }
         });
     }));
-    return (0, validated_1.reduceValidated)(taskResults).map(Object.fromEntries);
+    return (0, validated_1.reduceValidated)(taskResults);
 };
 async function runTasks(logger, commands, files) {
     const config = await (0, config_1.loadConfig)(logger);
@@ -47,24 +48,30 @@ async function runTasks(logger, commands, files) {
     if ((0, fetch_1.shouldDisableNativeFetch)()) {
         process.execArgv.push('--no-experimental-fetch');
     }
-    const commandTasks = commands.flatMap((command) => config.commandTasks[command]?.tasks ?? []);
-    const tasks = (await loadTasks(logger, commandTasks, config)).unwrap('tasks are invalid');
-    for (const command of commands) {
+    const commandTasks = (0, validated_1.reduceValidated)(await Promise.all(commands.map(async (command) => {
+        const tasks = config.commandTasks[command]?.tasks ?? [];
+        const validatedTaskInstances = await loadTasks(logger, tasks, config);
+        return validatedTaskInstances.map((taskInstances) => ({ command, tasks: taskInstances }));
+    }))).unwrap('tasks are invalid!');
+    for (const { command, tasks } of commandTasks) {
         const errors = [];
-        if (!config.commandTasks[command]) {
+        if (tasks.length === 0) {
             logger.warn(`no task configured for ${command}: skipping assignment...`);
-            continue;
         }
-        for (const { task: taskId } of config.commandTasks[command].tasks) {
+        for (const task of tasks) {
             try {
-                logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(taskId)} task`));
-                await tasks[taskId].run(files);
+                logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(task.id)} task`));
+                await task.run({ files });
             }
             catch (error) {
+                // if there's an exit code, that's a request from the task to exit early
+                if (error instanceof error_1.ToolKitError && error.exitCode) {
+                    throw error;
+                }
+                // if not, we allow subsequent hook tasks to run on error
                 // TODO use validated for this
-                // allow subsequent command tasks to run on error
                 errors.push({
-                    task: taskId,
+                    task: task.id,
                     error: error
                 });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "4.0.0-beta.4",
+  "version": "4.0.0",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -30,20 +30,18 @@
     "zod": "^3.22.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "4.0.0-beta.0",
-    "@dotcom-tool-kit/config": "2.0.0-beta.0",
-    "@dotcom-tool-kit/conflict": "2.0.0-beta.0",
-    "@dotcom-tool-kit/error": "4.0.0-beta.0",
-    "@dotcom-tool-kit/logger": "4.0.0-beta.0",
-    "@dotcom-tool-kit/options": "4.0.0-beta.0",
-    "@dotcom-tool-kit/plugin": "2.0.0-beta.0",
-    "@dotcom-tool-kit/validated": "2.0.0-beta.0",
-    "@dotcom-tool-kit/wait-for-ok": "4.0.0-beta.0",
+    "@dotcom-tool-kit/base": "^1.0.0",
+    "@dotcom-tool-kit/config": "^1.0.0",
+    "@dotcom-tool-kit/conflict": "^1.0.0",
+    "@dotcom-tool-kit/error": "^4.0.0",
+    "@dotcom-tool-kit/logger": "^4.0.0",
+    "@dotcom-tool-kit/options": "^4.0.0",
+    "@dotcom-tool-kit/plugin": "^1.0.0",
+    "@dotcom-tool-kit/validated": "^1.0.0",
+    "@dotcom-tool-kit/wait-for-ok": "^4.0.0",
     "endent": "^2.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.5",
-    "resolve-from": "^5.0.0",
-    "resolve-pkg": "^2.0.0",
     "tslib": "^2.3.1",
     "yaml": "^2.4.1",
     "zod-validation-error": "^2.1.0"