Development Server

/**
 * Development server command for Egg.js applications
 * Extends BaseCommand with development-specific options
 */
class DevCommand extends BaseCommand {
  /** Listening port, default 7001 or auto-detected available port */
  port: number;
  
  /** Number of app workers, default 1 at local mode */
  workers: number;
  
  /** Framework path (absolute path or npm package), defaults to 'egg' */
  framework: string;
  
  /** Start sticky cluster server for load balancing, default false */
  sticky: boolean;
  
  /**
   * Executes the development server startup process
   * Sets NODE_ENV to development and starts cluster with configured options
   */
  run(): Promise<void>;
  
  /**
   * Formats egg start options with port detection and configuration loading
   * @returns Promise resolving to egg cluster start options
   */
  protected formatEggStartOptions(): Promise<EggStartOptions>;
}

interface EggStartOptions {
  baseDir: string;
  workers: number;
  port: number;
  framework: string;
  typescript: boolean;
  tscompiler: string;
  sticky: boolean;
}

/**
 * Port detection and configuration loading process
 * Uses @eggjs/utils for configuration reading and detect-port for availability
 */
interface PortDetectionProcess {
  /** Reads egg configuration for the local environment */
  getConfig(options: { framework: string; baseDir: string; env: string }): Promise<any>;
  
  /** Detects next available port starting from the default */
  detectPort(defaultPort: number | string): Promise<number>;
}

# Start with default settings
egg-bin dev

# Specify port and workers
egg-bin dev --port 8000 --workers 4

# Use custom framework
egg-bin dev --framework ./my-custom-egg

# Enable sticky sessions for load balancing
egg-bin dev --sticky

# TypeScript development with debugging
egg-bin dev --typescript --inspect

/**
 * Framework path resolution using @eggjs/utils
 * Resolves relative paths, npm packages, and absolute paths
 */
interface FrameworkResolution {
  /** Resolves framework path from various input formats */
  getFrameworkPath(options: {
    framework?: string;
    baseDir: string;
  }): string;
}

/**
 * Development environment configuration
 * Sets up NODE_ENV, timeouts, and process management
 */
interface DevEnvironment {
  /** Set to 'development' for egg environment detection */
  NODE_ENV: string;
  
  /** Master process close timeout (1000ms for fast restarts) */
  EGG_MASTER_CLOSE_TIMEOUT: string;
  
  /** TypeScript compilation flag when enabled */
  EGG_TYPESCRIPT?: string;
}

/**
 * Cluster startup script that receives serialized options
 * Located at scripts/start-cluster.js
 */
interface ClusterScript {
  /** Parses JSON options and starts egg cluster */
  startCluster(options: EggStartOptions): void;
}

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Egg Debug",
      "runtimeExecutable": "npm",
      "runtimeArgs": ["run", "dev", "--", "--inspect-brk"],
      "console": "integratedTerminal",
      "restart": true,
      "protocol": "auto",
      "port": 9229,
      "autoAttachChildProcesses": true
    }
  ]
}

{
  "egg": {
    "typescript": true,
    "tscompiler": "@swc-node/register",
    "require": ["./app/extend/helper.js"],
    "revert": ["CVE-2023-46809"]
  }
}