@poetora/cli 0.1.8 → 0.1.10

package/src/commands/base.command.ts

@@ -1,97 +0,0 @@
-import { CliError } from '../errors/index.js';
-import type { ILogger } from '../utils/index.js';
-
-/**
- * Base abstract class for all CLI commands
- * Implements Template Method pattern for consistent command execution flow
- */
-export abstract class BaseCommand<TOptions = unknown, TResult = void> {
-  /**
-   * Command name (e.g., 'dev', 'init', 'check')
-   */
-  abstract readonly name: string;
-
-  /**
-   * Command description for help text
-   */
-  abstract readonly description: string;
-
-  constructor(
-    protected readonly logger: ILogger,
-    protected readonly packageName: string = 'poet'
-  ) {}
-
-  /**
-   * Template method that orchestrates command execution
-   * This is the main entry point called by the CLI framework
-   */
-  /* prettier-ignore */
-  async run(options: TOptions): Promise<TResult> {
-    try {
-      // 1. Validate input options
-      await this.validate(options);
-
-      // 2. Execute command logic
-      const result = await this.execute(options);
-
-      // 3. Return result
-      return result;
-    } catch (error) {
-      // 4. Handle errors consistently
-      this.handleError(error);
-      throw error;
-    }
-  }
-
-  /**
-   * Validate command options before execution
-   * Override this method to add custom validation logic
-   * @param options - Command options to validate
-   * @throws {ValidationError} if validation fails
-   */
-  // prettier-ignore
-  protected async validate(_options: TOptions): Promise<void> {
-    // Default: no validation
-    // Subclasses can override to add validation
-  }
-
-  /**
-   * Execute the main command logic
-   * This method must be implemented by all command subclasses
-   * @param options - Validated command options
-   * @returns Command execution result
-   */
-  protected abstract execute(options: TOptions): Promise<TResult>;
-
-  /**
-   * Handle errors that occur during command execution
-   * Can be overridden to provide custom error handling
-   * @param error - The error to handle
-   */
-  protected handleError(error: unknown): void {
-    if (error instanceof CliError) {
-      // CLI-specific errors with user-friendly messages
-      this.logger.error(error.message);
-    } else if (error instanceof Error) {
-      // Generic errors
-      this.logger.error(error.message);
-
-      // In debug mode, show stack trace
-      if (process.env.DEBUG === 'true') {
-        this.logger.logColor(error.stack ?? '', 'gray');
-      }
-    } else {
-      // Unknown error types
-      this.logger.error('An unexpected error occurred');
-      this.logger.logColor(String(error), 'gray');
-    }
-  }
-
-  /**
-   * Exit the process with given code
-   * Separated for easier testing (can be mocked)
-   */
-  protected exit(code: number): never {
-    process.exit(code);
-  }
-}

package/src/commands/check.command.ts

@@ -1,40 +0,0 @@
-import type { AccessibilityCheckService, OpenApiCheckService } from '../services/index.js';
-import type { OpenApiCheckOptions } from '../types/index.js';
-import type { ILogger } from '../utils/index.js';
-import { BaseCommand } from './base.command.js';
-
-/**
- * Check command - Validate OpenAPI specs and accessibility
- */
-export class CheckCommand extends BaseCommand {
-  readonly name = 'check';
-  readonly description = 'check OpenAPI specs or accessibility';
-
-  constructor(
-    logger: ILogger,
-    private readonly openApiCheckService: OpenApiCheckService,
-    private readonly accessibilityCheckService: AccessibilityCheckService,
-    packageName: string = 'poet'
-  ) {
-    super(logger, packageName);
-  }
-
-  /**
-   * Execute OpenAPI check
-   */
-  async checkOpenApi(options: OpenApiCheckOptions): Promise<void> {
-    await this.openApiCheckService.validateSpec(options.filename, options.localSchema);
-  }
-
-  /**
-   * Execute accessibility check
-   */
-  async checkAccessibility(): Promise<number> {
-    return await this.accessibilityCheckService.checkAccessibility();
-  }
-
-  protected override async execute(options: OpenApiCheckOptions): Promise<void> {
-    // This is for openapi-check command
-    await this.openApiCheckService.validateSpec(options.filename, options.localSchema);
-  }
-}

package/src/commands/dev.command.ts

