@runium/cli 0.0.1 → 0.0.2

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

@@ -1,61 +0,0 @@
-import { Option } from 'commander';
-import { PluginCommand } from './plugin-command.js';
-
-/**
- * Plugin list command
- */
-export class PluginListCommand extends PluginCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('list')
-      .addOption(
-        new Option('-d, --disabled', 'show only disabled plugins').conflicts(
-          'enabled'
-        )
-      )
-      .addOption(
-        new Option('-e, --enabled', 'show only enabled plugins').conflicts(
-          'disabled'
-        )
-      )
-      .option('-s, --sort', 'sort by name')
-      .description('list plugins');
-  }
-
-  /**
-   * Handle command
-   */
-  protected async handle({
-    disabled,
-    enabled,
-    sort,
-  }: {
-    disabled: boolean;
-    enabled: boolean;
-    sort: boolean;
-  }): Promise<void> {
-    let plugins = this.profileService.getPlugins();
-    if (disabled) {
-      plugins = plugins.filter(p => p.disabled === true);
-    }
-    if (enabled) {
-      plugins = plugins.filter(p => p.disabled === false);
-    }
-    if (sort) {
-      plugins.sort((a, b) => a.name.localeCompare(b.name));
-    }
-
-    if (plugins.length !== 0) {
-      this.outputService.table(plugins, [
-        'name',
-        'path',
-        ...(disabled || enabled ? [] : ['disabled']),
-      ]);
-    } else {
-      this.outputService.warn('No plugins found');
-    }
-  }
-}

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

@@ -1,42 +0,0 @@
-import { PluginCommand } from './plugin-command.js';
-
-/**
- * Plugin remove command
- */
-export class PluginRemoveCommand extends PluginCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('remove')
-      .description('remove plugin')
-      .option('-a, --all', 'remove all plugins')
-      .argument('[plugin...]', 'plugin names');
-  }
-
-  /**
-   * Handle command
-   * @param names
-   * @param all
-   */
-  protected async handle(
-    names: string[],
-    { all }: { all: boolean }
-  ): Promise<void> {
-    if (names.length === 0 && !all) {
-      this.outputService.warn('No plugins specified to remove');
-      return;
-    }
-    if (all) {
-      names = this.profileService.getPlugins().map(p => p.name);
-    }
-
-    for (const name of names) {
-      this.ensureProfilePlugin(name);
-      await this.profileService.removePlugin(name);
-      await this.pluginService.unloadPlugin(name);
-      this.outputService.success(`Plugin "%s" successfully removed`, name);
-    }
-  }
-}

package/src/commands/plugin/plugin.ts

@@ -1,41 +0,0 @@
-import { RuniumCommand } from '@commands/runium-command.js';
-import { PluginAddCommand } from './plugin-add.js';
-import { PluginDisableCommand } from './plugin-disable.js';
-import { PluginEnableCommand } from './plugin-enable.js';
-import { PluginListCommand } from './plugin-list.js';
-import { PluginRemoveCommand } from './plugin-remove.js';
-
-/**
- * Plugin group command
- */
-export class PluginCommand extends RuniumCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command.name('plugin').description('manage plugins');
-  }
-
-  /**
-   * Handle command
-   */
-  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,46 +0,0 @@
-import { RuniumError } from '@runium/core';
-import { ErrorCode } from '@constants';
-import { ProjectCommand } from './project-command.js';
-/**
- * Project add command
- */
-export class ProjectAddCommand extends ProjectCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('add')
-      .description('add project')
-      .argument('<path>', 'project file path')
-      .argument('[name]', 'project name (default: project config id)');
-  }
-
-  /**
-   * Handle command
-   * @param path
-   * @param name
-   */
-  protected async handle(path: string, name?: string): Promise<void> {
-    const projectPath = this.projectService.resolvePath(path);
-    const project = await this.projectService.initProject(projectPath);
-    if (project) {
-      await this.profileService.addProject({
-        // TODO validate name
-        // optionally save project file to profile
-        name: name ?? project.getConfig().id,
-        path: projectPath,
-      });
-      this.outputService.success(
-        `Project "%s" successfully added`,
-        name ?? project.getConfig().id
-      );
-    } else {
-      throw new RuniumError(
-        `Failed to add project "${projectPath}"`,
-        ErrorCode.PROJECT_NOT_FOUND,
-        { path: projectPath }
-      );
-    }
-  }
-}

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

