Development Workflow

Install

npm install
npm --prefix example install

TypeScript

npm run typecheck
npm --prefix example run typecheck

Run the Example App

npm run example:start
npm run example:ios
npm run example:android

Rebuild Rust Artifacts

Full rebuild (iOS + Android + bindings):

npm run build:rust

Platform-specific:

npm run build:rust:ios
npm run build:rust:android

Prepare for Publish

To sync versioned files, rebuild the packaged native artifacts, rebuild dist, and dry-run the npm tarball:

npm run publish:prepare

Tests

TypeScript Unit Tests

npm test

Rust Core Tests

cargo test --manifest-path rust/editor-core/Cargo.toml

Performance Benchmarks

Run the dedicated Rust-core benchmark suite in release mode:

npm run bench:rust -- --quick

Useful options:

npm run bench:rust -- --filter collaboration
npm run bench:rust -- --json > perf-results.json
npm run bench:rust:quick

The suite covers editor state/render generation, editing operations, position mapping sweeps, and collaboration update handling. Use --quick for fast local checks and omit it for a heavier run.

Android Unit Tests

npm run android:test
npm run android:test:perf
npm run android:test:perf:device

This runs the Robolectric-based unit tests for the Android native module. You can also compile-check Android Kotlin without running tests:

npm run android:compile

For physical-device or emulator instrumentation runs, set ANDROID_DEVICE_ID or ANDROID_SERIAL, or create example/android/.device-test.env, then run:

npm run android:test:device
npm run android:test:perf:device

iOS XCTest

npm run ios:test

This wrapper always runs the workspace, not the raw .xcodeproj, so CocoaPods targets like ExpoModulesCore stay in the build graph.

Pass through any extra xcodebuild flags after --:

npm run ios:test -- -only-testing:NativeEditorTests/RenderBridgeTests
npm run ios:test:perf

For physical-device runs, set IOS_DEVICE_ID and IOS_DEVELOPMENT_TEAM, or create ios-tests/.device-test.env, then run:

npm run ios:test:device
npm run ios:test:perf:device

Override the auto-selected simulator if needed:

IOS_SIMULATOR_NAME="iPhone 17" npm run ios:test
IOS_DESTINATION="platform=iOS Simulator,id=<simulator-id>" npm run ios:test

If you change ios-tests/project.yml, or add, remove, or rename files under ios or ios/Tests, regenerate the Xcode project before running CocoaPods or tests. The test harness pulls source files from both trees.

cd ios-tests
xcodegen generate
pod install

Prebuild the Example App

If you need to regenerate the native projects (e.g. after changing Expo config or adding native dependencies):

npm run example:prebuild

When to Rebuild

Rebuild Rust outputs when you change:

• Rust core logic
• the UniFFI UDL surface
• generated Swift or Kotlin bindings

Rebuild native apps when you change:

• iOS native editor code
• Android native editor code
• Expo module wiring

Tips

• The example app is the fastest way to validate focus, keyboard, toolbar, and theming behavior.
• The iOS XCTest target is useful for native regressions that are too specific for the example app alone.
• Android unit tests run under Robolectric and do not require a device or emulator.