Class DoctorSuite<TContext>Abstract

Protectedcontext

Protectedassert

• assert(condition: boolean, message: string): void

  Assert a boolean condition.

  Parameters

  • condition: boolean

    The boolean condition to assert.
  • message: string

    The assertion description.

  Returns void

ProtectedassertDirectory

• assertDirectory(path: string, message?: string): Promise<void>

  Assert that a directory exists.

  Parameters

  • path: string

    The directory path to check.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns Promise<void>

ProtectedassertEqual

• assertEqual<T>(actual: T, expected: T, message: string): void

  Assert two values are equal.

  Type Parameters

  • T

  Parameters

  • actual: T

    The actual value.
  • expected: T

    The expected value.
  • message: string

    The assertion description.

  Returns void

ProtectedassertError

• assertError(
      result: CommandResult,
      pattern?: string | RegExp,
      message?: string,
  ): void

  Assert that a command failed with an error matching the pattern.

  Parameters

  • result: CommandResult

    The command result to check.
  • Optionalpattern: string | RegExp

    Optional regex or string pattern to match against output.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns void

ProtectedassertFile

• assertFile(
      path: string,
      contentPattern?: string | RegExp,
      message?: string,
  ): Promise<void>

  Assert that a file exists and optionally matches content.

  Parameters

  • path: string

    The file path to check.
  • OptionalcontentPattern: string | RegExp

    Optional regex or string to match file content.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns Promise<void>

ProtectedassertJson

• assertJson<T = unknown>(
      result: CommandResult,
      validator?: (json: T) => boolean,
      message?: string,
  ): undefined | T

  Assert that output contains valid JSON and optionally validate it.

  Type Parameters

  • T = unknown

  Parameters

  • result: CommandResult

    The command result to parse.
  • Optionalvalidator: (json: T) => boolean

    Optional function to validate the parsed JSON.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns undefined | T

ProtectedassertNoFile

• assertNoFile(path: string, message?: string): Promise<void>

  Assert that a file does not exist.

  Parameters

  • path: string

    The file path to check.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns Promise<void>

ProtectedassertOutput

• assertOutput(
      result: CommandResult,
      pattern: string | RegExp,
      message?: string,
  ): void

  Assert that output contains a pattern.

  Parameters

  • result: CommandResult

    The command result to check.
  • pattern: string | RegExp

    Regex or string pattern to match against output.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns void

ProtectedassertSuccess

• assertSuccess(result: CommandResult, message?: string): void

  Assert that a command succeeded (exit code 0).

  Parameters

  • result: CommandResult

    The command result to check.
  • Optionalmessage: string

    Optional custom assertion message.

  Returns void

Protectedrun

• run(
      command: string,
      options?: { cwd?: string; env?: { [key: string]: string } },
  ): Promise<CommandResult>

  Run a CLI command and return the result.

  Parameters

  • command: string

    The CLI command to run.
  • Optionaloptions: { cwd?: string; env?: { [key: string]: string } }

    Optional overrides.

    • Optionalcwd?: string

      Working directory for the command.

    • Optionalenv?: { [key: string]: string }

      Environment variables for the command.

  Returns Promise<CommandResult>

  Example

  const result = await this.run('shopify theme init my-theme')
  const result = await this.run('shopify theme push --json')
  Copy

ProtectedrunInteractive

• runInteractive(
      command: string,
      options?: { cwd?: string; env?: { [key: string]: string } },
  ): Promise<CommandResult>

  Run a command without capturing output (for interactive commands). Returns only success/failure.

  Parameters

  • command: string

    The CLI command to run.
  • Optionaloptions: { cwd?: string; env?: { [key: string]: string } }

    Optional overrides.

    • Optionalcwd?: string

      Working directory for the command.

    • Optionalenv?: { [key: string]: string }

      Environment variables for the command.

  Returns Promise<CommandResult>

Protectedtest

• test(name: string, fn: () => Promise<void>): void

  Register a test with a name and function.

  Parameters

  • name: string

    The test name.
  • fn: () => Promise<void>

    The async test function.

  Returns void

Protectedtests

• tests(): void

  Override this method to register tests using this.test().

  Returns void