@@ -1,36 +0,0 @@
-import { Command } from 'commander';
-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';
-
-/**
- * Base project command
- */
-export abstract class ProjectCommand extends RuniumCommand {
-  protected projectService: ProjectService;
-  protected profileService: ProfileService;
-
-  constructor(parent: Command) {
-    super(parent);
-    this.projectService = Container.get(ProjectService);
-    this.profileService = Container.get(ProfileService);
-  }
-
-  /**
-   * Ensure project exists
-   * @param name
-   */
-  protected ensureProfileProject(name: string): ProfileProject {
-    const project = this.profileService.getProjectByName(name);
-    if (!project) {
-      throw new RuniumError(
-        `Project "${name}" not found`,
-        ErrorCode.PROJECT_NOT_FOUND,
-        { name }
-      );
-    }
-    return project;
-  }
-}

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

@@ -1,32 +0,0 @@
-import { ProjectCommand } from './project-command.js';
-
-/**
- * Project list command
- */
-export class ProjectListCommand extends ProjectCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('list')
-      .description('list projects')
-      .option('-s, --sort', 'sort by name');
-  }
-
-  /**
-   * Handle command
-   */
-  protected async handle({ sort }: { sort: boolean }): Promise<void> {
-    const projects = this.profileService.getProjects();
-    if (sort) {
-      projects.sort((a, b) => a.name.localeCompare(b.name));
-    }
-    // handle empty list
-    if (projects.length !== 0) {
-      this.outputService.table(projects, ['name', 'path']);
-    } else {
-      this.outputService.warn('No projects found');
-    }
-  }
-}

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

@@ -1,41 +0,0 @@
-import { ProjectCommand } from './project-command.js';
-
-/**
- * Project remove command
- */
-export class ProjectRemoveCommand extends ProjectCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('remove')
-      .description('remove project')
-      .option('-a, --all', 'remove all projects')
-      .argument('[name...]', 'project names');
-  }
-
-  /**
-   * Handle command
-   * @param names
-   * @param all
-   */
-  protected async handle(
-    names: string[],
-    { all }: { all: boolean }
-  ): Promise<void> {
-    if (names.length === 0 && !all) {
-      this.outputService.warn('No projects specified to remove');
-      return;
-    }
-    if (all) {
-      names = this.profileService.getProjects().map(p => p.name);
-    }
-
-    for (const name of names) {
-      this.ensureProfileProject(name);
-      await this.profileService.removeProject(name);
-      this.outputService.success(`Project "%s" successfully removed`, name);
-    }
-  }
-}

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

