@enspirit/emb 0.0.5 → 0.0.7

package/README.md

@@ -1,7 +1,7 @@
 emb (Enspirit's Monorepo Builder)
 =================
 
-A CLI to help on Enspirit monorepos. This aims at replacing our aging [Makefile for monorepos](https://github.com/enspirit/makefile-for-monorepos/pulls)
+A CLI to help on Enspirit monorepos. This aims at replacing our aging [Makefile for monorepos](https://github.com/enspirit/makefile-for-monorepos)
 
 <!-- toc -->
 * [Usage](#usage)
@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.0.5 darwin-x64 node-v22.12.0
+@enspirit/emb/0.0.7 darwin-x64 node-v22.12.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -36,10 +36,10 @@ USAGE
 * [`emb images delete`](#emb-images-delete)
 * [`emb images prune`](#emb-images-prune)
 * [`emb ps`](#emb-ps)
-* [`emb run COMPONENT SCRIPT`](#emb-run-component-script)
 * [`emb tasks`](#emb-tasks)
-* [`emb tasks run [TASK]`](#emb-tasks-run-task)
+* [`emb tasks run TASK`](#emb-tasks-run-task)
 * [`emb up`](#emb-up)
+* [`emb update [CHANNEL]`](#emb-update-channel)
 
 ## `emb autocomplete [SHELL]`
 
@@ -78,7 +78,10 @@ Clean the project.
 
 ```
 USAGE
-  $ emb clean [--json]
+  $ emb clean [--json] [-f]
+
+FLAGS
+  -f, --force  Force the deletion of containers & images
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -117,12 +120,13 @@ Build the components of the monorepo
 
 ```
 USAGE
-  $ emb components build [COMPONENT...] [--json] [--flavor <value>]
+  $ emb components build [COMPONENT...] [--json] [--flavor <value>] [--dry-run]
 
 ARGUMENTS
-  COMPONENT...  List of components to build
+  COMPONENT...  List of components to build (defaults to all)
 
 FLAGS
+  --dry-run         Do not build the components but only produce build meta information
   --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
@@ -204,7 +208,10 @@ Stop the whole project.
 
 ```
 USAGE
-  $ emb down [--json]
+  $ emb down [--json] [--flavor <value>]
+
+FLAGS
+  --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -323,22 +330,6 @@ EXAMPLES
   $ emb ps
 ```
 
-## `emb run COMPONENT SCRIPT`
-
-Run an npm script from a component's package.json
-
-```
-USAGE
-  $ emb run COMPONENT SCRIPT
-
-ARGUMENTS
-  COMPONENT  Component name
-  SCRIPT     NPM script to run
-
-DESCRIPTION
-  Run an npm script from a component's package.json
-```
-
 ## `emb tasks`
 
 List tasks.
@@ -357,25 +348,26 @@ EXAMPLES
   $ emb tasks
 ```
 
-## `emb tasks run [TASK]`
+## `emb tasks run TASK`
 
-Run a task.
+Run tasks.
 
 ```
 USAGE
-  $ emb tasks run [TASK...] [--json] [-x container|local]
+  $ emb tasks run TASK... [--json] [-x container|local]
 
 ARGUMENTS
-  TASK...  List of tasks ids to run (eg: component:task)
+  TASK...  List of tasks to run. You can provide either ids or names (eg: component:task or task)
 
 FLAGS
-  -x, --executor=<option>  <options: container|local>
+  -x, --executor=<option>  Where to run the task. (experimental!)
+                           <options: container|local>
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Run a task.
+  Run tasks.
 
 EXAMPLES
   $ emb tasks run
@@ -390,7 +382,7 @@ USAGE
   $ emb up [--json] [--flavor <value>] [-f]
 
 FLAGS
-  -f, --force-recreate  Recreate containers even if their configuration and image haven't changed
+  -f, --force           Bypass caches, force the recreation of containers, etc
       --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
@@ -402,4 +394,42 @@ DESCRIPTION
 EXAMPLES
   $ emb up
 ```
+
+## `emb update [CHANNEL]`
+
+update the emb CLI
+
+```
+USAGE
+  $ emb update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]
+
+FLAGS
+  -a, --available        See available versions.
+  -b, --verbose          Show more details about the available versions.
+  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
+  -v, --version=<value>  Install a specific version.
+      --force            Force a re-download of the requested version.
+
+DESCRIPTION
+  update the emb CLI
+
+EXAMPLES
+  Update to the stable channel:
+
+    $ emb update stable
+
+  Update to a specific version:
+
+    $ emb update --version 1.0.0
+
+  Interactively select version:
+
+    $ emb update --interactive
+
+  See available versions:
+
+    $ emb update --available
+```
+
+_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.7.3/src/commands/update.ts)_
 <!-- commandsstop -->

package/dist/src/cli/commands/clean.d.ts

@@ -10,6 +10,8 @@ export default class CleanCommand extends Command {
     static description: string;
     static enableJsonFlag: boolean;
     static examples: string[];
-    static flags: {};
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
     run(): Promise<void>;
 }

package/dist/src/cli/commands/clean.js

@@ -1,5 +1,5 @@
 import { getContext } from '../../index.js';
-import { Command } from '@oclif/core';
+import { Command, Flags } from '@oclif/core';
 import { Listr } from 'listr2';
 /**
  * For now, only cleans the stores (logs/sentinels)
@@ -12,9 +12,16 @@ export default class CleanCommand extends Command {
     static description = 'Clean the project.';
     static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>'];
-    static flags = {};
+    static flags = {
+        force: Flags.boolean({
+            name: 'force',
+            char: 'f',
+            description: 'Force the deletion of containers & images',
+        }),
+    };
     async run() {
         const { monorepo } = getContext();
+        const { flags } = await this.parse(CleanCommand);
         const runner = new Listr([
             {
                 rendererOptions: { persistentOutput: true },
@@ -25,5 +32,9 @@ export default class CleanCommand extends Command {
             },
         ]);
         await runner.run();
+        await this.config.runCommand('down');
+        await this.config.runCommand('containers:prune');
+        await this.config.runCommand('images:delete', flags.force ? ['--force'] : undefined);
+        await this.config.runCommand('images:prune', flags.force ? ['-a'] : undefined);
     }
 }

package/dist/src/cli/commands/components/build.d.ts

@@ -1,11 +1,15 @@
 import { FlavoredCommand } from '../../index.js';
+import { BuildComponentMeta } from '../../../monorepo/index.js';
 export default class BuildCommand extends FlavoredCommand<typeof BuildCommand> {
     static args: {
         component: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };
     static description: string;
     static examples: string[];
-    static flags: {};
+    static flags: {
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static enableJsonFlag: boolean;
     static strict: boolean;
-    run(): Promise<void>;
+    run(): Promise<Record<string, BuildComponentMeta>>;
 }

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

@@ -1,10 +1,10 @@
-import { Args } from '@oclif/core';
+import { Args, Flags } from '@oclif/core';
 import { FlavoredCommand, getContext } from '../../index.js';
-import { BuildComponentsOperation } from '../../../monorepo/operations/index.js';
+import { BuildComponentsOperation } from '../../../monorepo/index.js';
 export default class BuildCommand extends FlavoredCommand {
     static args = {
         component: Args.string({
-            description: 'List of components to build',
+            description: 'List of components to build (defaults to all)',
             required: false,
         }),
     };
@@ -12,13 +12,22 @@ export default class BuildCommand extends FlavoredCommand {
     static examples = [
         `<%= config.bin %> <%= command.id %> build --flavor development`,
     ];
-    static flags = {};
+    static flags = {
+        'dry-run': Flags.boolean({
+            required: false,
+            description: 'Do not build the components but only produce build meta information',
+        }),
+    };
+    static enableJsonFlag = true;
     static strict = false;
     async run() {
-        const { argv } = await this.parse(BuildCommand);
+        const { argv, flags } = await this.parse(BuildCommand);
         const { monorepo } = getContext();
-        await monorepo.run(new BuildComponentsOperation(), {
-            components: argv.length > 0 ? argv : undefined,
+        return monorepo.run(new BuildComponentsOperation(), {
+            dryRun: flags['dry-run'],
+            components: argv.length > 0
+                ? argv
+                : monorepo.components.map((c) => c.name),
         });
     }
 }

package/dist/src/cli/commands/config/print.js

@@ -7,10 +7,9 @@ export default class ConfigPrint extends FlavoredCommand {
     async run() {
         const { flags } = await this.parse(ConfigPrint);
         const context = await getContext();
-        const { monorepo } = context;
         if (!flags.json) {
-            console.log(YAML.stringify(monorepo.config));
+            this.log(YAML.stringify(context.monorepo.config));
         }
-        return monorepo.config;
+        return context.monorepo.config;
     }
 }

package/dist/src/cli/commands/down.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class DownCommand extends Command {
+import { FlavoredCommand } from '../index.js';
+export default class DownCommand extends FlavoredCommand<typeof DownCommand> {
     static description: string;
     static enableJsonFlag: boolean;
     static examples: string[];

package/dist/src/cli/commands/down.js

@@ -1,8 +1,7 @@
-import { getContext } from '../../index.js';
-import { Command } from '@oclif/core';
 import { Listr } from 'listr2';
-import { down } from '../../docker/index.js';
-export default class DownCommand extends Command {
+import { FlavoredCommand, getContext } from '../index.js';
+import { ComposeDownOperation } from '../../docker/index.js';
+export default class DownCommand extends FlavoredCommand {
     static description = 'Stop the whole project.';
     static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>'];
@@ -12,27 +11,8 @@ export default class DownCommand extends Command {
         const runner = new Listr([
             {
                 rendererOptions: { persistentOutput: true },
-                async task(ctx, task) {
-                    const process = await down({ cwd: monorepo.rootDir });
-                    const handleOutput = (chunk) => {
-                        const line = chunk.toString();
-                        task.output = line.trimEnd(); // This updates the live output in Listr
-                    };
-                    process.stdout?.on('data', handleOutput);
-                    process.stderr?.on('data', handleOutput);
-                    return new Promise((resolve, reject) => {
-                        process.on('exit', (code) => {
-                            if (code === 0) {
-                                resolve(null);
-                            }
-                            else {
-                                reject(new Error(`Command failed with code ${code}`));
-                            }
-                        });
-                        process.on('error', (err) => {
-                            reject(err);
-                        });
-                    });
+                async task() {
+                    return monorepo.run(new ComposeDownOperation(), {});
                 },
                 title: 'Stopping project',
             },

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

@@ -9,14 +9,20 @@ export default class TasksIndex extends Command {
     static flags = {};
     async run() {
         const { flags } = await this.parse(TasksIndex);
-        const context = await getContext();
-        const { monorepo } = context;
-        const { tasks } = monorepo;
+        const { monorepo: { tasks }, } = await getContext();
         if (!flags.json)
             printTable({
                 ...TABLE_DEFAULTS,
-                columns: ['id', 'component', 'name', 'description'],
-                data: tasks,
+                columns: ['name', 'component', 'description', 'id'],
+                data: tasks.toSorted((a, b) => {
+                    if (a.component === b.component) {
+                        return a.name < b.name ? -1 : 1;
+                    }
+                    if (!a.component && b.component) {
+                        return -1;
+                    }
+                    return 0;
+                }),
             });
         return tasks;
     }

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

@@ -1,7 +1,7 @@
 import { Command } from '@oclif/core';
 export default class RunTask extends Command {
     static args: {
-        task: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+        task: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
     static description: string;
     static enableJsonFlag: boolean;
@@ -11,6 +11,4 @@ export default class RunTask extends Command {
     };
     static strict: boolean;
     run(): Promise<void>;
-    private dockerExec;
-    private shellExec;
 }

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

@@ -1,113 +1,31 @@
 import { getContext } from '../../../index.js';
 import { Args, Command, Flags } from '@oclif/core';
-import { Listr } from 'listr2';
-import { PassThrough } from 'node:stream';
-import { getContainer, ListContainersOperation } from '../../../docker/index.js';
-import { dockerExecutor } from '../../../executors/docker.js';
-import { ExecutorType } from '../../../executors/index.js';
-import { shellExecutor } from '../../../executors/shell.js';
+import { ExecutorType, RunTasksOperation } from '../../../monorepo/index.js';
 export default class RunTask extends Command {
     static args = {
         task: Args.string({
-            description: 'List of tasks ids to run (eg: component:task)',
-            required: false,
+            description: 'List of tasks to run. You can provide either ids or names (eg: component:task or task)',
+            required: true,
         }),
     };
-    static description = 'Run a task.';
+    static description = 'Run tasks.';
     static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {
         executor: Flags.string({
-            char: 'x',
             name: 'executor',
-            options: Object.keys(ExecutorType),
+            char: 'x',
+            description: 'Where to run the task. (experimental!)',
+            options: Object.values(ExecutorType),
         }),
     };
     static strict = false;
     async run() {
         const { argv, flags } = await this.parse(RunTask);
-        const context = await getContext();
-        const { monorepo } = context;
-        const toRun = argv.length > 0
-            ? argv.reduce((tasks, t) => {
-                const found = monorepo.tasks.filter((task) => task.id === t);
-                if (found.length === 0) {
-                    throw new Error(`Task ${t} not found`);
-                }
-                return [...tasks, ...found];
-            }, [])
-            : monorepo.tasks;
-        const runTasks = toRun.map((task) => {
-            return {
-                rendererOptions: { persistentOutput: true },
-                task: async (_ctx, listrTask) => {
-                    const type = flags.executor
-                        ? flags.executor
-                        : ExecutorType.container;
-                    const logStream = await monorepo.store.createWriteStream(`logs/tasks/run/${task.id}.log`);
-                    // Gonna log on both the logStream and stdout
-                    const tee = new PassThrough();
-                    tee.pipe(listrTask.stdout());
-                    tee.pipe(logStream);
-                    switch (type) {
-                        case ExecutorType.container: {
-                            return this.dockerExec(task, tee);
-                        }
-                        case ExecutorType.local: {
-                            return this.shellExec(task, tee);
-                        }
-                        default: {
-                            throw new Error(`Unsupported executor: ${type}`);
-                        }
-                    }
-                },
-                title: `Running ${task.id}`,
-            };
-        });
-        const runner = new Listr([
-            {
-                rendererOptions: { persistentOutput: true },
-                async task(ctx, task) {
-                    return task.newListr(runTasks, {
-                        exitOnError: true,
-                        rendererOptions: { collapseSubtasks: false },
-                    });
-                },
-                title: 'Running tasks',
-            },
-        ]);
-        await runner.run();
-    }
-    async dockerExec(task, out) {
-        const { monorepo } = getContext();
-        const matching = await monorepo.run(new ListContainersOperation(), {
-            filters: {
-                label: [
-                    `emb/project=${monorepo.name}`,
-                    `emb/component=${task.component}`,
-                ],
-            },
-        });
-        if (matching.length === 0) {
-            throw new Error(`Could not find a running container for '${task.component}'`);
-        }
-        if (matching.length > 1) {
-            throw new Error(`More than one running container found for '${task.component}'`);
-        }
-        const container = await getContainer(matching[0].Id);
-        return dockerExecutor.run(task.script, {
-            container,
-            out,
-        });
-    }
-    async shellExec(task, out) {
-        const { monorepo } = getContext();
-        const cwd = task.component
-            ? monorepo.component(task.component).rootdir
-            : monorepo.rootDir;
-        return shellExecutor.run(task.script, {
-            cwd,
-            out,
+        const { monorepo } = await getContext();
+        await monorepo.run(new RunTasksOperation(), {
+            tasks: argv,
+            executor: flags.executor,
         });
     }
 }

package/dist/src/cli/commands/up.d.ts

@@ -4,7 +4,7 @@ export default class UpCommand extends FlavoredCommand<typeof UpCommand> {
     static enableJsonFlag: boolean;
     static examples: string[];
     static flags: {
-        'force-recreate': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/src/cli/commands/up.js

@@ -1,49 +1,27 @@
 import { Flags } from '@oclif/core';
-import { Listr } from 'listr2';
 import { FlavoredCommand, getContext } from '../index.js';
-import { up } from '../../docker/index.js';
+import { ComposeUpOperation } from '../../docker/index.js';
+import { BuildComponentsOperation } from '../../monorepo/index.js';
 export default class UpCommand extends FlavoredCommand {
     static description = 'Start the whole project.';
     static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {
-        'force-recreate': Flags.boolean({
+        force: Flags.boolean({
             char: 'f',
             default: false,
-            description: "Recreate containers even if their configuration and image haven't changed",
-            name: 'force-recreate',
+            description: 'Bypass caches, force the recreation of containers, etc',
+            name: 'force',
         }),
     };
     async run() {
+        const { flags } = await this.parse(UpCommand);
         const { monorepo } = getContext();
-        const runner = new Listr([
-            {
-                rendererOptions: { persistentOutput: true },
-                async task(ctx, task) {
-                    const process = await up({ cwd: monorepo.rootDir });
-                    const handleOutput = (chunk) => {
-                        const line = chunk.toString();
-                        task.output = line.trimEnd(); // This updates the live output in Listr
-                    };
-                    process.stdout?.on('data', handleOutput);
-                    process.stderr?.on('data', handleOutput);
-                    return new Promise((resolve, reject) => {
-                        process.on('exit', (code) => {
-                            if (code === 0) {
-                                resolve(null);
-                            }
-                            else {
-                                reject(new Error(`Command failed with code ${code}`));
-                            }
-                        });
-                        process.on('error', (err) => {
-                            reject(err);
-                        });
-                    });
-                },
-                title: 'Starting project',
-            },
-        ]);
-        await runner.run();
+        await monorepo.run(new BuildComponentsOperation(), {
+            components: monorepo.components.map((c) => c.name),
+        });
+        await monorepo.run(new ComposeUpOperation(), {
+            forceRecreate: flags.force,
+        });
     }
 }

package/dist/src/config/convert.d.ts

@@ -1,5 +1,4 @@
-import { Component, Flavor } from './schema.js';
-import { ComponentConfig, FlavorConfig, IMonorepoConfig, UserConfig } from './types.js';
+import { Flavor } from './schema.js';
+import { FlavorConfig, IMonorepoConfig, UserConfig } from './types.js';
 export declare const toFlavor: (flavor: Flavor) => FlavorConfig;
-export declare const toComponent: (cmp: Component) => ComponentConfig;
 export declare const toProjectConfig: (config: UserConfig, rootDir?: string) => IMonorepoConfig;

package/dist/src/config/convert.js

@@ -3,14 +3,9 @@ import { cwd } from 'node:process';
 export const toFlavor = (flavor) => {
     return {
         ...flavor,
-        components: flavor.components?.map(toComponent),
+        components: flavor.components,
     };
 };
-export const toComponent = (cmp) => {
-    return typeof cmp === 'string'
-        ? { context: cmp, name: cmp }
-        : cmp;
-};
 export const toProjectConfig = (config, rootDir) => {
     const project = typeof config.project === 'string'
         ? { name: config.project }
@@ -23,9 +18,10 @@ export const toProjectConfig = (config, rootDir) => {
     else {
         project.rootDir = rootDir || cwd();
     }
-    const components = (config.components || []).map((cmp) => toComponent(cmp));
-    const { defaults, env, flavors, plugins, vars } = config;
+    const components = config.components || [];
+    const { defaults, flavors, ...rest } = config;
     return {
+        ...rest,
         components,
         defaults: {
             ...defaults,
@@ -37,12 +33,9 @@ export const toProjectConfig = (config, rootDir) => {
                 },
             },
         },
-        env,
         flavors: flavors?.map(toFlavor),
-        plugins,
         project: {
             ...project,
         },
-        vars,
     };
 };

package/dist/src/config/index.d.ts

@@ -1,5 +1,6 @@
 import { IMonorepoConfig } from './types.js';
 export * from './convert.js';
+export * from './schema.js';
 export * from './types.js';
 export * from './validation.js';
 export declare const loadConfig: (force?: boolean) => Promise<IMonorepoConfig>;

package/dist/src/config/index.js

@@ -3,6 +3,7 @@ import { dirname } from 'node:path';
 import { toProjectConfig } from './convert.js';
 import { validateUserConfig } from './validation.js';
 export * from './convert.js';
+export * from './schema.js';
 export * from './types.js';
 export * from './validation.js';
 let config;