@enspirit/emb 0.0.7 → 0.0.8

package/README.md

@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.0.7 darwin-x64 node-v22.12.0
+@enspirit/emb/0.0.8 darwin-x64 node-v22.12.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -354,12 +354,13 @@ Run tasks.
 
 ```
 USAGE
-  $ emb tasks run TASK... [--json] [-x container|local]
+  $ emb tasks run TASK... [--json] [-x container|local] [-a]
 
 ARGUMENTS
   TASK...  List of tasks to run. You can provide either ids or names (eg: component:task or task)
 
 FLAGS
+  -a, --all-matching       Run all tasks matching (when multiple matches)
   -x, --executor=<option>  Where to run the task. (experimental!)
                            <options: container|local>
 

package/dist/src/cli/commands/components/build.js

@@ -25,6 +25,7 @@ export default class BuildCommand extends FlavoredCommand {
         const { monorepo } = getContext();
         return monorepo.run(new BuildComponentsOperation(), {
             dryRun: flags['dry-run'],
+            silent: flags.json,
             components: argv.length > 0
                 ? argv
                 : monorepo.components.map((c) => c.name),

package/dist/src/cli/commands/tasks/run.d.ts

@@ -8,6 +8,7 @@ export default class RunTask extends Command {
     static examples: string[];
     static flags: {
         executor: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'all-matching': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     static strict: boolean;
     run(): Promise<void>;

package/dist/src/cli/commands/tasks/run.js

@@ -1,4 +1,4 @@
-import { getContext } from '../../../index.js';
+import { AmbiguousTaskError, getContext } from '../../../index.js';
 import { Args, Command, Flags } from '@oclif/core';
 import { ExecutorType, RunTasksOperation } from '../../../monorepo/index.js';
 export default class RunTask extends Command {
@@ -18,14 +18,32 @@ export default class RunTask extends Command {
             description: 'Where to run the task. (experimental!)',
             options: Object.values(ExecutorType),
         }),
+        'all-matching': Flags.boolean({
+            name: 'all-matching',
+            char: 'a',
+            description: 'Run all tasks matching (when multiple matches)',
+            default: false,
+        }),
     };
     static strict = false;
     async run() {
         const { argv, flags } = await this.parse(RunTask);
         const { monorepo } = await getContext();
-        await monorepo.run(new RunTasksOperation(), {
-            tasks: argv,
-            executor: flags.executor,
-        });
+        try {
+            await monorepo.run(new RunTasksOperation(), {
+                tasks: argv,
+                executor: flags.executor,
+                allMatching: flags['all-matching'],
+            });
+        }
+        catch (error) {
+            if (error instanceof AmbiguousTaskError) {
+                throw error.toCliError([
+                    `Specify just one. Eg: \`emb tasks run ${error.options[0]}\``,
+                    'Run the same command with --all-matches / -a',
+                    'Review the list of tasks by running `emb tasks`',
+                ]);
+            }
+        }
     }
 }

package/dist/src/errors.d.ts

@@ -0,0 +1,57 @@
+export declare class EMBError extends Error {
+    code: string;
+    message: string;
+    constructor(code: string, message: string);
+    toCliError(suggestions: string[], ref?: string): CliError;
+}
+export declare class CliError extends EMBError {
+    /**
+     * a unique error code for this error class
+     */
+    code: string;
+    /**
+     * message to display related to the error
+     */
+    message: string;
+    /**
+     * a suggestion that may be useful or provide additional context
+     */
+    suggestions?: string[] | undefined;
+    /**
+     * a url to find out more information related to this error
+     * or fixing the error
+     */
+    ref?: string | undefined;
+    constructor(
+    /**
+     * a unique error code for this error class
+     */
+    code: string, 
+    /**
+     * message to display related to the error
+     */
+    message: string, 
+    /**
+     * a suggestion that may be useful or provide additional context
+     */
+    suggestions?: string[] | undefined, 
+    /**
+     * a url to find out more information related to this error
+     * or fixing the error
+     */
+    ref?: string | undefined);
+}
+export declare class AmbiguousTaskError extends EMBError {
+    options: string[];
+    constructor(msg: string, options: string[]);
+}
+export declare class UnkownReferenceError extends EMBError {
+    constructor(msg: string);
+}
+export declare class TaskNameCollisionError extends EMBError {
+    collisions: Array<string>;
+    constructor(msg: string, collisions: Array<string>);
+}
+export declare class CircularDependencyError extends EMBError {
+    constructor(msg: string);
+}

