@enspirit/emb 0.0.4 → 0.0.6

package/dist/src/monorepo/operations/shell/ExecuteLocalCommandOperation.d.ts

@@ -0,0 +1,18 @@
+import { ResultPromise } from 'execa';
+import { Writable } from 'node:stream';
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Exec/operation/ContainerExec
+ */
+declare const schema: z.ZodObject<{
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    script: z.ZodString;
+    workingDir: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare class ExecuteLocalCommandOperation extends AbstractOperation<typeof schema, ResultPromise> {
+    protected out?: Writable | undefined;
+    constructor(out?: Writable | undefined);
+    protected _run(input: z.input<typeof schema>): Promise<ResultPromise>;
+}
+export {};

package/dist/src/monorepo/operations/shell/ExecuteLocalCommandOperation.js

@@ -0,0 +1,35 @@
+import { execa } from 'execa';
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Exec/operation/ContainerExec
+ */
+const schema = z.object({
+    env: z
+        .record(z.string(), z.string())
+        .optional()
+        .describe('A list of environment variables in the form'),
+    script: z.string().describe('Command to run, as a string'),
+    workingDir: z
+        .string()
+        .optional()
+        .describe('The working directory for the exec process inside the container'),
+});
+export class ExecuteLocalCommandOperation extends AbstractOperation {
+    out;
+    constructor(out) {
+        super(schema);
+        this.out = out;
+    }
+    async _run(input) {
+        const process = execa(input.script, {
+            all: true,
+            cwd: input.workingDir,
+            shell: true,
+        });
+        if (this.out) {
+            process.all?.pipe(this.out);
+        }
+        return process;
+    }
+}

package/dist/src/monorepo/operations/shell/index.d.ts

@@ -0,0 +1 @@
+export * from './ExecuteLocalCommandOperation.js';

package/dist/src/monorepo/operations/shell/index.js

@@ -0,0 +1 @@
+export * from './ExecuteLocalCommandOperation.js';

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

@@ -0,0 +1,18 @@
+import { Writable } from 'node:stream';
+import { TaskInfo } from '../../types.js';
+import { IOperation } from '../../../operations/types.js';
+export declare enum ExecutorType {
+    container = "container",
+    local = "local"
+}
+export type RunTaskOperationParams = {
+    executor: ExecutorType;
+    task: TaskInfo;
+};
+export declare class RunTaskOperation implements IOperation<RunTaskOperationParams, void> {
+    protected out?: Writable | undefined;
+    constructor(out?: Writable | undefined);
+    run(params: RunTaskOperationParams): Promise<void>;
+    private runDocker;
+    private runLocal;
+}

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

@@ -0,0 +1,50 @@
+import { getContext } from '../../../index.js';
+import { ContainerExecOperation } from '../../../docker/index.js';
+import { ExecuteLocalCommandOperation, GetComponentContainerOperation, } from '../index.js';
+export var ExecutorType;
+(function (ExecutorType) {
+    ExecutorType["container"] = "container";
+    ExecutorType["local"] = "local";
+})(ExecutorType || (ExecutorType = {}));
+export class RunTaskOperation {
+    out;
+    constructor(out) {
+        this.out = out;
+    }
+    async run(params) {
+        switch (params.executor) {
+            case ExecutorType.container: {
+                return this.runDocker(params);
+            }
+            case ExecutorType.local: {
+                return this.runLocal(params);
+            }
+            default: {
+                throw new Error(`Unsupported executor type: ${params.executor}`);
+            }
+        }
+    }
+    async runDocker(params) {
+        const { monorepo } = getContext();
+        if (!params.task.component) {
+            throw new Error(`Support for non-component tasks not implemented`);
+        }
+        const containerInfo = await monorepo.run(new GetComponentContainerOperation(), params.task.component);
+        await monorepo.run(new ContainerExecOperation(this.out), {
+            attachStderr: true,
+            attachStdout: true,
+            container: containerInfo.Id,
+            script: params.task.script,
+        });
+    }
+    async runLocal(params) {
+        const { monorepo } = getContext();
+        const cwd = params.task.component
+            ? monorepo.component(params.task.component).rootdir
+            : monorepo.rootDir;
+        await monorepo.run(new ExecuteLocalCommandOperation(this.out), {
+            script: params.task.script,
+            workingDir: cwd,
+        });
+    }
+}

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

@@ -0,0 +1 @@
+export * from './RunTaskOperation.js';

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

@@ -0,0 +1 @@
+export * from './RunTaskOperation.js';

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

@@ -0,0 +1,15 @@
+import { Monorepo, MonorepoConfig } from '../index.js';
+import { AbstractPlugin } from './plugin.js';
+export type ComponentDiscoverPluginOptions = {
+    glob?: string;
+    ignore?: string | string[];
+};
+export declare const ComponentDiscoverPluginDefaultOptions: {
+    glob: string;
+};
+export declare class ComponentDiscoverPlugin extends AbstractPlugin<ComponentDiscoverPluginOptions> {
+    protected monorepo: Monorepo;
+    static name: string;
+    constructor(config: Partial<ComponentDiscoverPluginOptions>, monorepo: Monorepo);
+    extendConfig(config: MonorepoConfig): Promise<MonorepoConfig>;
+}

package/dist/src/monorepo/plugins/{ComponentsDiscover.js → ComponentDiscoverPlugin.js}

@@ -3,10 +3,22 @@ import { glob } from 'glob';
 import { dirname } from 'node:path';
 import { MonorepoConfig } from '../index.js';
 import { AbstractPlugin } from './plugin.js';
+export const ComponentDiscoverPluginDefaultOptions = {
+    glob: '*/Dockerfile',
+};
 export class ComponentDiscoverPlugin extends AbstractPlugin {
+    monorepo;
     static name = 'autodiscover';
+    constructor(config, monorepo) {
+        super({
+            ...ComponentDiscoverPluginDefaultOptions,
+            ...config,
+        }, monorepo);
+        this.monorepo = monorepo;
+    }
     async extendConfig(config) {
-        const files = await glob('*/Dockerfile', {
+        const files = await glob(this.config.glob || ComponentDiscoverPluginDefaultOptions.glob, {
+            ...this.config,
             cwd: config.project.rootDir,
         });
         const overrides = files.map((path) => {

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

@@ -0,0 +1,14 @@
+import { Monorepo, MonorepoConfig } from '../index.js';
+import { AbstractPlugin } from './plugin.js';
+export type EmbfileLoaderPluginOptions = {
+    glob?: string;
+};
+export declare const EmbfileLoaderPluginDefaultOptions: {
+    glob: string;
+};
+export declare class EmbfileLoaderPlugin extends AbstractPlugin<EmbfileLoaderPluginOptions> {
+    protected monorepo: Monorepo;
+    static name: string;
+    constructor(config: Partial<EmbfileLoaderPluginOptions>, monorepo: Monorepo);
+    extendConfig(config: MonorepoConfig): Promise<MonorepoConfig>;
+}

package/dist/src/monorepo/plugins/EmbfileLoaderPlugin.js

@@ -0,0 +1,33 @@
+import { glob } from 'glob';
+import { join } from 'node:path';
+import { validateEmbfile } from '../../config/index.js';
+import { AbstractPlugin } from './plugin.js';
+export const EmbfileLoaderPluginDefaultOptions = {
+    glob: '*/Embfile.{yaml,yml}',
+};
+export class EmbfileLoaderPlugin extends AbstractPlugin {
+    monorepo;
+    static name = 'embfiles';
+    constructor(config, monorepo) {
+        super({
+            ...EmbfileLoaderPluginDefaultOptions,
+            ...config,
+        }, monorepo);
+        this.monorepo = monorepo;
+    }
+    async extendConfig(config) {
+        const files = await glob(this.config.glob || EmbfileLoaderPluginDefaultOptions.glob, {
+            ...this.config,
+            cwd: config.project.rootDir,
+        });
+        const newConfig = await files.reduce(async (pConfig, path) => {
+            const config = await pConfig;
+            const embfile = await join(config.project.rootDir, path);
+            const component = await validateEmbfile(embfile);
+            return config.with({
+                components: [component],
+            });
+        }, Promise.resolve(config));
+        return newConfig;
+    }
+}

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

@@ -1,7 +1,8 @@
 import { AbstractPlugin } from './plugin.js';
-export * from './ComponentsDiscover.js';
+export * from './ComponentDiscoverPlugin.js';
 export * from './DotEnvPlugin.js';
-import { Monorepo } from '../monorepo.js';
+export * from './EmbfileLoaderPlugin.js';
+import { Monorepo } from '../index.js';
 export type AbstractPluginConstructor = new <C, P extends AbstractPlugin<C>>(config: C, monorepo: Monorepo) => P;
 export declare const registerPlugin: (plugin: AbstractPluginConstructor) => void;
 export declare const getPlugin: (name: string) => AbstractPluginConstructor;

package/dist/src/monorepo/plugins/index.js

@@ -1,7 +1,9 @@
-export * from './ComponentsDiscover.js';
+export * from './ComponentDiscoverPlugin.js';
 export * from './DotEnvPlugin.js';
-import { ComponentDiscoverPlugin } from './ComponentsDiscover.js';
+export * from './EmbfileLoaderPlugin.js';
+import { ComponentDiscoverPlugin } from './ComponentDiscoverPlugin.js';
 import { DotEnvPlugin } from './DotEnvPlugin.js';
+import { EmbfileLoaderPlugin } from './EmbfileLoaderPlugin.js';
 const PluginRegistry = new Map();
 export const registerPlugin = (plugin) => {
     if (PluginRegistry.has(plugin.name)) {
@@ -18,3 +20,4 @@ export const getPlugin = (name) => {
 /** Not sure why we need casting */
 registerPlugin(ComponentDiscoverPlugin);
 registerPlugin(DotEnvPlugin);
+registerPlugin(EmbfileLoaderPlugin);

package/dist/src/operations/abstract/AbstractOperation.d.ts

@@ -1,6 +1,6 @@
 import { EmbContext } from '../../index.js';
 import * as z from 'zod';
-import { IOperation } from '../types.js';
+import { IOperation } from '../index.js';
 export declare abstract class AbstractOperation<S extends z.Schema, O = unknown> implements IOperation<z.infer<S>, O> {
     protected inputSchema: S;
     protected context: EmbContext;

package/dist/src/utils/deepMergeArray.d.ts

@@ -1 +1,4 @@
+export declare const byName: <T extends {
+    name: string;
+}>(item: T) => string;
 export declare const deepMergeArray: <T>(target: Array<T>, source: Array<T>, identifierFn?: (item: T) => unknown) => Array<T>;

package/dist/src/utils/deepMergeArray.js

@@ -1,4 +1,5 @@
 import deepmerge from '@fastify/deepmerge';
+export const byName = (item) => item.name;
 export const deepMergeArray = (target, source, identifierFn) => {
     if (!identifierFn) {
         return deepmerge()(target, source);

package/oclif.manifest.json

@@ -204,12 +204,10 @@
         "index.js"
       ]
     },
-    "containers": {
-      "aliases": [
-        "ps"
-      ],
+    "config:print": {
+      "aliases": [],
       "args": {},
-      "description": "List docker containers.",
+      "description": "Print the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -221,18 +219,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",
@@ -244,14 +242,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 %>"
       ],
@@ -262,11 +262,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",
@@ -279,13 +287,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 %>"
       ],
@@ -296,19 +304,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",
@@ -320,42 +320,8 @@
         "src",
         "cli",
         "commands",
-        "config",
-        "print.js"
-      ]
-    },
-    "run": {
-      "aliases": [],
-      "args": {
-        "component": {
-          "description": "Component name",
-          "name": "component",
-          "required": true
-        },
-        "script": {
-          "description": "NPM script to run",
-          "name": "script",
-          "required": true
-        }
-      },
-      "description": "Run an npm script from a component's package.json",
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "run",
-      "pluginAlias": "@enspirit/emb",
-      "pluginName": "@enspirit/emb",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "src",
-        "cli",
-        "commands",
-        "run",
-        "index.js"
+        "containers",
+        "prune.js"
       ]
     },
     "images:delete": {
@@ -570,5 +536,5 @@
       ]
     }
   },
-  "version": "0.0.4"
+  "version": "0.0.6"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@enspirit/emb",
   "type": "module",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "keywords": ["monorepo", "docker", "taskrunner", "ci", "docker compose", "sentinel", "makefile"],
   "author": "Louis Lambeau <louis.lambeau@enspirit.be>",
   "license": "ISC",
@@ -29,6 +29,7 @@
     "version": "oclif readme && git add README.md"
   },
   "dependencies": {
+    "@fastify/deepmerge": "^3.1.0",
     "@listr2/manager": "^3.0.1",
     "@oclif/core": "^4.5.2",
     "@oclif/plugin-autocomplete": "^3.2.34",
@@ -55,7 +56,6 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.32.0",
-    "@fastify/deepmerge": "^3.1.0",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
     "@tsconfig/node20": "^20.1.6",

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

@@ -1,10 +0,0 @@
-import { Command } from '@oclif/core';
-export default class RunComponentScript extends Command {
-    static args: {
-        component: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-        script: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static description: string;
-    static strict: boolean;
-    run(): Promise<void>;
-}

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

@@ -1,49 +0,0 @@
-import { getContext } from '../../../index.js';
-import { Args, Command } from '@oclif/core';
-import { Listr } from 'listr2';
-import { spawn } from 'node:child_process';
-import fs from 'node:fs/promises';
-export default class RunComponentScript extends Command {
-    static args = {
-        component: Args.string({
-            description: 'Component name',
-            required: true,
-        }),
-        script: Args.string({ description: 'NPM script to run', required: true }),
-    };
-    static description = "Run an npm script from a component's package.json";
-    static strict = true;
-    async run() {
-        const { args } = await this.parse(RunComponentScript);
-        const { monorepo } = getContext();
-        const component = monorepo.component(args.component);
-        const pkgPath = component.join('package.json');
-        const tasks = new Listr([
-            {
-                rendererOptions: {
-                    persistentOutput: true,
-                },
-                async task(_ctx, _task) {
-                    try {
-                        const pkgRaw = await fs.readFile(pkgPath, 'utf8');
-                        const pkg = JSON.parse(pkgRaw);
-                        if (!pkg.scripts?.[args.script]) {
-                            throw new Error(`Script "${args.script}" not found in ${component.name}/package.json`);
-                        }
-                        return spawn('npm', ['run', args.script], {
-                            cwd: component.rootdir,
-                        }).stdout;
-                    }
-                    catch (error) {
-                        const error_ = error instanceof Error
-                            ? new TypeError(`Failed to run ${component.name}:${args.script}\n${error.message}`)
-                            : new Error(`Failed to run ${component.name}:${args.script}\n${error}`);
-                        throw error_;
-                    }
-                },
-                title: `Running npm script '${args.script}' on ${args.component}`,
-            },
-        ], { concurrent: false });
-        await tasks.run();
-    }
-}

package/dist/src/executors/docker.d.ts

@@ -1,6 +0,0 @@
-import { Container } from 'dockerode';
-import { Executor, ExecutorRunOptions } from './types.js';
-export type DockerExecutorRunOptions = ExecutorRunOptions & {
-    container: Container;
-};
-export declare const dockerExecutor: Executor<DockerExecutorRunOptions>;

package/dist/src/executors/docker.js

@@ -1,14 +0,0 @@
-export const dockerExecutor = {
-    async run(script, options) {
-        const exec = await options.container.exec({
-            AttachStderr: true,
-            AttachStdout: true,
-            Cmd: ['bash', '-c', script],
-        });
-        const stream = await exec.start({});
-        if (options.out) {
-            options.container.modem.demuxStream(stream, options.out, options.out);
-        }
-        return stream;
-    },
-};

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

@@ -1,6 +0,0 @@
-export * from './docker.js';
-export * from './shell.js';
-export declare enum ExecutorType {
-    container = "container",
-    local = "local"
-}

package/dist/src/executors/index.js

@@ -1,7 +0,0 @@
-export * from './docker.js';
-export * from './shell.js';
-export var ExecutorType;
-(function (ExecutorType) {
-    ExecutorType["container"] = "container";
-    ExecutorType["local"] = "local";
-})(ExecutorType || (ExecutorType = {}));

package/dist/src/executors/shell.d.ts

@@ -1,2 +0,0 @@
-import { Executor } from './types.js';
-export declare const shellExecutor: Executor;

package/dist/src/executors/shell.js

@@ -1,14 +0,0 @@
-import { execa } from 'execa';
-export const shellExecutor = {
-    async run(script, options) {
-        const process = execa(script, {
-            all: true,
-            cwd: options.cwd,
-            shell: true,
-        });
-        if (options.out) {
-            process.all?.pipe(options.out);
-        }
-        return process;
-    },
-};

package/dist/src/executors/types.d.ts

@@ -1,8 +0,0 @@
-import { Writable } from 'node:stream';
-export type ExecutorRunOptions = {
-    cwd?: string;
-    out?: Writable;
-};
-export type Executor<RO extends ExecutorRunOptions = ExecutorRunOptions, T = unknown> = {
-    run(script: string, options?: RO): Promise<T>;
-};

package/dist/src/executors/types.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,6 +0,0 @@
-import { MonorepoConfig } from '../index.js';
-import { AbstractPlugin } from './plugin.js';
-export declare class ComponentDiscoverPlugin extends AbstractPlugin {
-    static name: string;
-    extendConfig(config: MonorepoConfig): Promise<MonorepoConfig>;
-}