diff --git a/README.md b/README.md index fd51cf03..73566823 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -
+ # Roborazzi @@ -43,8 +43,8 @@ efficient and reliable testing process by capturing screenshots with Robolectric In the DroidKaigi 2023 app, Roborazzi was introduced from the early stages of development as part of the architectural design. This integration allowed the team to verify changes throughout the development process. The specific architectural decisions and how they were implemented can be found [README](https://github.com/DroidKaigi/conference-app-2023#screenshot-testing-with-robolectric-native-graphics-rng-and-roborazzi). -
-
+ + # Try it out @@ -73,8 +73,8 @@ add `@GraphicsMode(GraphicsMode.Mode.NATIVE)` to your test class. @GraphicsMode(GraphicsMode.Mode.NATIVE) ``` -
-
+ + # Build setup @@ -316,7 +316,7 @@ Roborazzi uses `module/build/outputs/roborazzi` as the default directory for ref roborazzi { // Directory for reference images outputDir.set(file("src/screenshots")) - // Directory for comparison images + // Directory for comparison images (Experimental option) compare { outputDir.set(file("build/outputs/screenshots_comparison")) } @@ -327,10 +327,10 @@ roborazzi { > By default, when you use `captureRoboImage("image.png")`, the image will be saved as `module/image.png`. > You can customize the file path strategy for the recorded image. The default strategy is `relativePathFromCurrentDirectory`. If you select `relativePathFromRoborazziContextOutputDirectory`, the file will be saved in the output directory specified by `RoborazziRule.Options.outputDirectoryPath`. > This can be configured in your `gradle.properties` file: - -```properties -roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory -``` +> +> ```properties +> roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory +> ``` ### Add dependencies @@ -340,8 +340,8 @@ roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirector | Jetpack Compose | `testImplementation("io.github.takahirom.roborazzi:roborazzi-compose:[version]")` | | JUnit rules | `testImplementation("io.github.takahirom.roborazzi:roborazzi-junit-rule:[version]")` | -
-
+ + # How to use @@ -959,8 +959,8 @@ Please refer to [Accessibility Check](https://github.com/takahirom/roborazzi/blo Please check out [RoborazziOptions](https://github.com/takahirom/roborazzi/blob/main/include-build/roborazzi-core/src/commonJvmMain/kotlin/com/github/takahirom/roborazzi/RoborazziOptions.kt) for available Roborazzi options. -
-
+ + # Experimental Compose Preview Support @@ -1010,7 +1010,7 @@ roborazzi { } ``` -> **Note** +> [!NOTE] > If you are using build.gradle instead of build.gradle.kts, you need to use the set method for each assignment, like > ```kotlin > generateComposePreviewRobolectricTests.packages.set(["com.example"]) @@ -1039,8 +1039,8 @@ Currently, we don't support all the annotation options provided by the Compose P You can check the supported annotations in the [source code](https://github.com/takahirom/roborazzi/blob/0810ceb7133e6ec38472046cb741242a5ef6ab9e/roborazzi-compose-preview-scanner-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt#L27). We are looking forward to your contributions to support more annotation options. -
-
+ + # Experimental AI-Powered Image Assertion @@ -1148,8 +1148,8 @@ compareOptions = RoborazziOptions.CompareOptions( ... ``` -
-
+ + # Roborazzi IntelliJ IDEA and Android Studio Plugin @@ -1161,8 +1161,8 @@ Demo of Roborazzi IntelliJ IDEA and Android Studio Plugin. [https://github.com/takahirom/roborazzi/assets/1386930/bd3e8106-1971-4ec4-b764-3f1831999228](https://github.com/takahirom/roborazzi/assets/1386930/bd3e8106-1971-4ec4-b764-3f1831999228) The Roborazzi plugin enhances your development workflow by automatically displaying screenshots related to Roborazzi's screenshot tests within IntelliJ IDEA. Easily view and verify visual outputs directly in your IDE, streamlining your testing and development process. -
-
+ + # Multiplatform support @@ -1361,8 +1361,8 @@ The sample image ![MainJvmTest test_2](https://github.com/takahirom/roborazzi/assets/1386930/2edc828c-6fd8-4a9a-8f3d-b0e7baa85f0d) -
-
+ + # Roborazzi gradle.properties Options and Recommendations @@ -1437,8 +1437,8 @@ android { it.systemProperties["robolectric.pixelCopyRenderMode"] = "hardware" } ``` -
-
+ + # FAQ @@ -1575,7 +1575,7 @@ Additionally, it might be worth trying to run your tests with VisualVM to monito **A:** It is discussed in [this issue](https://github.com/takahirom/roborazzi/issues/493). To enable the display of Roborazzi tasks, please enable ***Configure all Gradle tasks during Gradle Sync (this can make Gradle Sync slower)*** in the Settings | Experimental | Gradle. -
+ ### LICENSE diff --git a/README.template.md b/README.template.md index a80ea111..2eb8d417 100644 --- a/README.template.md +++ b/README.template.md @@ -1,24 +1,24 @@ -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ + + + + + + + + + + + + + + + + + + + ### LICENSE diff --git a/build.gradle b/build.gradle index 454c2d94..1ddff669 100644 --- a/build.gradle +++ b/build.gradle @@ -132,12 +132,12 @@ tasks.register("generateReadme") { def newReadmeContent = readmeContent println(topics) topics.forEach { topic -> - def pattern = Pattern.compile("
.*?
", Pattern.DOTALL) + def pattern = Pattern.compile(".*?", Pattern.DOTALL) def result = pattern.matcher(newReadmeContent).find() println("topic: $topic pattern: $pattern result: $result") def generatedComment = "" - def newTopicContent = "
\n\n$generatedComment\n${topic.content}\n<\\/div>" + def newTopicContent = "\n\n$generatedComment\n${topic.content}\n" newReadmeContent = pattern.matcher(newReadmeContent) .replaceAll(newTopicContent) } diff --git a/docs/topics/build_setup.md b/docs/topics/build_setup.md index 4603c6cd..fd0ed39d 100644 --- a/docs/topics/build_setup.md +++ b/docs/topics/build_setup.md @@ -237,7 +237,7 @@ Roborazzi uses `module/build/outputs/roborazzi` as the default directory for ref roborazzi { // Directory for reference images outputDir.set(file("src/screenshots")) - // Directory for comparison images + // Directory for comparison images (Experimental option) compare { outputDir.set(file("build/outputs/screenshots_comparison")) } @@ -248,10 +248,10 @@ roborazzi { > By default, when you use `captureRoboImage("image.png")`, the image will be saved as `module/image.png`. > You can customize the file path strategy for the recorded image. The default strategy is `relativePathFromCurrentDirectory`. If you select `relativePathFromRoborazziContextOutputDirectory`, the file will be saved in the output directory specified by `RoborazziRule.Options.outputDirectoryPath`. > This can be configured in your `gradle.properties` file: - -```properties -roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory -``` +> +> ```properties +> roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory +> ``` ### Add dependencies diff --git a/docs/topics/preview_support.md b/docs/topics/preview_support.md index ccde22c8..ffee6800 100644 --- a/docs/topics/preview_support.md +++ b/docs/topics/preview_support.md @@ -45,7 +45,7 @@ roborazzi { } ``` -> **Note** +> [!NOTE] > If you are using build.gradle instead of build.gradle.kts, you need to use the set method for each assignment, like > ```kotlin > generateComposePreviewRobolectricTests.packages.set(["com.example"])