hammerkit 1.17.0 → 1.18.0

package/dist/cli.js

@@ -16,6 +16,7 @@ const reset_work_tree_1 = require("./executer/reset-work-tree");
 const execute_work_tree_1 = require("./executer/execute-work-tree");
 const package_1 = require("./docker/package");
 const explain_1 = require("./cache/explain");
+const describe_task_1 = require("./planner/describe-task");
 const work_graph_serializer_1 = require("./planner/work-graph-serializer");
 const dry_run_1 = require("./executer/dry-run");
 const cache_sync_1 = require("./cache/cache-sync");
@@ -127,6 +128,9 @@ class Cli {
     }
     // Read-only cache prediction for every task in scope: executes no command,
     // starts no container/service, performs no cache push/pull.
+    explainDefinition() {
+        return [...(0, plan_work_tasks_1.iterateWorkTasks)(this.workTree)].map((task) => (0, describe_task_1.describeTask)(task, this.environment.cwd));
+    }
     async explain(options) {
         return (0, explain_1.explainWorkTree)(this.workTree, options?.cacheDefault ?? 'checksum', this.environment);
     }

package/dist/planner/describe-task.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.describeTask = void 0;
+const path_1 = require("path");
+const work_task_1 = require("./work-task");
+const toPosix = (value) => (path_1.sep === path_1.posix.sep ? value : value.split(path_1.sep).join(path_1.posix.sep));
+function describeTask(item, cwd) {
+    const task = item.data;
+    const remote = task.scope.remote;
+    return {
+        name: item.name,
+        type: (0, work_task_1.isContainerWorkTask)(task) ? 'container' : 'local',
+        description: task.description || null,
+        source: {
+            file: toPosix(remote ? (0, path_1.relative)(remote.root, task.scope.fileName) : (0, path_1.relative)(cwd, task.scope.fileName)),
+            includedAs: task.scope.namePrefix,
+            git: remote?.git ?? null,
+            ref: remote?.ref ?? null,
+            commit: remote?.commit ?? null,
+        },
+        image: (0, work_task_1.isContainerWorkTask)(task) ? task.image : null,
+        shell: task.shell,
+        cmds: task.cmds.map((cmd) => cmd.cmd),
+        src: task.src.map((src) => src.source),
+        generates: task.generates.map((generate) => (0, path_1.relative)(task.cwd, generate.path)),
+        deps: item.deps.map((dep) => dep.name),
+        needs: item.needs.map((need) => need.name),
+        mounts: (0, work_task_1.isContainerWorkTask)(task) ? task.mounts.map((mount) => mount.mount) : [],
+        envs: Object.entries(task.envs.variables).map(([name, value]) => ({
+            name,
+            value,
+            origin: task.envOrigins[name] ?? 'task',
+        })),
+        envReferences: task.envs.replacements.map((replacement) => ({
+            name: replacement.key,
+            from: replacement.name,
+            available: replacement.available,
+        })),
+    };
+}
+exports.describeTask = describeTask;
+//# sourceMappingURL=describe-task.js.map

package/dist/planner/utils/append-work-task.js

@@ -56,6 +56,7 @@ function parseTask(cwd, task, environment, context) {
     const envs = (0, replace_env_variables_1.buildEnvironmentVariables)(task.envs, environment, context);
     const baseWorkNode = {
         envs,
+        envOrigins: getEnvOrigins(task),
         description: (0, template_value_1.templateValue)(task.schema.description || '', envs).trim(),
         name: task.relativeName,
         cwd,
@@ -92,4 +93,22 @@ function parseTask(cwd, task, environment, context) {
         };
     }
 }
+function getEnvOrigins(task) {
+    const origins = {};
+    for (const key of Object.keys(task.envs)) {
+        if (key in (task.schema.envs ?? {})) {
+            origins[key] = 'task';
+        }
+        else if (key in (task.scope.inputs ?? {}) && key in (task.scope.schema.envs ?? {})) {
+            origins[key] = 'input';
+        }
+        else if (key in (task.scope.schema.envs ?? {})) {
+            origins[key] = 'build-file';
+        }
+        else {
+            origins[key] = 'extend';
+        }
+    }
+    return origins;
+}
 //# sourceMappingURL=append-work-task.js.map

