[Infra] Enable simple formatter for md

CONTRIBUTING.md

@@ -1,26 +1,24 @@
 # How to Contribute
 
-We'd love to accept your patches and contributions to this project. There are
-just a few small guidelines you need to follow.
+We'd love to accept your patches and contributions to this project. There are just a few small
+guidelines you need to follow.
 
 ## Contributor License Agreement
 
-Contributions to this project must be accompanied by a Contributor License
-Agreement. You (or your employer) retain the copyright to your contribution;
-this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
-your current agreements on file or to sign a new one.
+Contributions to this project must be accompanied by a Contributor License Agreement. You (or your
+employer) retain the copyright to your contribution; this simply gives us permission to use and
+redistribute your contributions as part of the project. Head over to
+<https://cla.developers.google.com/> to see your current agreements on file or to sign a new one.
 
-You generally only need to submit a CLA once, so if you've already submitted one
-(even if it was for a different project), you probably don't need to do it
-again.
+You generally only need to submit a CLA once, so if you've already submitted one (even if it was for
+a different project), you probably don't need to do it again.
 
 ## Code reviews
 
-All submissions, including submissions by project members, require review. We
-use GitHub pull requests for this purpose. Consult
-[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
-information on using pull requests.
+All submissions, including submissions by project members, require review. We use GitHub pull
+requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using
+pull requests.
 
 ## Community Guidelines
 
@@ -29,5 +27,6 @@ This project follows
 
 ## Contributor Documentation
 
-To know more about how to setup your environment, how Firebase internals work, and
-best practices, take a look at our detailed [contributor documentation](https://firebase.github.io/firebase-android-sdk/).
+To know more about how to setup your environment, how Firebase internals work, and best practices,
+take a look at our detailed
+[contributor documentation](https://firebase.github.io/firebase-android-sdk/).

README.md

@@ -1,11 +1,9 @@
 # Firebase Android Open Source Development
 
-This repository contains the source code for all Android Firebase SDKs except
-Analytics and Auth.
+This repository contains the source code for all Android Firebase SDKs except Analytics and Auth.
 
-Firebase is an app development platform with tools to help you build, grow and
-monetize your app. More information about Firebase can be found at
-https://firebase.google.com.
+Firebase is an app development platform with tools to help you build, grow and monetize your app.
+More information about Firebase can be found at https://firebase.google.com.
 
 ## Table of contents
 
@@ -15,10 +13,8 @@ https://firebase.google.com.
    1. [Integration Testing](#integration-testing)
 1. [Proguarding](#proguarding)
    1. [APIs used via reflection](#APIs-used-via-reflection)
-   1. [APIs intended for developer
-   consumption](#APIs-intended-for-developer-consumption)
-   1. [APIs intended for other Firebase
-   SDKs](#APIs-intended-for-other-firebase-sdks)
+   1. [APIs intended for developer consumption](#APIs-intended-for-developer-consumption)
+   1. [APIs intended for other Firebase SDKs](#APIs-intended-for-other-firebase-sdks)
 1. [Publishing](#publishing)
    1. [Dependencies](#dependencies)
    1. [Commands](#commands)
@@ -27,23 +23,22 @@ https://firebase.google.com.
 
 ## Getting Started
 
-* Install the latest Android Studio (should be Meerkat | 2024.3.1 or later)
-* Clone the repo (`git clone --recurse-submodules [email protected]:firebase/firebase-android-sdk.git`)
-    * When cloning the repo, it is important to get the submodules as well. If
-    you have already cloned the repo without the submodules, you can update the
-    submodules by running `git submodule update --init --recursive`.
-* Import the firebase-android-sdk gradle project into Android Studio using the
-  **Import project(Gradle, Eclipse ADT, etc.)** option.
-* `firebase-crashlytics-ndk` must be built with NDK 21. See
-  [firebase-crashlytics-ndk](firebase-crashlytics-ndk/README.md) for more
-  details.
+- Install the latest Android Studio (should be Meerkat | 2024.3.1 or later)
+- Clone the repo (`git clone --recurse-submodules [email protected]:firebase/firebase-android-sdk.git`)
+  - When cloning the repo, it is important to get the submodules as well. If you have already cloned
+    the repo without the submodules, you can update the submodules by running
+    `git submodule update --init --recursive`.
+- Import the firebase-android-sdk gradle project into Android Studio using the **Import
+  project(Gradle, Eclipse ADT, etc.)** option.
+- `firebase-crashlytics-ndk` must be built with NDK 21. See
+  [firebase-crashlytics-ndk](firebase-crashlytics-ndk/README.md) for more details.
 
 ## Testing
 
 Firebase Android libraries exercise all three types of tests recommended by the
 [Android Testing Pyramid](https://developer.android.com/training/testing/fundamentals#testing-pyramid).
-Depending on the requirements of the specific project, some or all of these
-tests may be used to support changes.
+Depending on the requirements of the specific project, some or all of these tests may be used to
+support changes.
 
 > :warning: **Running tests with errorprone**
 >
@@ -53,48 +48,46 @@ tests may be used to support changes.
 
 ### Unit Testing
 
-These are tests that run on your machine's local Java Virtual Machine (JVM). At
-runtime, these tests are executed against a modified version of android.jar
-where all final modifiers have been stripped off. This lets us sandbox behaviors
-at desired places and use popular mocking libraries.
+These are tests that run on your machine's local Java Virtual Machine (JVM). At runtime, these tests
+are executed against a modified version of android.jar where all final modifiers have been stripped
+off. This lets us sandbox behaviors at desired places and use popular mocking libraries.
 
 Unit tests can be executed on the command line by running
+
 ```bash
 ./gradlew :<firebase-project>:check
 ```
 
 ### Integration Testing
 
-These are tests that run on a hardware device or emulator. These tests have
-access to Instrumentation APIs, give you access to information such as the
-[Android Context](https://developer.android.com/reference/android/content/Context).
-In Firebase, instrumentation tests are used at different capacities by different
-projects. Some tests may exercise device capabilities, while stubbing any calls
-to the backend, while some others may call out to nightly backend builds to
-ensure distributed API compatibility.
+These are tests that run on a hardware device or emulator. These tests have access to
+Instrumentation APIs, give you access to information such as the
+[Android Context](https://developer.android.com/reference/android/content/Context). In Firebase,
+instrumentation tests are used at different capacities by different projects. Some tests may
+exercise device capabilities, while stubbing any calls to the backend, while some others may call
+out to nightly backend builds to ensure distributed API compatibility.
 
-Along with Espresso, they are also used to test projects that have UI
-components.
+Along with Espresso, they are also used to test projects that have UI components.
 
 #### Project Setup
 
-Before you can run integration tests, you need to add a `google-services.json`
-file to the root of your checkout. You can use the `google-services.json` from
-any project that includes an Android App, though you'll likely want one that's
-separate from any production data you have because our tests write random data.
+Before you can run integration tests, you need to add a `google-services.json` file to the root of
+your checkout. You can use the `google-services.json` from any project that includes an Android App,
+though you'll likely want one that's separate from any production data you have because our tests
+write random data.
 
 If you don't have a suitable testing project already:
 
-  * Open the [Firebase console](https://console.firebase.google.com/)
-  * If you don't yet have a project you want to use for testing, create one.
-  * Add an Android app to the project
-  * Give the app any package name you like.
-  * Download the resulting `google-services.json` file and put it in the root of
-    your checkout.
+- Open the [Firebase console](https://console.firebase.google.com/)
+- If you don't yet have a project you want to use for testing, create one.
+- Add an Android app to the project
+- Give the app any package name you like.
+- Download the resulting `google-services.json` file and put it in the root of your checkout.
 
 #### Running Integration Tests on Local Emulator
 
 Integration tests can be executed on the command line by running
+
 ```bash
 ./gradlew :<firebase-project>:connectedCheck
 ```
@@ -103,11 +96,12 @@ Integration tests can be executed on the command line by running
 
 > You need additional setup for this to work:
 >
-> * `gcloud` needs to be [installed](https://cloud.google.com/sdk/install) on local machine
-> * `gcloud` needs to be configured with a project that has billing enabled
-> * `gcloud` needs to be authenticated with credentials that have 'Firebase Test Lab Admin' role
+> - `gcloud` needs to be [installed](https://cloud.google.com/sdk/install) on local machine
+> - `gcloud` needs to be configured with a project that has billing enabled
+> - `gcloud` needs to be authenticated with credentials that have 'Firebase Test Lab Admin' role
 
 Integration tests can be executed on the command line by running
+
 ```bash
 ./gradlew :<firebase-project>:deviceCheck
 ```
@@ -134,92 +128,84 @@ Firebase SDKs use some special annotations for tooling purposes.
 ### @Keep
 
 APIs that need to be preserved up until the app's runtime can be annotated with
-[@Keep](https://developer.android.com/reference/android/support/annotation/Keep).
-The
-[@Keep](https://developer.android.com/reference/android/support/annotation/Keep)
-annotation is *blessed* to be honored by android's [default proguard
-configuration](https://developer.android.com/studio/write/annotations#keep).  A common use for
-this annotation is because of reflection. These APIs should be generally **discouraged**, because
-they can't be proguarded.
+[@Keep](https://developer.android.com/reference/android/support/annotation/Keep). The
+[@Keep](https://developer.android.com/reference/android/support/annotation/Keep) annotation is
+_blessed_ to be honored by android's
+[default proguard configuration](https://developer.android.com/studio/write/annotations#keep). A
+common use for this annotation is because of reflection. These APIs should be generally
+**discouraged**, because they can't be proguarded.
 
 ### @KeepForSdk
 
-APIs that are intended to be used by Firebase SDKs should be annotated with
-`@KeepForSdk`. The key benefit here is that the annotation is *blessed* to throw
-linter errors on Android Studio if used by the developer from a non firebase
-package, thereby providing a valuable guard rail.
-
+APIs that are intended to be used by Firebase SDKs should be annotated with `@KeepForSdk`. The key
+benefit here is that the annotation is _blessed_ to throw linter errors on Android Studio if used by
+the developer from a non firebase package, thereby providing a valuable guard rail.
 
 ### @PublicApi
 
 We annotate APIs that meant to be used by developers with
-[@PublicAPI](firebase-common/src/main/java/com/google/firebase/annotations/PublicApi.java).   This
+[@PublicAPI](firebase-common/src/main/java/com/google/firebase/annotations/PublicApi.java). This
 annotation will be used by tooling to help inform the version bump (major, minor, patch) that is
 required for the next release.
 
 ## Proguarding
 
-Firebase SDKs do not proguard themselves, but support proguarding.   Firebase SDKs themselves are
+Firebase SDKs do not proguard themselves, but support proguarding. Firebase SDKs themselves are
 proguard friendly, but the dependencies of Firebase SDKs may not be.
 
 ### Proguard config
 
-In addition to preguard.txt, projects declare an additional set of proguard
-rules in a proguard.txt that are honored by the developer's app while building
-the app's proguarded apk. This file typically contains the keep rules that need
-to be honored during the app' s proguarding phase.
+In addition to preguard.txt, projects declare an additional set of proguard rules in a proguard.txt
+that are honored by the developer's app while building the app's proguarded apk. This file typically
+contains the keep rules that need to be honored during the app' s proguarding phase.
 
-As a best practice, these explicit rules should be scoped to only libraries
-whose source code is outside the firebase-android-sdk codebase making annotation
-based approaches insufficient.The combination of keep rules resulting from the
-annotations, the preguard.txt and the proguard.txt collectively determine the
-APIs that are preserved at **runtime**.
+As a best practice, these explicit rules should be scoped to only libraries whose source code is
+outside the firebase-android-sdk codebase making annotation based approaches insufficient.The
+combination of keep rules resulting from the annotations, the preguard.txt and the proguard.txt
+collectively determine the APIs that are preserved at **runtime**.
 
 ## Publishing
 
-Firebase is published as a collection of libraries each of which either
-represents a top level product, or contains shared functionality used by one or
-more projects. The projects are published as managed maven artifacts available
-at [Google's Maven Repository](https://maven.google.com). This section helps
-reason about how developers may make changes to firebase projects and have their
-apps depend on the modified versions of Firebase.
+Firebase is published as a collection of libraries each of which either represents a top level
+product, or contains shared functionality used by one or more projects. The projects are published
+as managed maven artifacts available at [Google's Maven Repository](https://maven.google.com). This
+section helps reason about how developers may make changes to firebase projects and have their apps
+depend on the modified versions of Firebase.
 
 ### Dependencies
 
 Any dependencies, within the projects, or outside of Firebase are encoded as
 [maven dependencies](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html)
-into the `pom` file that accompanies the published artifact. This allows the
-developer's build system (typically Gradle) to build a dependency graph and
-select the dependencies using its own [resolution
-strategy](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.ResolutionStrategy.html)
+into the `pom` file that accompanies the published artifact. This allows the developer's build
+system (typically Gradle) to build a dependency graph and select the dependencies using its own
+[resolution strategy](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.ResolutionStrategy.html)
 
 ### Commands
 
-For more advanced use cases where developers wish to make changes to a project,
-but have transitive dependencies point to publicly released versions, individual
-projects may be published as follows.
+For more advanced use cases where developers wish to make changes to a project, but have transitive
+dependencies point to publicly released versions, individual projects may be published as follows.
 
 ```bash
 # e.g. to publish Firestore and Functions
 ./gradlew -PprojectsToPublish="firebase-firestore,firebase-functions" \
     publishReleasingLibrariesToMavenLocal
 ```
 
-Developers may take a dependency on these locally published versions by adding
-the `mavenLocal()` repository to your [repositories
-block](https://docs.gradle.org/current/userguide/declaring_repositories.html) in
-your app module's build.gradle.
+Developers may take a dependency on these locally published versions by adding the `mavenLocal()`
+repository to your
+[repositories block](https://docs.gradle.org/current/userguide/declaring_repositories.html) in your
+app module's build.gradle.
 
 ### Code Formatting
 
 Java and Kotlin are both formatted using `spotless`.
 
 To run formatting on a project, run
+
 ```bash
 ./gradlew :<firebase-project>:spotlessApply
 ```
 
 ### Contributing
 
-We love contributions! Please read our
-[contribution guidelines](/CONTRIBUTING.md) to get started.
+We love contributions! Please read our [contribution guidelines](/CONTRIBUTING.md) to get started.

build.gradle.kts

@@ -60,6 +60,10 @@ fun Project.applySpotless() {
       target("*.gradle.kts") // default target for kotlinGradle
       ktfmt("0.41").googleStyle()
     }
+    format("styling") {
+      target("*.md")
+      prettier().config(mapOf("printWidth" to 100, "proseWrap" to "always"))
+    }
   }
 }