@runium/cli 0.0.1 → 0.0.2

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

@@ -1,43 +0,0 @@
-import { ProjectCommand } from './project-command.js';
-
-/**
- * Project validate command
- */
-export class ProjectValidateCommand extends ProjectCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command
-      .name('validate')
-      .description('validate project')
-      .option('-f, --file', 'use file path instead of project name')
-      .argument('<project>', 'project name or file path');
-  }
-
-  /**
-   * Handle command
-   * @param project
-   * @param file
-   */
-  protected async handle(
-    project: string,
-    { file }: { file: boolean }
-  ): Promise<void> {
-    const path = file
-      ? this.projectService.resolvePath(project)
-      : this.ensureProfileProject(project).path;
-    const projectInstance = await this.projectService.initProject(path);
-    try {
-      await projectInstance.validate();
-      this.outputService.success(`Project "%s" is valid`, project);
-    } catch (error) {
-      // TODO stringify validation errors
-      this.outputService.error(
-        `Project "%s" validation failed`,
-        project,
-        error
-      );
-    }
-  }
-}

package/src/commands/project/project.ts

@@ -1,45 +0,0 @@
-import { RuniumCommand } from '@commands/runium-command.js';
-import { ProjectAddCommand } from './project-add.js';
-import { ProjectListCommand } from './project-list.js';
-import { ProjectRemoveCommand } from './project-remove.js';
-import { ProjectStartCommand } from './project-start.js';
-import { ProjectStopCommand } from './project-stop.js';
-import { ProjectStatusCommand } from './project-status.js';
-import { ProjectValidateCommand } from './project-validate.js';
-
-/**
- * Project group command
- */
-export class ProjectCommand extends RuniumCommand {
-  /**
-   * Config command
-   */
-  protected config(): void {
-    this.command.name('project').description('manage projects');
-  }
-
-  /**
-   * Handle command
-   */
-  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,50 +0,0 @@
-import { Command } from 'commander';
-import { Container } from 'typedi';
-import { OutputService } from '@services';
-
-/**
- * Base runium command
- */
-export abstract class RuniumCommand {
-  protected outputService: OutputService;
-
-  /**
-   * Parent command
-   */
-  protected parent: Command;
-
-  /**
-   * Current command
-   */
-  protected command: Command;
-
-  /**
-   * Subcommands
-   */
-  protected subcommands: RuniumCommand[] = [];
-
-  constructor(parent: Command) {
-    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);
-  }
-
-  /**
-   * Add subcommands
-   */
-  protected addSubcommands(): void {}
-
-  /**
-   * Config command
-   */
-  protected abstract config(): void;
-
-  /**
-   * Handle command
-   */
-  protected abstract handle(...args: unknown[]): Promise<void>;
-}

package/src/constants/error-code.ts

@@ -1,15 +0,0 @@
-export enum ErrorCode {
-  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_PATH_RESOLVE_ERROR = 'plugin-path-resolve-error',
-  PROJECT_ALREADY_STARTED = 'project-already-started',
-  PROJECT_NOT_STARTED = 'project-not-started',
-  PROJECT_STOP_ERROR = 'project-stop-error',
-  PROJECT_NOT_FOUND = 'project-not-found',
-  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',
-}

package/src/constants/index.ts

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

package/src/index.ts

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-
-import 'reflect-metadata';
-import { Container } from 'typedi';
-import { RuniumCliApp } from './app.js';
-import { OutputService } from '@services';
-
-async function main() {
-  const app = new RuniumCliApp();
-  await app.start();
-}
-
-main().catch(error => {
-  const outputService = Container.get(OutputService);
-  outputService.error('Error: %s', error.message);
-  outputService.debug('Error details:', {
-    code: error.code,
-    payload: error.payload,
-  });
-  process.exit(1);
-});

package/src/macros/conditional.ts

@@ -1,31 +0,0 @@
-/**
- * Equal
- * @param value1
- * @param value2
- * @param trueValue
- * @param falseValue
- */
-export function eqMacro(
-  value1: string,
-  value2: string,
-  trueValue?: string,
-  falseValue?: string
-): string {
-  return value1 === value2 ? (trueValue ?? '') : (falseValue ?? '');
-}
-
-/**
- * Not equal
- * @param value1
- * @param value2
- * @param trueValue
- * @param falseValue
- */
-export function neMacro(
-  value1: string,
-  value2: string,
-  trueValue?: string,
-  falseValue?: string
-): string {
-  return value1 !== value2 ? (trueValue ?? '') : (falseValue ?? '');
-}

package/src/macros/empty.ts

@@ -1,6 +0,0 @@
-/**
- * Empty string
- */
-export function emptyMacro(): string {
-  return '';
-}

package/src/macros/env.ts

@@ -1,8 +0,0 @@
-/**
- * Get environment variable
- * @param name
- * @param defaultValue
- */
-export function envMacro(name: string, defaultValue?: string): string {
-  return process.env[name] ?? defaultValue ?? '';
-}

package/src/macros/index.ts