@@ -1,63 +0,0 @@
-import { dev } from '@poetora/previewing';
-import type { ArgumentsCamelCase } from 'yargs';
-import { InvalidEnvironmentError } from '../errors/index.js';
-import type { PortService, VersionService } from '../services/index.js';
-import type { DevOptions } from '../types/index.js';
-import type { ILogger } from '../utils/index.js';
-import { BaseCommand } from './base.command.js';
-
-/**
- * Dev command - Start local development server
- */
-export class DevCommand extends BaseCommand {
-  readonly name = 'dev';
-  readonly description = 'initialize a local preview environment';
-
-  constructor(
-    logger: ILogger,
-    private readonly versionService: VersionService,
-    private readonly portService: PortService,
-    packageName: string = 'poet'
-  ) {
-    super(logger, packageName);
-  }
-
-  protected override async validate(_options: DevOptions): Promise<void> {
-    // Check Node.js version
-    const versionResult = this.versionService.checkNodeVersion();
-
-    if (!versionResult.isValid) {
-      throw new InvalidEnvironmentError(versionResult.message ?? 'Unsupported Node.js version');
-    }
-
-    // Show warning if below recommended version
-    if (versionResult.hasWarning && versionResult.message) {
-      this.logger.warn(versionResult.message);
-    }
-  }
-
-  protected override async execute(options: DevOptions): Promise<void> {
-    // Find available port
-    const port = await this.portService.findAvailablePort(options.port);
-
-    // Get CLI version
-    const cliVersion = this.versionService.getCliVersion();
-
-    // Start development server (delegate to @poetora/previewing)
-    // Convert DevOptions to ArgumentsCamelCase format expected by dev()
-    const devArgs: ArgumentsCamelCase = {
-      _: [],
-      $0: this.packageName,
-      port,
-      open: options.open ?? true,
-      localSchema: options.localSchema ?? false,
-      clientVersion: options.clientVersion,
-      groups: options.groups,
-      disableOpenapi: options.disableOpenapi ?? false,
-      packageName: this.packageName,
-      cliVersion,
-    };
-
-    await dev(devArgs);
-  }
-}

package/src/commands/index.ts

@@ -1,6 +0,0 @@
-export * from './base.command.js';
-export * from './check.command.js';
-export * from './dev.command.js';
-export * from './init.command.js';
-export * from './link.command.js';
-export * from './update.command.js';

package/src/commands/init.command.ts

@@ -1,125 +0,0 @@
-import { input, select } from '@inquirer/prompts';
-import { ValidationError } from '../errors/index.js';
-import type { TemplateService } from '../services/template.service.js';
-import type { InitOptions } from '../types/index.js';
-import type { ILogger } from '../utils/index.js';
-import { BaseCommand } from './base.command.js';
-
-/**
- * Init command - Create a new Poetora documentation site
- */
-export class InitCommand extends BaseCommand {
-  readonly name = 'init';
-  readonly description = 'Create a new Poetora documentation site';
-
-  constructor(
-    logger: ILogger,
-    private readonly templateService: TemplateService,
-    packageName: string = 'poet'
-  ) {
-    super(logger, packageName);
-  }
-
-  protected override async execute(options: InitOptions): Promise<void> {
-    let installDir = options.directory;
-
-    // Step 1: Handle existing directory
-    const dirStatus = await this.templateService.checkDirectory(installDir);
-
-    if (dirStatus.exists && dirStatus.hasContents) {
-      const choice = await this.promptDirectoryChoice(installDir);
-
-      if (choice === 'cancel') {
-        this.logger.info('Installation cancelled');
-        return;
-      }
-
-      if (choice === 'subdir') {
-        const subdir = await this.promptSubdirectoryName();
-        installDir = installDir === '.' ? subdir : `${installDir}/${subdir}`;
-      }
-    }
-
-    // Step 2: Prompt for project configuration
-    const projectName = await this.promptProjectName(installDir);
-    const theme = await this.promptTheme();
-
-    // Step 3: Download and install template
-    this.logger.info('Setting up documentation project...');
-
-    await this.templateService.installTemplate({
-      directory: installDir,
-      projectName,
-      theme,
-    });
-
-    // Step 4: Show success message
-    this.showOnboardingMessage(installDir);
-  }
-
-  private async promptDirectoryChoice(
-    directory: string
-  ): Promise<'subdir' | 'overwrite' | 'cancel'> {
-    const choice = await select({
-      message: `Directory ${directory} is not empty. What would you like to do?`,
-      choices: [
-        { name: 'Create in a subdirectory', value: 'subdir' },
-        { name: 'Overwrite current directory (may lose contents)', value: 'overwrite' },
-        { name: 'Cancel', value: 'cancel' },
-      ],
-    });
-
-    return choice as 'subdir' | 'overwrite' | 'cancel';
-  }
-
-  private async promptSubdirectoryName(): Promise<string> {
-    const subdir = await input({
-      message: 'Subdirectory name:',
-      default: 'docs',
-    });
-
-    if (!subdir || subdir.trim() === '') {
-      throw new ValidationError('Subdirectory name cannot be empty');
-    }
-
-    return subdir.trim();
-  }
-
-  private async promptProjectName(installDir: string): Promise<string> {
-    const defaultProject = installDir === '.' ? 'Poetora' : installDir;
-
-    const projectName = await input({
-      message: 'Project Name',
-      default: defaultProject,
-    });
-
-    return projectName || defaultProject;
-  }
-
-  private async promptTheme(): Promise<string> {
-    const themes = this.templateService.getAvailableThemes();
-
-    const theme = await select({
-      message: 'Theme',
-      choices: themes.map((t) => ({
-        name: t,
-        value: t,
-      })),
-    });
-
-    return theme;
-  }
-
-  private showOnboardingMessage(installDir: string): void {
-    this.logger.log('');
-    this.logger.success('Documentation Setup!');
-    this.logger.log('');
-    this.logger.log('To see your docs run:');
-    this.logger.log('');
-    if (installDir !== '.') {
-      this.logger.log(`  cd ${installDir}`);
-    }
-    this.logger.log(`  ${this.packageName} dev`);
-    this.logger.log('');
-  }
-}

