|
| 1 | +# Gemini Project Context: Android Testify IntelliJ Plugin |
| 2 | + |
| 3 | +This document provides context for the Android Testify IntelliJ Plugin project. |
| 4 | + |
| 5 | +## Project Overview |
| 6 | + |
| 7 | +This is a Gradle-based IntelliJ Platform Plugin for [Android Testify](https://testify.dev/), an Android screenshot testing framework. The plugin is written in Kotlin and enhances the developer experience by integrating Testify commands directly into the IntelliJ IDE (including Android Studio). |
| 8 | + |
| 9 | +Key features of the plugin include: |
| 10 | +- Running Testify screenshot tests. |
| 11 | +- Recording, pulling, revealing, and deleting baseline screenshot images. |
| 12 | +- Navigating between test source code and their corresponding baseline images. |
| 13 | + |
| 14 | +The plugin's functionality is defined in `src/main/resources/META-INF/plugin.xml`, and the implementation is in Kotlin under `src/main/kotlin/dev/testify/`. |
| 15 | + |
| 16 | +## Building and Running |
| 17 | + |
| 18 | +This project uses the Gradle wrapper (`gradlew`). |
| 19 | + |
| 20 | +- **To build the plugin:** |
| 21 | + ```bash |
| 22 | + ./gradlew buildPlugin |
| 23 | + ``` |
| 24 | + |
| 25 | +- **To run the plugin in a development instance of the IDE:** |
| 26 | + ```bash |
| 27 | + ./gradlew runIde |
| 28 | + ``` |
| 29 | + |
| 30 | +- **To run the plugin's tests:** |
| 31 | + ```bash |
| 32 | + ./gradlew test |
| 33 | + ``` |
| 34 | + |
| 35 | +## Development Conventions |
| 36 | + |
| 37 | +The project follows standard Kotlin coding conventions. The codebase is structured around the IntelliJ Platform's action and extension system. |
| 38 | + |
| 39 | +- **Actions:** User-invoked commands (e.g., "Go to Baseline") are implemented as classes that extend `AnAction`. See files in `src/main/kotlin/dev/testify/actions/`. |
| 40 | +- **Extensions:** IDE integrations, such as line markers next to screenshot tests, are implemented using extension points. See files in `src/main/kotlin/dev/testify/extensions/`. |
| 41 | + |
| 42 | +Dependencies and project versions are managed in the `build.gradle.kts` file and the `gradle/libs.versions.toml` version catalog. |
| 43 | + |
| 44 | +## Key Files |
| 45 | + |
| 46 | +- `README.md`: Provides a high-level overview of the plugin for users. |
| 47 | +- `build.gradle.kts`: The main Gradle build script that configures the IntelliJ Platform, Kotlin, and dependencies. |
| 48 | +- `src/main/resources/META-INF/plugin.xml`: The plugin's manifest file, which declares its dependencies, extensions, and actions. |
| 49 | +- `src/main/kotlin/dev/testify/`: The root directory for the plugin's Kotlin source code. |
| 50 | +- `gradle/libs.versions.toml`: The Gradle version catalog, defining the project's dependencies and their versions. |
0 commit comments