Superwall Flutter

https://github.com/superwall/superwall-flutter
Admin
Superwall Flutter is an open-source framework that provides a wrapper for presenting and creating...
Tokens:2,143
Snippets:39
Trust Score:9.3
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Maestro CLI on macOS

Source: https://github.com/superwall/superwall-flutter/blob/main/test_app/README.md

Use Homebrew to install the Maestro CLI on macOS. Ensure you have tapped the correct repository first.

```bash
# macOS
 brew tap mobile-dev-inc/tap
 brew install maestro
```

--------------------------------

### Install Flutter Dependencies

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Installs project dependencies using Flutter's package manager. Run this command in the root directory of the project.

```bash
flutter pub get
```

--------------------------------

### Run Flutter Unit Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Executes all unit tests for the Flutter project. Ensure dependencies are installed before running.

```bash
flutter test
```

--------------------------------

### Run Maestro UI Tests for iOS

Source: https://github.com/superwall/superwall-flutter/blob/main/CONTRIBUTING.md

Execute Maestro UI tests on iOS. Ensure you have Maestro installed and note the platform ID specific to iOS.

```sh
maestro test -e PLATFORM_ID=com.superwall.Advanced test_app/maestro/purchasecontroller/no_pc_purchases.yaml
```

--------------------------------

### Run Maestro UI Tests for Android

Source: https://github.com/superwall/superwall-flutter/blob/main/CONTRIBUTING.md

Execute Maestro UI tests on Android. Ensure you have Maestro installed and note the platform ID specific to Android.

```sh
maestro test -e PLATFORM_ID=com.superwall.superapp test_app/maestro/purchasecontroller/no_pc_purchases.yaml
```

--------------------------------

### Run Integration Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CONTRIBUTING.md

Execute integration tests for non-UI and non-paywall dependent methods of the SDK.

```sh
flutter test integration_test/sdk_methods_test.dart
```

--------------------------------

### Run Pigeon Code Generation

Source: https://github.com/superwall/superwall-flutter/blob/main/CONTRIBUTING.md

Execute this command to generate Dart, Kotlin, and Swift interfaces based on the Pigeon configuration file.

```sh
flutter pub run pigeon --input pigeons/configure.dart
```

--------------------------------

### Run Flutter Integration Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Executes integration tests for the SDK methods. This requires navigating to the `test_app` directory first.

```bash
cd test_app && flutter test integration_test/sdk_methods_test.dart
```

--------------------------------

### Run Android Maestro UI Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Executes UI tests on Android using Maestro. This script is located in the project root.

```bash
./run_tests.sh android
```

--------------------------------

### Run a Single Maestro Test

Source: https://github.com/superwall/superwall-flutter/blob/main/test_app/README.md

Execute a specific Maestro test file. This is useful for debugging or testing individual scenarios.

```bash
maestro test test_app/maestro/flow.yaml
```

--------------------------------

### Run iOS Maestro UI Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Executes UI tests on iOS using Maestro. This script is located in the project root.

```bash
./run_tests.sh ios
```

--------------------------------

### Run All Android or iOS Maestro Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/CONTRIBUTING.md

Convenience script to run all Android or all iOS test flows using Maestro.

```sh
./run_tests.sh android/ios
```

--------------------------------

### Run All Maestro Tests

Source: https://github.com/superwall/superwall-flutter/blob/main/test_app/README.md

Execute all Maestro tests located in the specified directory. This is typically used for full regression testing.

```bash
maestro test test_app/maestro/
```

--------------------------------

### Run Flutter Lint Analysis

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Performs static code analysis to check for linting issues. Uses Flutter's default linting rules with custom overrides.

```bash
flutter analyze
```

--------------------------------

### Run Specific Maestro Test (iOS)

Source: https://github.com/superwall/superwall-flutter/blob/main/CLAUDE.md

Runs a specific Maestro test flow for iOS, targeting the 'Advanced' app configuration.

```bash
maestro test -e PLATFORM_ID=com.superwall.Advanced test_app/maestro/handler/flow.yaml
```

--------------------------------

### Run Maestro Tests with Specific Tags

Source: https://github.com/superwall/superwall-flutter/blob/main/test_app/README.md

Filter and run Maestro tests based on assigned tags. This allows for targeted testing of features or components.

```bash
maestro test -t tagname test_app/maestro/
```
Tokens:
Raw