package/src/commands/link.command.ts

@@ -1,39 +0,0 @@
-import type { LinkService } from '../services/index.js';
-import type { RenameOptions } from '../types/index.js';
-import type { ILogger } from '../utils/index.js';
-import { BaseCommand } from './base.command.js';
-
-/**
- * Link command - Check broken links and rename files
- */
-export class LinkCommand extends BaseCommand {
-  readonly name = 'link';
-  readonly description = 'manage documentation links';
-
-  constructor(
-    logger: ILogger,
-    private readonly linkService: LinkService,
-    packageName: string = 'poet'
-  ) {
-    super(logger, packageName);
-  }
-
-  /**
-   * Check for broken links
-   */
-  async checkBrokenLinks(): Promise<Record<string, string[]>> {
-    return await this.linkService.checkBrokenLinks();
-  }
-
-  /**
-   * Rename file and update references
-   */
-  async renameFile(options: RenameOptions): Promise<void> {
-    await this.linkService.renameFile(options.from, options.to, options.force);
-  }
-
-  protected override async execute(): Promise<void> {
-    // Default action: check broken links
-    await this.linkService.checkBrokenLinks();
-  }
-}

package/src/commands/update.command.ts

@@ -1,23 +0,0 @@
-import type { UpdateService } from '../services/index.js';
-import type { ILogger } from '../utils/index.js';
-import { BaseCommand } from './base.command.js';
-
-/**
- * Update command - Update CLI to latest version
- */
-export class UpdateCommand extends BaseCommand {
-  readonly name = 'update';
-  readonly description = 'update the CLI to the latest version';
-
-  constructor(
-    logger: ILogger,
-    private readonly updateService: UpdateService,
-    packageName: string = 'poet'
-  ) {
-    super(logger, packageName);
-  }
-
-  protected override async execute(): Promise<void> {
-    await this.updateService.update();
-  }
-}

package/src/constants.ts

@@ -1,4 +0,0 @@
-import os from 'os';
-
-export const HOME_DIR = os.homedir();
-export const CMD_EXEC_PATH = process.cwd();

package/src/errors/cli-error.ts

