Vue CLI Plugin E2E Cypress

// Vue CLI plugins are loaded automatically by the CLI service
// No direct imports needed in application code

# Install the plugin in an existing Vue project
vue add e2e-cypress

# Run e2e tests in interactive mode
vue-cli-service test:e2e

# Run e2e tests in headless mode (for CI)
vue-cli-service test:e2e --headless

# Run tests against a specific URL
vue-cli-service test:e2e --url=http://localhost:8080

# Run a specific test file in headless mode
vue-cli-service test:e2e --headless --spec=tests/e2e/specs/test.js

/**
 * Main plugin function that registers the test:e2e command
 * @param api - Vue CLI Plugin API instance
 * @param options - Plugin configuration options
 */
function plugin(api: PluginAPI, options: PluginOptions): void;

interface PluginAPI {
  registerCommand(name: string, options: CommandOptions, handler: CommandHandler): void;
  service: {
    run(command: string): Promise<{ url: string; server?: any }>;
  };
  getCwd(): string;
}

interface CommandOptions {
  description: string;
  usage: string;
  options: Record<string, string>;
  details: string;
}

interface CommandHandler {
  (args: CommandArgs, rawArgs: string[]): Promise<any>;
}

interface CommandArgs {
  headless?: boolean;
  mode?: string;
  url?: string;
  spec?: string;
  config?: string | string[];
}

# Interactive mode with GUI
vue-cli-service test:e2e

# Headless mode for CI/CD
vue-cli-service test:e2e --headless

# Test against custom URL
vue-cli-service test:e2e --url=https://staging.example.com

# Run specific test file
vue-cli-service test:e2e --headless --spec=tests/e2e/specs/login.spec.js

# Development mode
vue-cli-service test:e2e --mode=development

/**
 * Default modes configuration for commands
 */
const defaultModes: {
  'test:e2e': string;
} = {
  'test:e2e': 'production'
};

/**
 * Generator function that sets up Cypress testing structure
 * @param api - Vue CLI Generator API instance
 */
function generator(api: GeneratorAPI): void;

interface GeneratorAPI {
  render(templatePath: string, data: TemplateData): void;
  extendPackage(packageUpdate: PackageUpdate): void;
  hasPlugin(pluginName: string): boolean;
}

interface TemplateData {
  hasTS: boolean;
  hasESLint: boolean;
}

interface PackageUpdate {
  devDependencies: Record<string, string>;
  scripts: Record<string, string>;
}

/**
 * Migrator function that handles plugin upgrades and ensures Cypress dependency
 * @param api - Vue CLI Migrator API instance
 */
function migrator(api: MigratorAPI): void;

interface MigratorAPI {
  extendPackage(packageUpdateFn: PackageUpdateFunction): void;
}

interface PackageUpdateFunction {
  (pkg: PackageJSON): PackageUpdate | undefined;
}

interface PackageJSON {
  dependencies?: Record<string, string>;
  devDependencies?: Record<string, string>;
  optionalDependencies?: Record<string, string>;
}

/**
 * UI integration function for Vue CLI UI
 * @param api - Vue CLI UI API instance
 */
function uiIntegration(api: UIAPI): void;

interface UIAPI {
  describeTask(taskDescriptor: TaskDescriptor): void;
}

interface TaskDescriptor {
  match: RegExp;
  description: string;
  link: string;
  prompts: UIPrompt[];
  onBeforeRun: BeforeRunHandler;
}

interface UIPrompt {
  name: string;
  type: 'confirm' | 'list' | 'input';
  default: any;
  description: string;
  choices?: UIChoice[];
}

interface UIChoice {
  name: string;
  value: string;
}

interface BeforeRunHandler {
  (context: { answers: Record<string, any>; args: string[] }): void;
}

/**
 * Removes specified arguments from command line arguments array
 * @param rawArgs - Array of command line arguments
 * @param argToRemove - Name of argument to remove (without --)
 * @param offset - Number of additional arguments to remove (default: 1)
 */
function removeArg(rawArgs: string[], argToRemove: string, offset?: number): void;

/**
 * Plugin configuration options
 */
interface PluginOptions {
  [key: string]: any;
}

/**
 * Cypress execution modes
 */
type CypressMode = 'open' | 'run';

/**
 * Server execution mode
 */
type ServerMode = 'development' | 'production' | 'test';

/**
 * Test execution result
 */
interface TestResult {
  success: boolean;
  exitCode?: number;
}

{
  "pluginsFile": "tests/e2e/plugins/index.js"
}