package/dist/src/errors.js

@@ -0,0 +1,66 @@
+export class EMBError extends Error {
+    code;
+    message;
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.message = message;
+    }
+    toCliError(suggestions, ref) {
+        return new CliError(this.code, this.message, suggestions, ref);
+    }
+}
+export class CliError extends EMBError {
+    code;
+    message;
+    suggestions;
+    ref;
+    constructor(
+    /**
+     * a unique error code for this error class
+     */
+    code, 
+    /**
+     * message to display related to the error
+     */
+    message, 
+    /**
+     * a suggestion that may be useful or provide additional context
+     */
+    suggestions, 
+    /**
+     * a url to find out more information related to this error
+     * or fixing the error
+     */
+    ref) {
+        super(code, message);
+        this.code = code;
+        this.message = message;
+        this.suggestions = suggestions;
+        this.ref = ref;
+    }
+}
+export class AmbiguousTaskError extends EMBError {
+    options;
+    constructor(msg, options) {
+        super('AMBIG_TASK', msg);
+        this.options = options;
+    }
+}
+export class UnkownReferenceError extends EMBError {
+    constructor(msg) {
+        super('UNKNOWN_REF', msg);
+    }
+}
+export class TaskNameCollisionError extends EMBError {
+    collisions;
+    constructor(msg, collisions) {
+        super('UNKNOWN_REF', msg);
+        this.collisions = collisions;
+    }
+}
+export class CircularDependencyError extends EMBError {
+    constructor(msg) {
+        super('CIRCULAR_DEPS', msg);
+    }
+}

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './context.js';
+export * from './errors.js';
 export * from './types.js';
 export { run } from '@oclif/core';

package/dist/src/index.js

@@ -1,3 +1,4 @@
 export * from './context.js';
+export * from './errors.js';
 export * from './types.js';
 export { run } from '@oclif/core';

package/dist/src/monorepo/monorepo.d.ts

