dev

Documentation

Overview

Package dev provides development session management for Flutter and React Native hot reload.

Index

• func EnsureCustomDevice(mobaiURL string) error
• func FindIPA(distDir string) (string, error)
• type FlutterHandler
  • func NewFlutterHandler(mobaiURL string, noAttach bool) *FlutterHandler
  • func (h *FlutterHandler) Attach(ctx context.Context, deviceID string, debugOutput <-chan mobai.DebugOutput) error
  • func (h *FlutterHandler) DebugConfig() *mobai.DebugConfig
  • func (h *FlutterHandler) Setup(ctx context.Context) error
  • func (h *FlutterHandler) Stop()
• type FrameworkHandler
• type ReactNativeHandler
  • func NewReactNativeHandler(metroPort int, showLogs bool, mobaiURL string) *ReactNativeHandler
  • func (h *ReactNativeHandler) Attach(ctx context.Context, deviceID string, debugOutput <-chan mobai.DebugOutput) error
  • func (h *ReactNativeHandler) DebugConfig() *mobai.DebugConfig
  • func (h *ReactNativeHandler) Setup(ctx context.Context) error
  • func (h *ReactNativeHandler) Stop()
• type RuntimeError
  • func (e *RuntimeError) Error() string
• type Session
  • func NewSession(mobaiURL, deviceID, ipaPath string, h FrameworkHandler) *Session
  • func (s *Session) SetSkipInstall(skip bool, bundleID string)
  • func (s *Session) Start(ctx context.Context) error
  • func (s *Session) Stop()

Functions

func EnsureCustomDevice

func EnsureCustomDevice(mobaiURL string) error

EnsureCustomDevice ensures Flutter custom_devices.json has mobai-ios configured.

func FindIPA

func FindIPA(distDir string) (string, error)

FindIPA lists IPAs in distDir and lets user select if multiple.

Types

type FlutterHandler

type FlutterHandler struct {
	// contains filtered or unexported fields
}

FlutterHandler implements FrameworkHandler for Flutter projects.

func NewFlutterHandler

func NewFlutterHandler(mobaiURL string, noAttach bool) *FlutterHandler

NewFlutterHandler creates a new Flutter handler.

func (*FlutterHandler) Attach

func (h *FlutterHandler) Attach(ctx context.Context, deviceID string, debugOutput <-chan mobai.DebugOutput) error

Attach finds the VM Service URL and runs flutter attach.

func (*FlutterHandler) DebugConfig

func (h *FlutterHandler) DebugConfig() *mobai.DebugConfig

DebugConfig returns nil for Flutter (no special environment needed).

func (*FlutterHandler) Setup

func (h *FlutterHandler) Setup(ctx context.Context) error

Setup configures Flutter custom device for MobAI.

func (*FlutterHandler) Stop

func (h *FlutterHandler) Stop()

type FrameworkHandler

type FrameworkHandler interface {
	// Setup runs before app install (e.g., Flutter custom device, Metro start)
	Setup(ctx context.Context) error
	// DebugConfig returns environment variables and arguments for app launch
	DebugConfig() *mobai.DebugConfig
	// Attach runs after app launch to enable hot reload
	Attach(ctx context.Context, deviceID string, debugOutput <-chan mobai.DebugOutput) error
	// Stop cleans up resources
	Stop()
}

FrameworkHandler handles framework-specific dev workflow.

type ReactNativeHandler

type ReactNativeHandler struct {
	// contains filtered or unexported fields
}

ReactNativeHandler implements FrameworkHandler for React Native projects.

func NewReactNativeHandler

func NewReactNativeHandler(metroPort int, showLogs bool, mobaiURL string) *ReactNativeHandler

NewReactNativeHandler creates a new React Native handler.

func (*ReactNativeHandler) Attach

func (h *ReactNativeHandler) Attach(ctx context.Context, deviceID string, debugOutput <-chan mobai.DebugOutput) error

Attach monitors app output for React Native development.

func (*ReactNativeHandler) DebugConfig

func (h *ReactNativeHandler) DebugConfig() *mobai.DebugConfig

DebugConfig returns launch arguments to configure Metro connection. React Native reads RCT_jsLocation from NSUserDefaults, which can be set via launch arguments.

func (*ReactNativeHandler) Setup

func (h *ReactNativeHandler) Setup(ctx context.Context) error

Setup checks if Metro is running and starts it if not.

func (*ReactNativeHandler) Stop

func (h *ReactNativeHandler) Stop()

Stop cleans up Metro if we started it.

type RuntimeError

type RuntimeError struct {
	Err error
}

RuntimeError wraps runtime errors to distinguish from CLI errors

func (*RuntimeError) Error

func (e *RuntimeError) Error() string

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session manages a development session with MobAI.

func NewSession

func NewSession(mobaiURL, deviceID, ipaPath string, h FrameworkHandler) *Session

NewSession creates a new development session.

func (*Session) SetSkipInstall

func (s *Session) SetSkipInstall(skip bool, bundleID string)

SetSkipInstall configures the session to skip installation.

func (*Session) Start

func (s *Session) Start(ctx context.Context) error

Start runs the full dev session: setup, install, launch, attach.

func (*Session) Stop

func (s *Session) Stop()

Stop cleans up resources.