@@ -1,12 +0,0 @@
-import { eqMacro, neMacro } from './conditional.js';
-import { emptyMacro } from './empty.js';
-import { envMacro } from './env.js';
-import { pathMacro } from './path.js';
-
-export const macros = {
-  env: envMacro,
-  empty: emptyMacro,
-  eq: eqMacro,
-  ne: neMacro,
-  path: pathMacro,
-};

package/src/macros/path.ts

@@ -1,9 +0,0 @@
-import { resolve } from 'node:path';
-
-/**
- * Resolve path
- * @param path
- */
-export function pathMacro(path: string): string {
-  return resolve(path);
-}

package/src/services/config.ts

@@ -1,76 +0,0 @@
-import { existsSync } from 'node:fs';
-import { homedir } from 'node:os';
-import { join, resolve } from 'node:path';
-import { Service } from 'typedi';
-import { readJsonFile } from '@runium/core';
-
-interface ConfigEnv {
-  path: string[];
-}
-
-interface ConfigOutput {
-  debug: boolean;
-}
-
-interface ConfigProfile {
-  path: string;
-}
-
-interface ConfigData {
-  env: ConfigEnv;
-  output: ConfigOutput;
-  profile: ConfigProfile;
-}
-
-const CONFIG_FILE_NAME = '.runiumrc.json';
-const CONFIG_FILE_PATH = join(process.cwd(), CONFIG_FILE_NAME);
-const PROFILE_DIR_NAME = '.runium';
-const HOME_PROFILE_PATH = join(homedir(), PROFILE_DIR_NAME);
-const CWD_PROFILE_PATH = join(process.cwd(), PROFILE_DIR_NAME);
-
-@Service()
-export class ConfigService {
-  private data: ConfigData = {
-    profile: { path: HOME_PROFILE_PATH },
-    output: { debug: false },
-    env: { path: [] },
-  };
-
-  /**
-   * Initialize the config service
-   */
-  async init(): Promise<void> {
-    if (existsSync(CWD_PROFILE_PATH)) {
-      this.data.profile.path = CWD_PROFILE_PATH;
-    }
-
-    if (existsSync(CONFIG_FILE_PATH)) {
-      // TODO validate config file
-      const configData: ConfigData =
-        await readJsonFile<ConfigData>(CONFIG_FILE_PATH);
-      if (configData) {
-        const data = {
-          env: Object.assign({}, this.data.env, configData.env ?? {}),
-          output: Object.assign({}, this.data.output, configData.output ?? {}),
-          profile: Object.assign(
-            {},
-            this.data.profile,
-            configData.profile ?? {}
-          ),
-        };
-
-        data.env.path = data.env.path.map(envPath => resolve(envPath));
-        data.profile.path = resolve(data.profile.path);
-        this.data = data;
-      }
-    }
-  }
-
-  /**
-   * Get a configuration value
-   * @param key
-   */
-  get<T extends keyof ConfigData>(key: T): ConfigData[T] {
-    return this.data[key];
-  }
-}

package/src/services/index.ts

@@ -1,7 +0,0 @@
-export * from './config.js';
-export * from './output.js';
-export * from './profile.js';
-export * from './plugin.js';
-export * from './project.js';
-export * from './shutdown.js';
-export * from './plugin-context.js';

package/src/services/output.ts

