Skip to content

Commit d884e44

Browse files
committed
Replace prettier with Flexmark as the markdown formatter
1 parent 6587ff3 commit d884e44

File tree

4 files changed

+44
-48
lines changed

4 files changed

+44
-48
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ More information about Firebase can be found at https://firebase.google.com.
88
## Table of contents
99

1010
1. [Getting Started](#getting-started)
11-
1. [Testing](#testing)
11+
2. [Testing](#testing)
1212
1. [Unit Testing](#unit-testing)
13-
1. [Integration Testing](#integration-testing)
14-
1. [Proguarding](#proguarding)
13+
2. [Integration Testing](#integration-testing)
14+
3. [Proguarding](#proguarding)
1515
1. [APIs used via reflection](#APIs-used-via-reflection)
16-
1. [APIs intended for developer consumption](#APIs-intended-for-developer-consumption)
17-
1. [APIs intended for other Firebase SDKs](#APIs-intended-for-other-firebase-sdks)
18-
1. [Publishing](#publishing)
16+
2. [APIs intended for developer consumption](#APIs-intended-for-developer-consumption)
17+
3. [APIs intended for other Firebase SDKs](#APIs-intended-for-other-firebase-sdks)
18+
4. [Publishing](#publishing)
1919
1. [Dependencies](#dependencies)
20-
1. [Commands](#commands)
21-
1. [Code Formatting](#code-formatting)
22-
1. [Contributing](#contributing)
20+
2. [Commands](#commands)
21+
5. [Code Formatting](#code-formatting)
22+
6. [Contributing](#contributing)
2323

2424
## Getting Started
2525

agents.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -28,43 +28,36 @@ This file is useful for understanding the role of each subproject in the reposit
2828
To work with this repository, the Android SDK must be installed. Use the `sdkmanager` command-line
2929
tool for this purpose.
3030

31-
1. **Install Android SDK Command-Line Tools**:
32-
33-
- If not already installed, download the command-line tools from the
34-
[Android Studio page](https://developer.android.com/studio#command-line-tools-only).
35-
- Create a directory for the Android SDK, e.g., `android_sdk`.
36-
- Unzip the downloaded package. This will create a `cmdline-tools` directory. Move this
37-
directory to `android_sdk/cmdline-tools/latest`.
38-
- The final structure should be `android_sdk/cmdline-tools/latest/`.
39-
40-
2. **Install required SDK packages**:
41-
42-
- Use `sdkmanager` to install the necessary platforms, build tools, and other packages. For
43-
example:
44-
45-
```bash
46-
# List all available packages
47-
sdkmanager --list
48-
49-
# Install platform tools and the SDK for API level 33
50-
sdkmanager "platform-tools" "platforms;android-33"
51-
52-
# Accept all licenses
53-
yes | sdkmanager --licenses
54-
```
55-
56-
- Refer to the specific requirements of the project to determine which packages to install.
57-
58-
3. **Configure for integration tests**:
59-
60-
- To run integration tests, a `google-services.json` file is required.
61-
- Place this file in the root of the repository.
62-
63-
4. **Install NDK for specific projects**:
64-
- Some projects, like `firebase-crashlytics-ndk`, require a specific version of the Android NDK.
65-
You can install it using `sdkmanager`. For example, to install NDK version 21.4.7075529, you
66-
would run `sdkmanager "ndk;21.4.7075529"`. Always refer to the project's `README.md` for the
67-
exact version required.
31+
1. **Install Android SDK Command-Line Tools**:
32+
- If not already installed, download the command-line tools from the
33+
[Android Studio page](https://developer.android.com/studio#command-line-tools-only).
34+
- Create a directory for the Android SDK, e.g., `android_sdk`.
35+
- Unzip the downloaded package. This will create a `cmdline-tools` directory. Move this
36+
directory to `android_sdk/cmdline-tools/latest`.
37+
- The final structure should be `android_sdk/cmdline-tools/latest/`.
38+
2. **Install required SDK packages**:
39+
- Use `sdkmanager` to install the necessary platforms, build tools, and other packages. For
40+
example:
41+
42+
```bash
43+
# List all available packages
44+
sdkmanager --list
45+
46+
# Install platform tools and the SDK for API level 33
47+
sdkmanager "platform-tools" "platforms;android-33"
48+
49+
# Accept all licenses
50+
yes | sdkmanager --licenses
51+
```
52+
- Refer to the specific requirements of the project to determine which packages to install.
53+
3. **Configure for integration tests**:
54+
- To run integration tests, a `google-services.json` file is required.
55+
- Place this file in the root of the repository.
56+
4. **Install NDK for specific projects**:
57+
- Some projects, like `firebase-crashlytics-ndk`, require a specific version of the Android NDK.
58+
You can install it using `sdkmanager`. For example, to install NDK version 21.4.7075529, you
59+
would run `sdkmanager "ndk;21.4.7075529"`. Always refer to the project's `README.md` for the
60+
exact version required.
6861
6962
## Building and Running
7063
@@ -182,10 +175,12 @@ started.
182175
After you make a change, here's the flow you should follow:
183176

184177
- Format the code using `spotless`. It can be run with:
178+
185179
```bash
186180
./gradlew :<firebase-project>:spotlessApply
187181
```
188182
- Run unit tests:
183+
189184
```bash
190185
./gradlew :<firebase-project>:check
191186
```

build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ fun Project.applySpotless() {
6161
target("*.gradle.kts") // default target for kotlinGradle
6262
ktfmt("0.41").googleStyle()
6363
}
64-
format("styling") {
64+
flexmark {
6565
target("src/**/*.md", "*.md", "docs/**/*.md")
6666
targetExclude("**/third_party/**", "src/test/resources/**", "release_report.md")
67-
prettier("3.6.2").config(mapOf("printWidth" to 100, "proseWrap" to "always"))
67+
flexmark("0.64.8")
6868
}
6969
}
7070
}

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,4 @@ idiomatic Kotlin code when using Firebase in your app:
3535

3636
[android-setup]: https://firebase.google.com/docs/android/setup
3737
[main-readme]: https://github.com/firebase/firebase-android-sdk/blob/main/README.md
38+

0 commit comments

Comments
 (0)