package/dist/program.js

@@ -32,6 +32,51 @@ async function createCli(fileName, environment, workScope) {
     return (0, cli_1.getCli)(workTree, environment);
 }
 exports.createCli = createCli;
+const ENV_ORIGINS = {
+    task: () => 'task',
+    input: (includedAs) => `input of include ${includedAs}`,
+    'build-file': () => 'build file',
+    extend: () => 'extended task',
+};
+function printTaskDefinition(environment, definition) {
+    environment.stdout.write(`• ${definition.name}\n`);
+    const source = definition.source;
+    if (source.git) {
+        (0, log_1.printProperty)(environment, 'defined in', `${source.file} of ${source.git} at ${source.ref ?? 'HEAD'} (commit ${(source.commit ?? '').slice(0, 12)})`);
+    }
+    else {
+        (0, log_1.printProperty)(environment, 'defined in', source.file);
+    }
+    if (source.includedAs) {
+        (0, log_1.printProperty)(environment, 'included as', source.includedAs);
+    }
+    if (definition.description) {
+        (0, log_1.printProperty)(environment, 'description', definition.description);
+    }
+    if (definition.image) {
+        (0, log_1.printProperty)(environment, 'image', definition.image);
+    }
+    for (const [name, values] of [
+        ['deps', definition.deps],
+        ['needs', definition.needs],
+        ['src', definition.src],
+        ['generates', definition.generates],
+        ['mounts', definition.mounts],
+    ]) {
+        if (values.length > 0) {
+            (0, log_1.printProperty)(environment, name, values.join(', '));
+        }
+    }
+    for (const cmd of definition.cmds) {
+        (0, log_1.printProperty)(environment, 'cmd', cmd);
+    }
+    for (const env of definition.envs) {
+        (0, log_1.printProperty)(environment, `env ${env.name}`, `${env.value}  ${colors_1.default.grey(`(${ENV_ORIGINS[env.origin](source.includedAs)})`)}`);
+    }
+    for (const reference of definition.envReferences) {
+        (0, log_1.printProperty)(environment, `env ${reference.name}`, `from $${reference.from} ${colors_1.default.grey(reference.available ? '(set)' : '(not set)')}`);
+    }
+}
 function parseWorkLabelScope(options) {
     const scope = {
         environmentName: null,
@@ -278,9 +323,22 @@ async function getProgram(environment, argv) {
             .choices(['checksum', 'modify-date', 'none']))
             .addOption(new commander_1.Option('--json', 'emit the explanation as JSON').default(false))
             .addOption(new commander_1.Option('--check', 'exit with code 1 when any task would be a cache miss').default(false))
+            .addOption(new commander_1.Option('--definition', 'show the resolved definition of the tasks and where it came from instead').default(false))
             .action(async (task, options) => {
             try {
                 const cli = await createCli(fileName, environment, task ? { taskName: task, environmentName: options.env ?? null } : parseWorkLabelScope(options));
+                if (options.definition) {
+                    const definitions = cli.explainDefinition();
+                    if (options.json) {
+                        environment.stdout.write(`${JSON.stringify(definitions, null, 2)}\n`);
+                    }
+                    else {
+                        for (const definition of definitions) {
+                            printTaskDefinition(environment, definition);
+                        }
+                    }
+                    return;
+                }
                 const explanations = await cli.explain({ cacheDefault: options.cache });
                 const missed = explanations.filter((explanation) => explanation.status === 'miss');
                 if (options.json) {

package/dist/schema/schema-parser.js

@@ -33,6 +33,7 @@ async function appendBuildFile(cwd, ctx, environment, fileName, namePrefix, remo
             schema: inputs ? applyInputs(result.data, inputs, namePrefix, fileName) : result.data,
             namePrefix: relativeName,
             remote,
+            inputs,
             references: {},
         };
         ctx.files[key] = scope;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hammerkit",
   "description": "Containerized build tool with incremental caching that runs the same build file locally, in Docker and on Kubernetes.",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "keywords": [
     "build",
     "build-tool",