@@ -24,6 +24,7 @@ export declare class Monorepo {
     expand(str: string, expander?: TemplateExpander): Promise<string>;
     expand<R extends Record<string, unknown>>(record: R, expander?: TemplateExpander): Promise<R>;
     private installStore;
+    private installEnv;
     init(): Promise<Monorepo>;
     join(...paths: string[]): string;
     run<I, O>(operation: IOperation<I, O>, args: I): Promise<O>;

package/dist/src/monorepo/monorepo.js

@@ -84,6 +84,19 @@ export class Monorepo {
         this._store = store || new EMBStore(this);
         await this._store.init();
     }
+    async installEnv() {
+        // Expand env vars at the init and then we don't expand anymore
+        // The only available source for them is the existing env
+        const expander = new TemplateExpander();
+        const options = {
+            default: 'env',
+            sources: {
+                env: process.env,
+            },
+        };
+        const expanded = await expander.expandRecord(this._config.env, options);
+        Object.assign(process.env, expanded);
+    }
     // Initialize
     async init() {
         if (this.initialized) {
@@ -98,17 +111,7 @@ export class Monorepo {
             const newConfig = await plugin.extendConfig?.(await pConfig);
             return newConfig ?? pConfig;
         }, Promise.resolve(this._config));
-        // Expand env vars at the init and then we don't expand anymore
-        // The only available source for them is the existing env
-        const expander = new TemplateExpander();
-        const options = {
-            default: 'env',
-            sources: {
-                env: process.env,
-            },
-        };
-        const expanded = await expander.expandRecord(this._config.env, options);
-        Object.assign(process.env, expanded);
+        await this.installEnv();
         this.initialized = true;
         await Promise.all(plugins.map(async (p) => {
             await p.init?.();
@@ -125,6 +128,7 @@ export class Monorepo {
     async withFlavor(name) {
         const repo = new Monorepo(this._config.withFlavor(name));
         await repo.installStore();
+        await repo.installEnv();
         return repo;
     }
 }

package/dist/src/monorepo/operations/components/BuildComponentsOperation.d.ts

@@ -11,6 +11,7 @@ export type BuildComponentMeta = {
 declare const schema: z.ZodObject<{
     components: z.ZodOptional<z.ZodArray<z.ZodString>>;
     dryRun: z.ZodOptional<z.ZodBoolean>;
+    silent: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export declare class BuildComponentsOperation extends AbstractOperation<typeof schema, Record<string, BuildComponentMeta>> {
     constructor();

package/dist/src/monorepo/operations/components/BuildComponentsOperation.js

@@ -13,6 +13,10 @@ const schema = z.object({
         .boolean()
         .optional()
         .describe('Do not build but return the config that would be used to build the images'),
+    silent: z
+        .boolean()
+        .optional()
+        .describe('Do not produce any output on the terminal'),
 });
 export class BuildComponentsOperation extends AbstractOperation {
     constructor() {
@@ -37,6 +41,7 @@ export class BuildComponentsOperation extends AbstractOperation {
             };
         }));
         const list = manager.newListr([...tasks], {
+            renderer: input.silent ? 'silent' : 'default',
             rendererOptions: { persistentOutput: true },
             ctx: {},
         });
@@ -72,7 +77,7 @@ export class BuildComponentsOperation extends AbstractOperation {
                         const diff = await prereqPlugin.diff(cmp, ctx.build.prerequisites, lastValue, ctx.preBuildMeta);
                         if (!diff) {
                             ctx.cacheHit = true;
-                            // parentTask.skip(`${parentTask.title} (cache hit)`);
+                            parentTask.skip(`${parentTask.title} (cache hit)`);
                         }
                     }
                 },
@@ -118,7 +123,7 @@ export class BuildComponentsOperation extends AbstractOperation {
                 async task(ctx) {
                     parentContext[cmp.name] = ctx;
                     if (ctx.dryRun) {
-                        // parentTask.skip(`${parentTask.title} (dry run)`);
+                        parentTask.skip(`${parentTask.title} (dry run)`);
                     }
                 },
             },

package/dist/src/monorepo/operations/tasks/RunTasksOperation.d.ts

@@ -8,13 +8,12 @@ export declare enum ExecutorType {
 export type RunTasksOperationParams = {
     tasks: Array<string>;
     executor?: ExecutorType | undefined;
+    allMatching?: boolean;
 };
 export type TaskWithScript = TaskInfo & {
     script: string;
 };
 export declare class RunTasksOperation implements IOperation<RunTasksOperationParams, Array<TaskInfo>> {
-    protected out?: Writable | undefined;
-    constructor(out?: Writable | undefined);
     run(params: RunTasksOperationParams): Promise<Array<TaskInfo>>;
     protected runDocker(task: TaskWithScript, out?: Writable): Promise<void>;
     protected runLocal(task: TaskWithScript): Promise<import("stream").Readable>;

package/dist/src/monorepo/operations/tasks/RunTasksOperation.js

@@ -9,10 +9,6 @@ export var ExecutorType;
     ExecutorType["local"] = "local";
 })(ExecutorType || (ExecutorType = {}));
 export class RunTasksOperation {
-    out;
-    constructor(out) {
-        this.out = out;
-    }
     async run(params) {
         const { monorepo } = getContext();
         // First ensure the selection is valid (user can use task IDs or names)
@@ -20,7 +16,9 @@ export class RunTasksOperation {
             idField: 'id',
             depField: 'pre',
         });
-        const ordered = findRunOrder(params.tasks, collection);
+        const ordered = findRunOrder(params.tasks, collection, {
+            onAmbiguous: params.allMatching ? 'runAll' : 'error',
+        });
         const runner = new Manager({
             concurrent: false,
             exitOnError: false,

package/dist/src/monorepo/utils/findRunOrder.js

@@ -1,4 +1,5 @@
 import graphlib from 'graphlib';
+import { AmbiguousTaskError, CircularDependencyError, TaskNameCollisionError, UnkownReferenceError, } from '../../errors.js';
 export class EMBCollection {
     items;
     idField;
@@ -63,8 +64,7 @@ export class EMBCollection {
                 parts.push(`id↔name collisions (${collisions.length}):\n` +
                     collisions.join('\n'));
             }
-            // eslint-disable-next-line unicorn/error-message
-            throw new Error(parts.join('\n\n'));
+            throw new TaskNameCollisionError('Collision between task names and ids', parts);
         }
     }
     /** All items (stable array iteration) */
@@ -83,13 +83,13 @@ export class EMBCollection {
             return opts?.multiple ? [idHit] : idHit;
         const nameHits = this.byName.get(ref) ?? [];
         if (nameHits.length === 0) {
-            throw new Error(`Unknown reference "${ref}"`);
+            throw new UnkownReferenceError(`Unknown reference "${ref}"`);
         }
         if (opts?.multiple)
             return nameHits;
         if (nameHits.length > 1) {
-            const ids = nameHits.map((t) => this.idOf(t)).join(', ');
-            throw new Error(`Ambiguous reference "${ref}" matches multiple ids: [${ids}]`);
+            const ids = nameHits.map((t) => this.idOf(t));
+            throw new AmbiguousTaskError(`Ambiguous reference "${ref}" matches multiple id/name`, ids);
         }
         return nameHits[0];
     }
@@ -136,7 +136,7 @@ export function findRunOrder(selection, collection, { onAmbiguous = 'error' } =
     const g = buildGraph(collection, onAmbiguous);
     const cycles = graphlib.alg.findCycles(g);
     if (cycles.length > 0) {
-        throw new Error(`Circular dependencies detected: ${JSON.stringify(cycles)}`);
+        throw new CircularDependencyError(`Circular dependencies detected: ${JSON.stringify(cycles)}`);
     }
     const selectedIds = new Set();
     for (const ref of selection)

package/oclif.manifest.json

@@ -226,12 +226,10 @@
         "index.js"
       ]
     },
-    "containers": {
-      "aliases": [
-        "ps"
-      ],
+    "config:print": {
+      "aliases": [],
       "args": {},
-      "description": "List docker containers.",
+      "description": "Print the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -243,18 +241,18 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "all": {
-          "char": "a",
-          "description": "Retun all containers. By default, only running containers are shown",
-          "name": "all",
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
           "required": false,
-          "allowNo": false,
-          "type": "boolean"
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers",
+      "id": "config:print",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -266,14 +264,16 @@
         "src",
         "cli",
         "commands",
-        "containers",
-        "index.js"
+        "config",
+        "print.js"
       ]
     },
-    "containers:prune": {
-      "aliases": [],
+    "containers": {
+      "aliases": [
+        "ps"
+      ],
       "args": {},
-      "description": "Prune containers.",
+      "description": "List docker containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -284,11 +284,19 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "all": {
+          "char": "a",
+          "description": "Retun all containers. By default, only running containers are shown",
+          "name": "all",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers:prune",
+      "id": "containers",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -301,13 +309,13 @@
         "cli",
         "commands",
         "containers",
-        "prune.js"
+        "index.js"
       ]
     },
-    "config:print": {
+    "containers:prune": {
       "aliases": [],
       "args": {},
-      "description": "Print the current config.",
+      "description": "Prune containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -318,19 +326,11 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:print",
+      "id": "containers:prune",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -342,14 +342,14 @@
         "src",
         "cli",
         "commands",
-        "config",
-        "print.js"
+        "containers",
+        "prune.js"
       ]
     },
-    "images:delete": {
+    "tasks": {
       "aliases": [],
       "args": {},
-      "description": "Delete project images.",
+      "description": "List tasks.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -360,19 +360,11 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "force": {
-          "char": "f",
-          "description": "Remove the image even if it is being used by stopped containers or has other tags",
-          "name": "force",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "images:delete",
+      "id": "tasks",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -384,14 +376,20 @@
         "src",
         "cli",
         "commands",
-        "images",
-        "delete.js"
+        "tasks",
+        "index.js"
       ]
     },
-    "images": {
+    "tasks:run": {
       "aliases": [],
-      "args": {},
-      "description": "List docker images.",
+      "args": {
+        "task": {
+          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
+          "name": "task",
+          "required": true
+        }
+      },
+      "description": "Run tasks.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -403,22 +401,33 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "all": {
+        "executor": {
+          "char": "x",
+          "description": "Where to run the task. (experimental!)",
+          "name": "executor",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "container",
+            "local"
+          ],
+          "type": "option"
+        },
+        "all-matching": {
           "char": "a",
-          "description": "Show all images. Only images from a final layer (no children) are shown by default.",
-          "name": "all",
-          "required": false,
+          "description": "Run all tasks matching (when multiple matches)",
+          "name": "all-matching",
           "allowNo": false,
           "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "images",
+      "id": "tasks:run",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -426,14 +435,14 @@
         "src",
         "cli",
         "commands",
-        "images",
-        "index.js"
+        "tasks",
+        "run.js"
       ]
     },
-    "images:prune": {
+    "images:delete": {
       "aliases": [],
       "args": {},
-      "description": "Prune project images.",
+      "description": "Delete project images.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -445,10 +454,10 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "all": {
-          "char": "a",
-          "description": "Prune all images. When set to true all images will be pruned, not only dangling ones",
-          "name": "all",
+        "force": {
+          "char": "f",
+          "description": "Remove the image even if it is being used by stopped containers or has other tags",
+          "name": "force",
           "required": false,
           "allowNo": false,
           "type": "boolean"
@@ -456,7 +465,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "images:prune",
+      "id": "images:delete",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -469,13 +478,13 @@
         "cli",
         "commands",
         "images",
-        "prune.js"
+        "delete.js"
       ]
     },
-    "tasks": {
+    "images": {
       "aliases": [],
       "args": {},
-      "description": "List tasks.",
+      "description": "List docker images.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -486,11 +495,19 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "all": {
+          "char": "a",
+          "description": "Show all images. Only images from a final layer (no children) are shown by default.",
+          "name": "all",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks",
+      "id": "images",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -502,20 +519,14 @@
         "src",
         "cli",
         "commands",
-        "tasks",
+        "images",
         "index.js"
       ]
     },
-    "tasks:run": {
+    "images:prune": {
       "aliases": [],
-      "args": {
-        "task": {
-          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
-          "name": "task",
-          "required": true
-        }
-      },
-      "description": "Run tasks.",
+      "args": {},
+      "description": "Prune project images.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -527,26 +538,22 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "executor": {
-          "char": "x",
-          "description": "Where to run the task. (experimental!)",
-          "name": "executor",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "container",
-            "local"
-          ],
-          "type": "option"
+        "all": {
+          "char": "a",
+          "description": "Prune all images. When set to true all images will be pruned, not only dangling ones",
+          "name": "all",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks:run",
+      "id": "images:prune",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -554,10 +561,10 @@
         "src",
         "cli",
         "commands",
-        "tasks",
-        "run.js"
+        "images",
+        "prune.js"
       ]
     }
   },
-  "version": "0.0.7"
+  "version": "0.0.8"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@enspirit/emb",
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "keywords": ["monorepo", "docker", "taskrunner", "ci", "docker compose", "sentinel", "makefile"],
   "author": "Louis Lambeau <louis.lambeau@enspirit.be>",
   "license": "ISC",
@@ -109,6 +109,11 @@
     ],
     "topicSeparator": " ",
     "topics": {
+      "images": {"description": "List, delete, prune docker containers" },
+      "containers": {"description": "List, delete, prune docker images" },
+      "components": {"description": "List & build components resources" },
+      "config": {"description": "It's all about config" },
+      "tasks": {"description": "List and run tasks" }
     }
   }
 }