@enspirit/emb 0.0.2 → 0.0.3

package/README.md

@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.0.2 darwin-x64 node-v22.12.0
+@enspirit/emb/0.0.3 darwin-x64 node-v22.12.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -24,17 +24,22 @@ USAGE
 # Commands
 <!-- commands -->
 * [`emb autocomplete [SHELL]`](#emb-autocomplete-shell)
+* [`emb clean`](#emb-clean)
+* [`emb components`](#emb-components)
+* [`emb components build [COMPONENT]`](#emb-components-build-component)
+* [`emb config print`](#emb-config-print)
+* [`emb containers`](#emb-containers)
+* [`emb containers prune`](#emb-containers-prune)
+* [`emb down`](#emb-down)
 * [`emb help [COMMAND]`](#emb-help-command)
-* [`emb plugins`](#emb-plugins)
-* [`emb plugins add PLUGIN`](#emb-plugins-add-plugin)
-* [`emb plugins:inspect PLUGIN...`](#emb-pluginsinspect-plugin)
-* [`emb plugins install PLUGIN`](#emb-plugins-install-plugin)
-* [`emb plugins link PATH`](#emb-plugins-link-path)
-* [`emb plugins remove [PLUGIN]`](#emb-plugins-remove-plugin)
-* [`emb plugins reset`](#emb-plugins-reset)
-* [`emb plugins uninstall [PLUGIN]`](#emb-plugins-uninstall-plugin)
-* [`emb plugins unlink [PLUGIN]`](#emb-plugins-unlink-plugin)
-* [`emb plugins update`](#emb-plugins-update)
+* [`emb images`](#emb-images)
+* [`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 up`](#emb-up)
 
 ## `emb autocomplete [SHELL]`
 
@@ -67,313 +72,334 @@ EXAMPLES
 
 _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.34/src/commands/autocomplete/index.ts)_
 
-## `emb help [COMMAND]`
+## `emb clean`
 
-Display help for emb.
+Clean the project.
 
 ```
 USAGE
-  $ emb help [COMMAND...] [-n]
-
-ARGUMENTS
-  COMMAND...  Command to show help for.
+  $ emb clean [--json]
 
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Display help for emb.
-```
+  Clean the project.
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
+EXAMPLES
+  $ emb clean
+```
 
-## `emb plugins`
+## `emb components`
 
-List installed plugins.
+List components.
 
 ```
 USAGE
-  $ emb plugins [--json] [--core]
+  $ emb components [--json] [--flavor <value>]
 
 FLAGS
-  --core  Show core plugins.
+  --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  List installed plugins.
+  List components.
 
 EXAMPLES
-  $ emb plugins
+  $ emb components
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/index.ts)_
-
-## `emb plugins add PLUGIN`
+## `emb components build [COMPONENT]`
 
-Installs a plugin into emb.
+Build the components of the monorepo
 
 ```
 USAGE
-  $ emb plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+  $ emb components build [COMPONENT...] [--json] [--flavor <value>]
 
 ARGUMENTS
-  PLUGIN...  Plugin to install.
+  COMPONENT...  List of components to build
 
 FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
+  --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Installs a plugin into emb.
+  Build the components of the monorepo
 
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the EMB_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the EMB_NPM_REGISTRY environment variable to set the npm registry.
+EXAMPLES
+  $ emb components build build --flavor development
+```
 
-ALIASES
-  $ emb plugins add
+## `emb config print`
 
-EXAMPLES
-  Install a plugin from npm registry.
+Print the current config.
 
-    $ emb plugins add myplugin
+```
+USAGE
+  $ emb config print [--json] [--flavor <value>]
 
-  Install a plugin from a github url.
+FLAGS
+  --flavor=<value>  Specify the flavor to use.
 
-    $ emb plugins add https://github.com/someuser/someplugin
+GLOBAL FLAGS
+  --json  Format output as json.
 
-  Install a plugin from a github slug.
+DESCRIPTION
+  Print the current config.
 
-    $ emb plugins add someuser/someplugin
+EXAMPLES
+  $ emb config print
 ```
 
-## `emb plugins:inspect PLUGIN...`
+## `emb containers`
 
-Displays installation properties of a plugin.
+List docker containers.
 
 ```
 USAGE
-  $ emb plugins inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  [default: .] Plugin to inspect.
+  $ emb containers [--json] [-a]
 
 FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  -a, --all  Retun all containers. By default, only running containers are shown
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Displays installation properties of a plugin.
+  List docker containers.
+
+ALIASES
+  $ emb ps
 
 EXAMPLES
-  $ emb plugins inspect myplugin
+  $ emb containers
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/inspect.ts)_
+## `emb containers prune`
 
-## `emb plugins install PLUGIN`
-
-Installs a plugin into emb.
+Prune containers.
 
 ```
 USAGE
-  $ emb plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
+  $ emb containers prune [--json]
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Installs a plugin into emb.
+  Prune containers.
 
-  Uses npm to install plugins.
+EXAMPLES
+  $ emb containers prune
+```
 
-  Installation of a user-installed plugin will override a core plugin.
+## `emb down`
 
-  Use the EMB_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the EMB_NPM_REGISTRY environment variable to set the npm registry.
+Stop the whole project.
 
-ALIASES
-  $ emb plugins add
+```
+USAGE
+  $ emb down [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Stop the whole project.
 
 EXAMPLES
-  Install a plugin from npm registry.
+  $ emb down
+```
 
-    $ emb plugins install myplugin
+## `emb help [COMMAND]`
 
-  Install a plugin from a github url.
+Display help for emb.
 
-    $ emb plugins install https://github.com/someuser/someplugin
+```
+USAGE
+  $ emb help [COMMAND...] [-n]
 
-  Install a plugin from a github slug.
+ARGUMENTS
+  COMMAND...  Command to show help for.
 
-    $ emb plugins install someuser/someplugin
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for emb.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
 
-## `emb plugins link PATH`
+## `emb images`
 
-Links a plugin into the CLI for development.
+List docker images.
 
 ```
 USAGE
-  $ emb plugins link PATH [-h] [--install] [-v]
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
+  $ emb images [--json] [-a]
 
 FLAGS
-  -h, --help          Show CLI help.
-  -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
+  -a, --all  Show all images. Only images from a final layer (no children) are shown by default.
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Links a plugin into the CLI for development.
+  List docker images.
 
-  Installation of a linked plugin will override a user-installed or core plugin.
+EXAMPLES
+  $ emb images
+```
 
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
+## `emb images delete`
 
+Delete project images.
 
-EXAMPLES
-  $ emb plugins link myplugin
 ```
+USAGE
+  $ emb images delete [--json] [-f]
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/link.ts)_
+FLAGS
+  -f, --force  Remove the image even if it is being used by stopped containers or has other tags
 
-## `emb plugins remove [PLUGIN]`
+GLOBAL FLAGS
+  --json  Format output as json.
 
-Removes a plugin from the CLI.
+DESCRIPTION
+  Delete project images.
 
+EXAMPLES
+  $ emb images delete
 ```
-USAGE
-  $ emb plugins remove [PLUGIN...] [-h] [-v]
 
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
+## `emb images prune`
+
+Prune project images.
+
+```
+USAGE
+  $ emb images prune [--json] [-a]
 
 FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  -a, --all  Prune all images. When set to true all images will be pruned, not only dangling ones
 
-DESCRIPTION
-  Removes a plugin from the CLI.
+GLOBAL FLAGS
+  --json  Format output as json.
 
-ALIASES
-  $ emb plugins unlink
-  $ emb plugins remove
+DESCRIPTION
+  Prune project images.
 
 EXAMPLES
-  $ emb plugins remove myplugin
+  $ emb images prune
 ```
 
-## `emb plugins reset`
+## `emb ps`
 
-Remove all user-installed and linked plugins.
+List docker containers.
 
 ```
 USAGE
-  $ emb plugins reset [--hard] [--reinstall]
+  $ emb ps [--json] [-a]
 
 FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
+  -a, --all  Retun all containers. By default, only running containers are shown
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/reset.ts)_
+GLOBAL FLAGS
+  --json  Format output as json.
 
-## `emb plugins uninstall [PLUGIN]`
+DESCRIPTION
+  List docker containers.
 
-Removes a plugin from the CLI.
+ALIASES
+  $ emb ps
+
+EXAMPLES
+  $ emb ps
+```
+
+## `emb run COMPONENT SCRIPT`
+
+Run an npm script from a component's package.json
 
 ```
 USAGE
-  $ emb plugins uninstall [PLUGIN...] [-h] [-v]
+  $ emb run COMPONENT SCRIPT
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  COMPONENT  Component name
+  SCRIPT     NPM script to run
 
 DESCRIPTION
-  Removes a plugin from the CLI.
+  Run an npm script from a component's package.json
+```
 
-ALIASES
-  $ emb plugins unlink
-  $ emb plugins remove
+## `emb tasks`
+
+List tasks.
 
-EXAMPLES
-  $ emb plugins uninstall myplugin
 ```
+USAGE
+  $ emb tasks [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/uninstall.ts)_
+DESCRIPTION
+  List tasks.
+
+EXAMPLES
+  $ emb tasks
+```
 
-## `emb plugins unlink [PLUGIN]`
+## `emb tasks run [TASK]`
 
-Removes a plugin from the CLI.
+Run a task.
 
 ```
 USAGE
-  $ emb plugins unlink [PLUGIN...] [-h] [-v]
+  $ emb tasks run [TASK...] [--json] [-x container|local]
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  TASK...  List of tasks ids to run (eg: component:task)
 
 FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  -x, --executor=<option>  <options: container|local>
 
-DESCRIPTION
-  Removes a plugin from the CLI.
+GLOBAL FLAGS
+  --json  Format output as json.
 
-ALIASES
-  $ emb plugins unlink
-  $ emb plugins remove
+DESCRIPTION
+  Run a task.
 
 EXAMPLES
-  $ emb plugins unlink myplugin
+  $ emb tasks run
 ```
 
-## `emb plugins update`
+## `emb up`
 
-Update installed plugins.
+Start the whole project.
 
 ```
 USAGE
-  $ emb plugins update [-h] [-v]
+  $ emb up [--json] [--flavor <value>] [-f]
 
 FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  -f, --force-recreate  Recreate containers even if their configuration and image haven't changed
+      --flavor=<value>  Specify the flavor to use.
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Update installed plugins.
-```
+  Start the whole project.
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/update.ts)_
+EXAMPLES
+  $ emb up
+```
 <!-- commandsstop -->

package/bin/run.js

@@ -1,5 +1,11 @@
 #!/usr/bin/env node
 
-import { execute } from '@oclif/core';
+import { execute, Performance, settings } from '@oclif/core';
 
-await execute({ dir: import.meta.url });
+settings.performanceEnabled = Boolean(process.env.EMB_DEBUG_PERFS);
+
+await execute({ dir: import.meta.url }).finally(() => {
+  if (settings.performanceEnabled) {
+    console.log(Performance.results);
+  }
+});

package/dist/src/cli/abstract/FlavouredCommand.d.ts

@@ -0,0 +1,12 @@
+import { Command, Interfaces } from '@oclif/core';
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof FlavoredCommand)['baseFlags'] & T['flags']>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class FlavoredCommand<T extends typeof Command> extends Command {
+    static baseFlags: {
+        flavor: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+    };
+    static enableJsonFlag: boolean;
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    init(): Promise<void>;
+}

package/dist/src/cli/abstract/FlavouredCommand.js

@@ -0,0 +1,40 @@
+import { getContext, setContext } from '../../index.js';
+import { Command, Flags } from '@oclif/core';
+export class FlavoredCommand extends Command {
+    // define flags that can be inherited by any command that extends FlavoredCommand
+    static baseFlags = {
+        flavor: Flags.string({
+            description: 'Specify the flavor to use.',
+            name: 'flavor',
+            required: false,
+        }),
+    };
+    // add the --json flag
+    static enableJsonFlag = true;
+    args;
+    flags;
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            args: this.ctor.args,
+            baseFlags: super.ctor.baseFlags,
+            enableJsonFlag: this.ctor.enableJsonFlag,
+            flags: this.ctor.flags,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        // Get monorepo config
+        const context = getContext();
+        // Installing flavor if relevant
+        // no validation as the monorepo will
+        // complain properly if incorrect
+        const { flavor } = this.flags;
+        if (flavor) {
+            setContext({
+                ...context,
+                monorepo: await context.monorepo.withFlavor(flavor),
+            });
+        }
+    }
+}

package/dist/src/cli/abstract/index.d.ts

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

package/dist/src/cli/abstract/index.js

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

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

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+/**
+ * For now, only cleans the stores (logs/sentinels)
+ * But this should permit to clean everytning (via flags)
+ *
+ * Eg: --containers --volumes --images --networks
+ * Or: --all
+ */
+export default class CleanCommand extends Command {
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,29 @@
+import { getContext } from '../../index.js';
+import { Command } from '@oclif/core';
+import { Listr } from 'listr2';
+/**
+ * For now, only cleans the stores (logs/sentinels)
+ * But this should permit to clean everytning (via flags)
+ *
+ * Eg: --containers --volumes --images --networks
+ * Or: --all
+ */
+export default class CleanCommand extends Command {
+    static description = 'Clean the project.';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {};
+    async run() {
+        const { monorepo } = getContext();
+        const runner = new Listr([
+            {
+                rendererOptions: { persistentOutput: true },
+                async task() {
+                    await monorepo.store.trash();
+                },
+                title: 'Cleaning project',
+            },
+        ]);
+        await runner.run();
+    }
+}

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

@@ -0,0 +1,11 @@
+import { FlavoredCommand } from '../../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 strict: boolean;
+    run(): Promise<void>;
+}