@@ -1,152 +0,0 @@
-import { dirname } from 'node:path';
-import { Command, Option } from 'commander';
-import { Container } from 'typedi';
-import {
-  Project,
-  ProjectEvent,
-  ProjectState,
-  RuniumError,
-  TaskState,
-} from '@runium/core';
-import { ErrorCode } from '@constants';
-import { ShutdownService } from '@services';
-import { debounce } from '@utils';
-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;
-
-  constructor(parent: Command) {
-    super(parent);
-    this.shutdownService = Container.get(ShutdownService);
-  }
-
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('start')
-      .description('start project')
-      .option('-f, --file', 'use file path instead of project name')
-      .option('-o, --output', 'output project state changes')
-      .addOption(
-        new Option('-w, --working-dir <choice>', 'set working directory')
-          .choices(['cwd', 'project'])
-          .default('cwd')
-      )
-      .argument('<name>', 'project name');
-  }
-
-  /**
-   * Handle command
-   * @param name
-   * @param file
-   * @param workingDir
-   * @param output
-   */
-  protected async handle(
-    name: string,
-    {
-      file,
-      workingDir,
-      output,
-    }: { file: boolean; workingDir?: string; output?: boolean }
-  ): Promise<void> {
-    const path = file
-      ? this.projectService.resolvePath(name)
-      : this.ensureProfileProject(name).path;
-
-    const projectDataFileName = this.getProjectDataFileName(file ? path : name);
-
-    // check if project is started
-    const projectData = await this.readProjectData(projectDataFileName);
-    if (projectData && this.isProjectProcessStarted(projectData.pid)) {
-      throw new RuniumError(
-        `Project "${name}" is already started`,
-        ErrorCode.PROJECT_ALREADY_STARTED,
-        { name }
-      );
-    }
-
-    if (workingDir === 'project') {
-      const projectDir = dirname(path);
-      if (projectDir !== process.cwd()) {
-        process.chdir(projectDir);
-      }
-    }
-
-    const project = await this.projectService.initProject(path);
-    this.shutdownService.addBlocker(() => project.stop());
-
-    this.addProjectListeners(project, {
-      dataFileName: projectDataFileName,
-      projectPath: path,
-      output,
-    });
-
-    await project.start();
-  }
-
-  /**
-   * Add project listeners
-   * @param project
-   * @param options
-   */
-  protected addProjectListeners(
-    project: Project,
-    options: { dataFileName: string; projectPath: string; output?: boolean }
-  ): void {
-    const { dataFileName, projectPath, output } = options;
-
-    const projectData: ProjectData = {
-      id: project.getConfig().id,
-      pid: process.pid,
-      cwd: process.cwd(),
-      path: projectPath,
-      state: {
-        project: [],
-        tasks: {},
-      },
-    };
-
-    const writeProjectData = debounce(() => {
-      this.writeProjectData(projectData, dataFileName);
-    }, WRITE_PROJECT_DATA_DEBOUNCE_WAIT);
-
-    // write initial data
-    writeProjectData();
-
-    project.on(ProjectEvent.STATE_CHANGE, async (state: ProjectState) => {
-      projectData.state.project.push(state);
-      writeProjectData();
-      if (output) {
-        this.outputService.info('Project %s', state.status);
-      }
-    });
-
-    project.on(
-      ProjectEvent.TASK_STATE_CHANGE,
-      (taskId: string, state: TaskState) => {
-        if (!projectData.state.tasks[taskId]) {
-          projectData.state.tasks[taskId] = [];
-        }
-        projectData.state.tasks[taskId].push(state);
-        writeProjectData();
-        if (output) {
-          this.outputService.info(
-            'Task %s %s %s',
-            taskId,
-            state.status,
-            state.exitCode || state.error || ''
-          );
-        }
-      }
-    );
-  }
-}

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

@@ -1,68 +0,0 @@
-import { convertPathToValidFileName } from '@utils';
-import { ProjectCommand } from './project-command.js';
-import { ProjectState, TaskState } from '@runium/core';
-
-export interface ProjectData {
-  id: string;
-  pid: number;
-  cwd: string;
-  path: string;
-  state: {
-    project: ProjectState[];
-    tasks: Record<string, TaskState[]>;
-  };
-}
-
-/**
- * Base project state command
- */
-export abstract class ProjectStateCommand extends ProjectCommand {
-  /**
-   * Get project data file name
-   * @param name
-   */
-  protected getProjectDataFileName(name: string): string {
-    let fileName = convertPathToValidFileName(name);
-    if (!fileName.endsWith('.json')) {
-      fileName = fileName + '.json';
-    }
-    return fileName;
-  }
-
-  /**
-   * Read project data
-   * @param fileName
-   */
-  protected async readProjectData(
-    fileName: string
-  ): Promise<ProjectData | null> {
-    return this.profileService
-      .readJsonFile('projects', fileName)
-      .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) {
-      return (ex as { code?: string }).code === 'EPERM';
-    }
-  }
-}

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

