From 0c34d1f9569a5f0552db0174d580f0cb5f6b2752 Mon Sep 17 00:00:00 2001 From: Daymon Date: Thu, 20 Mar 2025 12:25:04 -0500 Subject: [PATCH] Update FiresiteTransformTask.kt --- .../gradle/plugins/FiresiteTransformTask.kt | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/plugins/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt b/plugins/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt index e8f4186d97e..7de416de561 100644 --- a/plugins/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt +++ b/plugins/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt @@ -38,6 +38,7 @@ import org.gradle.api.tasks.TaskAction * - Adds the deprecated status to ktx sections in _toc.yaml files * - Fixes broken hyperlinks in `@see` blocks * - Removes the prefix path from book_path + * - Removes the `com.google` package prefix from _toc.yaml files * * **Please note:** This task is idempotent- meaning it can safely be ran multiple times on the same * set of files. @@ -77,10 +78,35 @@ abstract class FiresiteTransformTask : DefaultTask() { } private fun File.fixYamlFile() { - val fixedContent = readText().removeClassHeader().removeIndexHeader().addDeprecatedStatus() + val fixedContent = + readText().removeClassHeader().removeIndexHeader().addDeprecatedStatus().removePackagePrefix() writeText(fixedContent) } + /** + * Removes the `com.google.` prefix from the package titles in the table of contents. + * + * The prefix pollutes the TOC, especially on smaller screen sizes; so we opt to removed it + * entirely. + * + * Example input: + * ``` + * toc: + * - title: "com.google.firebase.functions" + * path: "/docs/reference/android/com/google/firebase/functions/package-summary.html" + * ``` + * + * Example output: + * ``` + * toc: + * - title: "firebase.functions" + * path: "/docs/reference/android/com/google/firebase/functions/package-summary.html" + * ``` + * + * TODO(b/378717454): Migrate to the param packagePrefixToRemoveInToc in dackka when fixed + */ + private fun String.removePackagePrefix() = remove(Regex("(?<=title: \")(com\\.google\\.)")) + /** * Fixes broken hyperlinks in the rendered HTML *