@runium/cli 0.0.1 → 0.0.3

package/src/commands/plugin/plugin-add.ts

@@ -26,7 +26,7 @@ export class PluginAddCommand extends PluginCommand {
     { file: isFile }: { file: boolean }
   ): Promise<void> {
     const pluginPath = this.pluginService.resolvePath(path, isFile);
-    const name = await this.pluginService.loadPlugin(pluginPath);
+    const name = await this.pluginService.loadPlugin(pluginPath, {});
     const plugin = this.pluginService.getPluginByName(name);
     if (plugin) {
       await this.profileService.addPlugin({
@@ -34,7 +34,7 @@ export class PluginAddCommand extends PluginCommand {
         path: isFile ? pluginPath : path,
         file: isFile,
         disabled: false,
-        options: {},
+        options: plugin.options ?? {},
       });
       this.outputService.success(`Plugin "%s" successfully added`, name);
     } else {

package/src/commands/plugin/plugin-disable.ts

@@ -12,7 +12,7 @@ export class PluginDisableCommand extends PluginCommand {
       .name('disable')
       .description('disable plugin')
       .option('-a, --all', 'disable all plugins')
-      .argument('[plugin...]', 'plugin names');
+      .argument('[name...]', 'plugin names');
   }
 
   /**

package/src/commands/plugin/plugin-enable.ts

@@ -12,7 +12,7 @@ export class PluginEnableCommand extends PluginCommand {
       .name('enable')
       .description('enable plugin')
       .option('-a, --all', 'enable all plugins')
-      .argument('[plugin...]', 'plugin names');
+      .argument('[name...]', 'plugin names');
   }
 
   /**
@@ -43,7 +43,7 @@ export class PluginEnableCommand extends PluginCommand {
         plugin.path,
         plugin.file
       );
-      await this.pluginService.loadPlugin(pluginPath);
+      await this.pluginService.loadPlugin(pluginPath, plugin.options);
       this.outputService.success(`Plugin "%s" successfully enabled`, name);
     }
   }

package/src/commands/plugin/plugin-remove.ts

@@ -12,7 +12,7 @@ export class PluginRemoveCommand extends PluginCommand {
       .name('remove')
       .description('remove plugin')
       .option('-a, --all', 'remove all plugins')
-      .argument('[plugin...]', 'plugin names');
+      .argument('[name...]', 'plugin names');
   }
 
   /**

package/src/commands/plugin/plugin.ts

@@ -9,6 +9,17 @@ import { PluginRemoveCommand } from './plugin-remove.js';
  * Plugin group command
  */
 export class PluginCommand extends RuniumCommand {
+  /**
+   * Subcommands
+   */
+  subcommands = [
+    PluginListCommand,
+    PluginAddCommand,
+    PluginRemoveCommand,
+    PluginDisableCommand,
+    PluginEnableCommand,
+  ];
+
   /**
    * Config command
    */
@@ -22,20 +33,4 @@ export class PluginCommand extends RuniumCommand {
   protected async handle(): Promise<void> {
     this.command.help();
   }
-
-  /**
-   * Add subcommands
-   */
-  protected addSubcommands(): void {
-    const constructors = [
-      PluginListCommand,
-      PluginAddCommand,
-      PluginRemoveCommand,
-      PluginDisableCommand,
-      PluginEnableCommand,
-    ];
-    for (const CommandConstructor of constructors) {
-      this.subcommands.push(new CommandConstructor(this.command));
-    }
-  }
 }

package/src/commands/project/project-add.ts

@@ -1,6 +1,7 @@
-import { RuniumError } from '@runium/core';
+import { ID_REGEX, RuniumError } from '@runium/core';
 import { ErrorCode } from '@constants';
 import { ProjectCommand } from './project-command.js';
+
 /**
  * Project add command
  */
@@ -25,15 +26,17 @@ export class ProjectAddCommand extends ProjectCommand {
     const projectPath = this.projectService.resolvePath(path);
     const project = await this.projectService.initProject(projectPath);
     if (project) {
+      const projectName = name ?? project.getConfig().id;
+
+      this.validateProjectName(projectName);
+
       await this.profileService.addProject({
-        // TODO validate name
-        // optionally save project file to profile
-        name: name ?? project.getConfig().id,
+        name: projectName,
         path: projectPath,
       });
       this.outputService.success(
         `Project "%s" successfully added`,
-        name ?? project.getConfig().id
+        projectName
       );
     } else {
       throw new RuniumError(
@@ -43,4 +46,19 @@ export class ProjectAddCommand extends ProjectCommand {
       );
     }
   }
+
+  /**
+   * Validate project name
+   * @param name - project name to validate
+   * @throws RuniumError if name contains invalid characters
+   */
+  private validateProjectName(name: string): void {
+    if (!ID_REGEX.test(name)) {
+      throw new RuniumError(
+        `Invalid project name "${name}". Only letters, digits, underscores (_), and hyphens (-) are allowed.`,
+        ErrorCode.INVALID_ARGUMENT,
+        { name }
+      );
+    }
+  }
 }

package/src/commands/project/project-command.ts

@@ -3,7 +3,12 @@ import { Container } from 'typedi';
 import { RuniumError } from '@runium/core';
 import { RuniumCommand } from '@commands/runium-command.js';
 import { ErrorCode } from '@constants';
-import { ProfileService, ProjectService, ProfileProject } from '@services';
+import {
+  ProfileService,
+  ProjectService,
+  ProfileProject,
+  FileService,
+} from '@services';
 
 /**
  * Base project command
@@ -11,11 +16,13 @@ import { ProfileService, ProjectService, ProfileProject } from '@services';
 export abstract class ProjectCommand extends RuniumCommand {
   protected projectService: ProjectService;
   protected profileService: ProfileService;
+  protected fileService: FileService;
 
   constructor(parent: Command) {
     super(parent);
     this.projectService = Container.get(ProjectService);
     this.profileService = Container.get(ProfileService);
+    this.fileService = Container.get(FileService);
   }
 
   /**

package/src/commands/project/project-start.ts

@@ -9,17 +9,15 @@ import {
   TaskState,
 } from '@runium/core';
 import { ErrorCode } from '@constants';
-import { ShutdownService } from '@services';
-import { debounce } from '@utils';
+import { AtomicWriter, ShutdownService } from '@services';
 import { ProjectData, ProjectStateCommand } from './project-state-command.js';
 
-const WRITE_PROJECT_DATA_DEBOUNCE_WAIT = 100;
-
 /**
  * Project start command
  */
 export class ProjectStartCommand extends ProjectStateCommand {
   protected shutdownService: ShutdownService;
+  protected fileWriter: AtomicWriter | null = null;
 
   constructor(parent: Command) {
     super(parent);
@@ -63,9 +61,13 @@ export class ProjectStartCommand extends ProjectStateCommand {
       : this.ensureProfileProject(name).path;
 
     const projectDataFileName = this.getProjectDataFileName(file ? path : name);
+    const projectDataFilePath = this.profileService.getPath(
+      'projects',
+      projectDataFileName
+    );
 
     // check if project is started
-    const projectData = await this.readProjectData(projectDataFileName);
+    const projectData = await this.readProjectData(projectDataFilePath);
     if (projectData && this.isProjectProcessStarted(projectData.pid)) {
       throw new RuniumError(
         `Project "${name}" is already started`,
@@ -82,14 +84,18 @@ export class ProjectStartCommand extends ProjectStateCommand {
     }
 
     const project = await this.projectService.initProject(path);
-    this.shutdownService.addBlocker(() => project.stop());
+    this.shutdownService.addBlocker((reason?: string) => project.stop(reason));
+
+    await this.fileService.ensureDirExists(dirname(projectDataFilePath));
+    this.fileWriter = this.fileService.createAtomicWriter(projectDataFilePath);
 
     this.addProjectListeners(project, {
-      dataFileName: projectDataFileName,
       projectPath: path,
       output,
     });
 
+    await this.projectService.runHook('project.beforeStart', project);
+
     await project.start();
   }
 
@@ -100,9 +106,9 @@ export class ProjectStartCommand extends ProjectStateCommand {
    */
   protected addProjectListeners(
     project: Project,
-    options: { dataFileName: string; projectPath: string; output?: boolean }
+    options: { projectPath: string; output?: boolean }
   ): void {
-    const { dataFileName, projectPath, output } = options;
+    const { projectPath, output } = options;
 
     const projectData: ProjectData = {
       id: project.getConfig().id,
@@ -115,9 +121,9 @@ export class ProjectStartCommand extends ProjectStateCommand {
       },
     };
 
-    const writeProjectData = debounce(() => {
-      this.writeProjectData(projectData, dataFileName);
-    }, WRITE_PROJECT_DATA_DEBOUNCE_WAIT);
+    const writeProjectData = () => {
+      this.fileWriter!.writeJson(projectData).then();
+    };
 
     // write initial data
     writeProjectData();

package/src/commands/project/project-state-command.ts

@@ -31,34 +31,19 @@ export abstract class ProjectStateCommand extends ProjectCommand {
 
   /**
    * Read project data
-   * @param fileName
+   * @param path
    */
-  protected async readProjectData(
-    fileName: string
-  ): Promise<ProjectData | null> {
-    return this.profileService
-      .readJsonFile('projects', fileName)
+  protected async readProjectData(path: string): Promise<ProjectData | null> {
+    return this.fileService
+      .readJson(path)
       .catch(() => null) as Promise<ProjectData | null>;
   }
 
-  /**
-   * Write project data
-   * @param data
-   * @param fileName
-   */
-  protected async writeProjectData(
-    data: ProjectData,
-    fileName: string
-  ): Promise<void> {
-    return this.profileService.writeJsonFile(data, 'projects', fileName);
-  }
-
   /**
    * Checks if a project process is started
    * @param pid
    */
   protected isProjectProcessStarted(pid: number): boolean {
-    // and process started
     try {
       return process.kill(Number(pid), 0);
     } catch (ex) {

package/src/commands/project/project-status.ts

@@ -6,6 +6,8 @@ interface StateRecord {
   status: string;
   time: string;
   timestamp: number;
+  reason?: string;
+  exitCode?: number;
 }
 
 /**
@@ -20,7 +22,7 @@ export class ProjectStatusCommand extends ProjectStateCommand {
       .name('status')
       .description('get project status')
       .option('-f, --file', 'use file path instead of project name')
-      .option('-t, --tasks', 'show task status')
+      .option('-t, --tasks', 'show tasks status')
       .option('-a, --all', 'show status change history')
       .argument('<name>', 'project name');
   }
@@ -41,8 +43,12 @@ export class ProjectStatusCommand extends ProjectStateCommand {
       : this.ensureProfileProject(name).path;
 
     const projectDataFileName = this.getProjectDataFileName(file ? path : name);
+    const projectDataFilePath = this.profileService.getPath(
+      'projects',
+      projectDataFileName
+    );
 
-    const projectData = await this.readProjectData(projectDataFileName);
+    const projectData = await this.readProjectData(projectDataFilePath);
     if (projectData) {
       let { project: projectState = [] } = projectData.state;
       if (!all) {
@@ -59,6 +65,7 @@ export class ProjectStatusCommand extends ProjectStateCommand {
             status: state.status,
             time: formatTimestamp(state.timestamp),
             timestamp: state.timestamp,
+            reason: state.reason || '',
           };
         });
 
@@ -75,6 +82,7 @@ export class ProjectStatusCommand extends ProjectStateCommand {
               status: task.status,
               time: formatTimestamp(task.timestamp),
               timestamp: task.timestamp,
+              reason: [task.reason, task.exitCode].filter(Boolean).join(' '),
             });
           });
         });
@@ -85,7 +93,12 @@ export class ProjectStatusCommand extends ProjectStateCommand {
         ];
         mappedState.sort((a, b) => a.timestamp - b.timestamp);
 
-        this.outputService.table(mappedState, ['time', 'name', 'status']);
+        this.outputService.table(mappedState, [
+          'time',
+          'name',
+          'status',
+          'reason',
+        ]);
       } else {
         const mappedState = projectState.map(state => {
           return {

package/src/commands/project/project-stop.ts

@@ -31,9 +31,13 @@ export class ProjectStopCommand extends ProjectStateCommand {
       : this.ensureProfileProject(name).path;
 
     const projectDataFileName = this.getProjectDataFileName(file ? path : name);
+    const projectDataFilePath = this.profileService.getPath(
+      'projects',
+      projectDataFileName
+    );
 
     // check if project is started
-    const projectData = await this.readProjectData(projectDataFileName);
+    const projectData = await this.readProjectData(projectDataFilePath);
     if (!projectData || !this.isProjectProcessStarted(projectData.pid)) {
       throw new RuniumError(
         `Project "${name}" is not started`,

package/src/commands/project/project-validate.ts

@@ -1,4 +1,11 @@
+import * as ajv from 'ajv';
 import { ProjectCommand } from './project-command.js';
+import { getErrorMessages } from '@validation';
+
+interface ValidationError {
+  code: string;
+  payload: { errors: ajv.ErrorObject[] };
+}
 
 /**
  * Project validate command
@@ -12,31 +19,37 @@ export class ProjectValidateCommand extends ProjectCommand {
       .name('validate')
       .description('validate project')
       .option('-f, --file', 'use file path instead of project name')
-      .argument('<project>', 'project name or file path');
+      .argument('<name>', 'project name');
   }
 
   /**
    * Handle command
-   * @param project
+   * @param name
    * @param file
    */
   protected async handle(
-    project: string,
+    name: string,
     { file }: { file: boolean }
   ): Promise<void> {
     const path = file
-      ? this.projectService.resolvePath(project)
-      : this.ensureProfileProject(project).path;
+      ? this.projectService.resolvePath(name)
+      : this.ensureProfileProject(name).path;
     const projectInstance = await this.projectService.initProject(path);
     try {
       await projectInstance.validate();
-      this.outputService.success(`Project "%s" is valid`, project);
+      this.outputService.success(`Project "%s" is valid`, name);
     } catch (error) {
-      // TODO stringify validation errors
+      const errorMessages = getErrorMessages(
+        (error as ValidationError).payload.errors,
+        {
+          filter: error => error.original?.keyword !== 'oneOf',
+        }
+      );
+
       this.outputService.error(
-        `Project "%s" validation failed`,
-        project,
-        error
+        `Project "%s" validation failed:\n\n%s`,
+        name,
+        errorMessages.join('\n')
       );
     }
   }

package/src/commands/project/project.ts

@@ -11,6 +11,19 @@ import { ProjectValidateCommand } from './project-validate.js';
  * Project group command
  */
 export class ProjectCommand extends RuniumCommand {
+  /**
+   * Subcommands
+   */
+  subcommands = [
+    ProjectListCommand,
+    ProjectAddCommand,
+    ProjectRemoveCommand,
+    ProjectStartCommand,
+    ProjectStopCommand,
+    ProjectStatusCommand,
+    ProjectValidateCommand,
+  ];
+
   /**
    * Config command
    */
@@ -24,22 +37,4 @@ export class ProjectCommand extends RuniumCommand {
   protected async handle(): Promise<void> {
     this.command.help();
   }
-
-  /**
-   * Add subcommands
-   */
-  protected addSubcommands(): void {
-    const constructors = [
-      ProjectListCommand,
-      ProjectAddCommand,
-      ProjectRemoveCommand,
-      ProjectStartCommand,
-      ProjectStopCommand,
-      ProjectStatusCommand,
-      ProjectValidateCommand,
-    ];
-    for (const CommandConstructor of constructors) {
-      this.subcommands.push(new CommandConstructor(this.command));
-    }
-  }
 }

package/src/commands/runium-command.ts

@@ -1,42 +1,44 @@
 import { Command } from 'commander';
 import { Container } from 'typedi';
-import { OutputService } from '@services';
+import { CommandService, OutputService } from '@services';
+
+export type RuniumCommandConstructor = new (program: Command) => RuniumCommand;
 
 /**
  * Base runium command
  */
 export abstract class RuniumCommand {
-  protected outputService: OutputService;
-
   /**
-   * Parent command
+   * Output service
    */
-  protected parent: Command;
+  protected outputService: OutputService;
 
   /**
    * Current command
    */
-  protected command: Command;
+  command: Command;
 
   /**
    * Subcommands
    */
-  protected subcommands: RuniumCommand[] = [];
+  subcommands: RuniumCommandConstructor[] = [];
+
+  /**
+   * Run command
+   */
+  run: (...args: unknown[]) => Promise<void>;
 
   constructor(parent: Command) {
+    const commandService = Container.get(CommandService);
+    this.run = commandService.createRunCommand(this.handle, this);
+
     this.outputService = Container.get(OutputService);
-    this.parent = parent;
     this.command = new Command();
     this.config();
-    this.command.action(this.handle.bind(this));
-    this.addSubcommands();
-    this.parent.addCommand(this.command);
-  }
+    this.command.action(this.run.bind(this));
 
-  /**
-   * Add subcommands
-   */
-  protected addSubcommands(): void {}
+    parent.addCommand(this.command);
+  }
 
   /**
    * Config command

package/src/constants/error-code.ts

@@ -1,9 +1,16 @@
 export enum ErrorCode {
+  FILE_READ_JSON_ERROR = 'file-read-json-error',
+  FILE_WRITE_JSON_ERROR = 'file-write-json-error',
+  FILE_READ_ERROR = 'file-read-error',
+  FILE_WRITE_ERROR = 'file-write-error',
+  FILE_CREATE_DIR_ERROR = 'file-create-dir-error',
   PLUGIN_NOT_FOUND = 'plugin-not-found',
   PLUGIN_FILE_NOT_FOUND = 'plugin-file-not-found',
   PLUGIN_INCORRECT_MODULE = 'plugin-incorrect-module',
-  PLUGIN_INCORRECT_PLUGIN = 'plugin-incorrect-plugin',
+  PLUGIN_INVALID = 'plugin-invalid',
   PLUGIN_PATH_RESOLVE_ERROR = 'plugin-path-resolve-error',
+  PLUGIN_LOAD_ERROR = 'plugin-load-error',
+  PLUGIN_HOOK_ERROR = 'plugin-hook-error',
   PROJECT_ALREADY_STARTED = 'project-already-started',
   PROJECT_NOT_STARTED = 'project-not-started',
   PROJECT_STOP_ERROR = 'project-stop-error',
@@ -11,5 +18,11 @@ export enum ErrorCode {
   PROJECT_FILE_NOT_FOUND = 'project-file-not-found',
   PROJECT_FILE_CAN_NOT_READ = 'project-file-can-not-read',
   PROJECT_JSON_PARSE_ERROR = 'project-json-parse-error',
-  PROFILE_JSON_WRITE_ERROR = 'profile-json-write-error',
+  INVALID_ARGUMENT = 'invalid-argument',
+  INVALID_PATH = 'invalid-path',
+  CONFIG_INVALID_DATA = 'config-invalid-data',
+  COMMAND_REGISTRATION_ERROR = 'command-registration-error',
+  COMMAND_INCORRECT = 'command-incorrect',
+  COMMAND_NOT_FOUND = 'command-not-found',
+  COMMAND_RUN_ERROR = 'command-run-error',
 }

package/src/global.d.ts

@@ -0,0 +1,6 @@
+declare global {
+  // eslint-disable-next-line
+  var runium: unknown;
+}
+
+export {};

package/src/index.ts

@@ -3,7 +3,7 @@
 import 'reflect-metadata';
 import { Container } from 'typedi';
 import { RuniumCliApp } from './app.js';
-import { OutputService } from '@services';
+import { OutputService, ShutdownService } from '@services';
 
 async function main() {
   const app = new RuniumCliApp();
@@ -17,5 +17,8 @@ main().catch(error => {
     code: error.code,
     payload: error.payload,
   });
-  process.exit(1);
+  const shutdownService = Container.get(ShutdownService);
+  shutdownService.shutdown('error').catch(() => {
+    process.exit(1);
+  });
 });

package/src/macros/date.ts

@@ -0,0 +1,15 @@
+import { formatTimestamp } from '@utils/format-timestamp.js';
+
+/**
+ * Date
+ */
+export function dateMacro(): string {
+  return formatTimestamp(Date.now());
+}
+
+/**
+ * Timestamp
+ */
+export function timestampMacro(): string {
+  return Date.now().toString();
+}

package/src/macros/index.ts

@@ -1,12 +1,17 @@
 import { eqMacro, neMacro } from './conditional.js';
+import { dateMacro, timestampMacro } from './date.js';
 import { emptyMacro } from './empty.js';
 import { envMacro } from './env.js';
-import { pathMacro } from './path.js';
+import { homeDirMacro, pathMacro, tmpDirMacro } from './path.js';
 
 export const macros = {
+  date: dateMacro,
+  homedir: homeDirMacro,
   env: envMacro,
   empty: emptyMacro,
   eq: eqMacro,
   ne: neMacro,
   path: pathMacro,
+  tmpdir: tmpDirMacro,
+  timestamp: timestampMacro,
 };

package/src/macros/path.ts

@@ -1,9 +1,24 @@
 import { resolve } from 'node:path';
+import { homedir, tmpdir } from 'node:os';
 
 /**
  * Resolve path
  * @param path
  */
-export function pathMacro(path: string): string {
-  return resolve(path);
+export function pathMacro(...path: string[]): string {
+  return resolve(...path);
+}
+
+/**
+ * Tmpdir path
+ */
+export function tmpDirMacro(): string {
+  return tmpdir();
+}
+
+/**
+ * Home directory path
+ */
+export function homeDirMacro(): string {
+  return homedir();
 }