@@ -1,201 +0,0 @@
-import { Console } from 'node:console';
-import { Transform } from 'node:stream';
-
-import { Service } from 'typedi';
-
-export enum OutputLevel {
-  TRACE = 0,
-  DEBUG = 1,
-  INFO = 2,
-  WARN = 3,
-  ERROR = 4,
-  SILENT = 5,
-}
-
-/**
- * Console dumper
- * wrapper around node console with a transform stream
- */
-class ConsoleDumper extends Console {
-  private readonly transform: Transform;
-
-  constructor() {
-    const transform = new Transform({
-      transform: (chunk, _, cb) => cb(null, chunk),
-    });
-    super({
-      stdout: transform,
-      stderr: transform,
-      colorMode: false,
-    });
-    this.transform = transform;
-  }
-
-  /**
-   * Get a table output with index column removed
-   * @param data
-   * @param columns
-   */
-  getPatchedTable(data: unknown[], columns?: string[]): string {
-    this.table(data, columns);
-
-    const original = (this.transform.read() || '').toString();
-
-    // Tables should all start with roughly:
-    // ┌─────────┬──────
-    // │ (index) │
-    // ├─────────┼
-    const columnWidth = original.indexOf('┬') + 1;
-
-    return original
-      .split('\n')
-      .map((line: string) => line.charAt(0) + line.slice(columnWidth))
-      .join('\n');
-  }
-}
-
-const dumper = new ConsoleDumper();
-
-@Service()
-export class OutputService {
-  private outputLevel: OutputLevel = OutputLevel.INFO;
-
-  /**
-   * Set output level
-   * @param level
-   */
-  setLevel(level: OutputLevel): void {
-    this.outputLevel = level;
-  }
-
-  /**
-   * Get output level
-   */
-  getLevel(): OutputLevel {
-    return this.outputLevel;
-  }
-
-  /**
-   * Log a trace message
-   * @param message
-   * @param args
-   */
-  trace(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.TRACE) {
-      // eslint-disable-next-line no-console
-      console.log(message, ...args);
-    }
-  }
-
-  /**
-   * Log a debug message
-   * @param message
-   * @param args
-   */
-  debug(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.DEBUG) {
-      // eslint-disable-next-line no-console
-      console.log(message, ...args);
-    }
-  }
-
-  /**
-   * Log an info message
-   * @param message
-   * @param args
-   */
-  info(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.INFO) {
-      // eslint-disable-next-line no-console
-      console.log(message, ...args);
-    }
-  }
-
-  /**
-   * Log a success message
-   * @param message
-   * @param args
-   */
-  success(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.INFO) {
-      // eslint-disable-next-line no-console
-      console.log(message, ...args);
-    }
-  }
-
-  /**
-   * Log a warning message
-   * @param message
-   * @param args
-   */
-  warn(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.WARN) {
-      // eslint-disable-next-line no-console
-      console.warn(message, ...args);
-    }
-  }
-
-  /**
-   * Log an error message
-   * @param message
-   * @param args
-   */
-  error(message: string, ...args: unknown[]): void {
-    if (this.outputLevel <= OutputLevel.ERROR) {
-      // eslint-disable-next-line no-console
-      console.error(message, ...args);
-    }
-  }
-
-  /**
-   * Log a message without level
-   * @param message
-   * @param args
-   */
-  log(message: string, ...args: unknown[]): void {
-    if (this.outputLevel < OutputLevel.SILENT) {
-      // eslint-disable-next-line no-console
-      console.log(message, ...args);
-    }
-  }
-
-  /**
-   * Output a table
-   * @param data
-   * @param columns
-   */
-  table(data: unknown[], columns?: string[]): void {
-    if (this.outputLevel < OutputLevel.SILENT) {
-      const patchedData = data.map((item, index) => ({
-        ...(item as object),
-        '#': index + 1,
-      }));
-      const patchedOutput = dumper.getPatchedTable(
-        patchedData,
-        columns ? ['#', ...columns] : undefined
-      );
-      // eslint-disable-next-line no-console
-      console.log(patchedOutput);
-    }
-  }
-
-  /**
-   * Output a blank line
-   */
-  newLine(): void {
-    if (this.outputLevel < OutputLevel.SILENT) {
-      // eslint-disable-next-line no-console
-      console.log('');
-    }
-  }
-
-  /**
-   * Clear output
-   */
-  clear(): void {
-    if (this.outputLevel < OutputLevel.SILENT) {
-      // eslint-disable-next-line no-console
-      console.clear();
-    }
-  }
-}

package/src/services/plugin-context.ts

@@ -1,81 +0,0 @@
-import { Inject, Service } from 'typedi';
-
-import {
-  RuniumError,
-  isRuniumError,
-  RuniumTask,
-  RuniumTrigger,
-  readJsonFile,
-  writeJsonFile,
-  applyMacros,
-  TaskStatus,
-  ProjectEvent,
-  ProjectStatus,
-} from '@runium/core';
-import { RuniumCommand } from '@commands/runium-command.js';
-import { OutputLevel, OutputService, ShutdownService } from '@services';
-
-// @ts-expect-error global object access
-global.runium = null;
-
-@Service()
-export class PluginContextService {
-  constructor(
-    @Inject() private outputService: OutputService,
-    @Inject() private shutdownService: ShutdownService
-  ) {}
-
-  /**
-   * Initialize the plugin context service
-   */
-  async init(): Promise<void> {
-    const output = this.outputService;
-    const shutdown = this.shutdownService;
-
-    const runium = {
-      class: {
-        RuniumCommand,
-        RuniumError,
-        RuniumTask,
-        RuniumTrigger,
-      },
-      enum: {
-        OutputLevel: Object.keys(OutputLevel)
-          .filter(key => isNaN(Number(key)))
-          .reduce(
-            (acc, key) => {
-              acc[key] = OutputLevel[key as keyof typeof OutputLevel];
-              return acc;
-            },
-            {} as Record<string, number>
-          ),
-        ProjectEvent,
-        ProjectStatus,
-        TaskStatus,
-      },
-      utils: {
-        applyMacros,
-        isRuniumError,
-        readJsonFile,
-        writeJsonFile,
-      },
-      output: {
-        getLevel: output.getLevel.bind(output),
-        setLevel: output.setLevel.bind(output),
-        trace: output.trace.bind(output),
-        debug: output.debug.bind(output),
-        info: output.info.bind(output),
-        warn: output.warn.bind(output),
-        error: output.error.bind(output),
-        table: output.table.bind(output),
-        log: output.log.bind(output),
-      },
-      shutdown: {
-        addBlocker: shutdown.addBlocker.bind(shutdown),
-        removeBlocker: shutdown.removeBlocker.bind(shutdown),
-      },
-    };
-    // @ts-expect-error global object access
-    global.runium = Object.freeze(runium);
-  }
-}