@@ -1,103 +0,0 @@
-import { formatTimestamp } from '@utils';
-import { ProjectStateCommand } from './project-state-command.js';
-
-interface StateRecord {
-  name: string;
-  status: string;
-  time: string;
-  timestamp: number;
-}
-
-/**
- * Project status command
- */
-export class ProjectStatusCommand extends ProjectStateCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('status')
-      .description('get project status')
-      .option('-f, --file', 'use file path instead of project name')
-      .option('-t, --tasks', 'show task status')
-      .option('-a, --all', 'show status change history')
-      .argument('<name>', 'project name');
-  }
-
-  /**
-   * Handle command
-   * @param name
-   * @param file
-   * @param tasks
-   * @param all
-   */
-  protected async handle(
-    name: string,
-    { file, tasks, all }: { file: boolean; tasks: boolean; all: boolean }
-  ): Promise<void> {
-    const path = file
-      ? this.projectService.resolvePath(name)
-      : this.ensureProfileProject(name).path;
-
-    const projectDataFileName = this.getProjectDataFileName(file ? path : name);
-
-    const projectData = await this.readProjectData(projectDataFileName);
-    if (projectData) {
-      let { project: projectState = [] } = projectData.state;
-      if (!all) {
-        projectState =
-          projectState.length > 0
-            ? [projectState[projectState.length - 1]]
-            : [];
-      }
-
-      if (tasks) {
-        const projectMappedState = projectState.map(state => {
-          return {
-            name: 'Project',
-            status: state.status,
-            time: formatTimestamp(state.timestamp),
-            timestamp: state.timestamp,
-          };
-        });
-
-        const { tasks: tasksState = [] } = projectData.state;
-
-        const tasksMappedState: StateRecord[] = [];
-        Object.entries(tasksState).forEach(([key, value]) => {
-          if (!all) {
-            value = value.length > 0 ? [value[value.length - 1]] : [];
-          }
-          value.forEach(task => {
-            tasksMappedState.push({
-              name: key,
-              status: task.status,
-              time: formatTimestamp(task.timestamp),
-              timestamp: task.timestamp,
-            });
-          });
-        });
-
-        const mappedState: StateRecord[] = [
-          ...projectMappedState,
-          ...tasksMappedState,
-        ];
-        mappedState.sort((a, b) => a.timestamp - b.timestamp);
-
-        this.outputService.table(mappedState, ['time', 'name', 'status']);
-      } else {
-        const mappedState = projectState.map(state => {
-          return {
-            status: state.status,
-            time: formatTimestamp(state.timestamp),
-          };
-        });
-
-        this.outputService.table(mappedState, ['time', 'status']);
-      }
-    } else {
-      this.outputService.info(`No project status for "${name}"`);
-    }
-  }
-}

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

@@ -1,55 +0,0 @@
-import { RuniumError } from '@runium/core';
-import { ErrorCode } from '@constants';
-import { ProjectStateCommand } from './project-state-command.js';
-
-/**
- * Project stop command
- */
-export class ProjectStopCommand extends ProjectStateCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('stop')
-      .description('stop project')
-      .option('-f, --file', 'use file path instead of project name')
-      .argument('<name>', 'project name');
-  }
-
-  /**
-   * Handle command
-   * @param name
-   * @param file
-   */
-  protected async handle(
-    name: string,
-    { file }: { file: boolean }
-  ): Promise<void> {
-    const path = file
-      ? this.projectService.resolvePath(name)
-      : this.ensureProfileProject(name).path;
-
-    const projectDataFileName = this.getProjectDataFileName(file ? path : name);
-
-    // check if project is started
-    const projectData = await this.readProjectData(projectDataFileName);
-    if (!projectData || !this.isProjectProcessStarted(projectData.pid)) {
-      throw new RuniumError(
-        `Project "${name}" is not started`,
-        ErrorCode.PROJECT_NOT_STARTED,
-        { name }
-      );
-    }
-
-    try {
-      process.kill(projectData.pid, 'SIGTERM');
-    } catch (ex) {
-      throw new RuniumError(
-        `Failed to stop project "${name}"`,
-        ErrorCode.PROJECT_STOP_ERROR,
-        { name, original: ex }
-      );
-    }
-  }
-}