@@ -1,83 +0,0 @@
-/**
- * Base CLI error class for all custom errors
- */
-export class CliError extends Error {
-  constructor(
-    message: string,
-    public readonly code: string,
-    public readonly exitCode: number = 1
-  ) {
-    super(message);
-    this.name = 'CliError';
-    Error.captureStackTrace(this, this.constructor);
-  }
-}
-
-/**
- * Error thrown when environment requirements are not met
- */
-export class InvalidEnvironmentError extends CliError {
-  constructor(message: string) {
-    super(message, 'INVALID_ENVIRONMENT', 1);
-    this.name = 'InvalidEnvironmentError';
-  }
-}
-
-/**
- * Error thrown when no available port is found
- */
-export class NoAvailablePortError extends CliError {
-  constructor(message: string) {
-    super(message, 'NO_AVAILABLE_PORT', 1);
-    this.name = 'NoAvailablePortError';
-  }
-}
-
-/**
- * Error thrown when configuration file is not found
- */
-export class ConfigNotFoundError extends CliError {
-  constructor(message: string) {
-    super(message, 'CONFIG_NOT_FOUND', 1);
-    this.name = 'ConfigNotFoundError';
-  }
-}
-
-/**
- * Error thrown when command validation fails
- */
-export class ValidationError extends CliError {
-  constructor(
-    message: string,
-    public readonly field?: string
-  ) {
-    super(message, 'VALIDATION_ERROR', 1);
-    this.name = 'ValidationError';
-  }
-}
-
-/**
- * Error thrown when file operations fail
- */
-export class FileSystemError extends CliError {
-  constructor(
-    message: string,
-    public readonly filePath?: string
-  ) {
-    super(message, 'FILE_SYSTEM_ERROR', 1);
-    this.name = 'FileSystemError';
-  }
-}
-
-/**
- * Error thrown when external service calls fail
- */
-export class ExternalServiceError extends CliError {
-  constructor(
-    message: string,
-    public readonly service?: string
-  ) {
-    super(message, 'EXTERNAL_SERVICE_ERROR', 1);
-    this.name = 'ExternalServiceError';
-  }
-}

package/src/errors/index.ts

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

package/src/index.ts

@@ -1,110 +0,0 @@
-#!/usr/bin/env node
-import { type ChildProcess, spawn } from 'child_process';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const packageName =
-  path.basename(process.argv[1] ?? '') === 'index'
-    ? 'poet'
-    : path.basename(process.argv[1] ?? '') || 'poet';
-
-let cli: ChildProcess | null = null;
-let isShuttingDown = false;
-let hasExited = false;
-
-const cleanup = async (): Promise<void> => {
-  if (isShuttingDown) return;
-  isShuttingDown = true;
-
-  if (cli && !cli.killed) {
-    try {
-      cli.kill('SIGTERM');
-
-      await new Promise<void>((resolve) => {
-        const timeout = setTimeout(() => {
-          if (cli && !cli.killed) {
-            cli.kill('SIGKILL');
-          }
-          resolve();
-        }, 5000);
-
-        cli?.once('exit', () => {
-          clearTimeout(timeout);
-          resolve();
-        });
-      });
-    } catch (_error) {
-      // ignore
-    }
-  }
-};
-
-const exitProcess = (code: number) => {
-  if (hasExited) return;
-  hasExited = true;
-  process.exit(code);
-};
-
-const killSignals = ['SIGINT', 'SIGTERM', 'SIGQUIT', 'SIGHUP'];
-killSignals.forEach((signal) => {
-  process.on(signal, async () => {
-    await cleanup();
-    exitProcess(0);
-  });
-});
-
-process.on('uncaughtException', async () => {
-  await cleanup();
-  exitProcess(1);
-});
-
-process.on('unhandledRejection', async () => {
-  await cleanup();
-  exitProcess(1);
-});
-
-try {
-  cli = spawn(
-    'node',
-    ['--no-deprecation', path.join(__dirname, '../bin/start'), ...process.argv.slice(2)],
-    {
-      stdio: 'inherit',
-      env: {
-        ...process.env,
-        POETORA_PACKAGE_NAME: packageName,
-        CLI_TEST_MODE: process.env.CLI_TEST_MODE ?? 'false',
-      },
-      shell: process.platform === 'win32',
-      windowsHide: process.platform === 'win32',
-      detached: false,
-    }
-  );
-
-  cli.on('error', async (error) => {
-    console.error(`Failed to start ${packageName}: ${error.message}`);
-    await cleanup();
-    exitProcess(1);
-  });
-
-  cli.on('exit', (code) => {
-    exitProcess(code ?? 0);
-  });
-} catch (error) {
-  console.error(`Failed to start ${packageName}: ${error}`);
-  exitProcess(1);
-}
-
-process.on('exit', () => {
-  if (cli && !cli.killed) {
-    try {
-      cli.kill('SIGKILL');
-    } catch (_error) {
-      // ignore
-    }
-  }
-});
-
-export { cli };