Update README with Kotlin Gradle DSL example #1347
Conversation
|
|
WalkthroughA Kotlin DSL Gradle snippet was added to the README demonstrating configuration of Error Prone and NullAway in Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2025-08-14T18:50:06.159ZApplied to files:
🪛 markdownlint-cli2 (0.18.1)README.md51-51: Trailing spaces (MD009, no-trailing-spaces) 🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-14T18:50:06.159Z
Learnt from: msridhar
Repo: uber/NullAway PR: 1245
File: guava-recent-unit-tests/src/test/java/com/uber/nullaway/guava/NullAwayGuavaParametricNullnessTests.java:101-102
Timestamp: 2025-08-14T18:50:06.159Z
Learning: In NullAway JSpecify tests, when JDK version requirements exist due to bytecode annotation reading capabilities, prefer failing tests over skipping them on unsupported versions to ensure CI catches regressions and enforces proper JDK version usage for developers.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
51-51: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
72-72: Trailing spaces
Expected: 0 or 2; Actual: 8
(MD009, no-trailing-spaces)
73-73: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
79-79: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
79-79: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
| } | ||
| ``` | ||
|
|
||
| or to `build.gradle.kts` if you use the [Kotlin Gradle DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html): |
There was a problem hiding this comment.
Remove trailing spaces and add blank line after code fence.
Markdown linting issues detected:
- Line 51: 1 trailing space
- Line 72: 8 trailing spaces
- Line 79: Missing blank line after closing code fence
Apply this diff to fix formatting:
-or to `build.gradle.kts` if you use the [Kotlin Gradle DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html):
+or to `build.gradle.kts` if you use the [Kotlin Gradle DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html):For line 72, remove the 8 trailing spaces within the code block, and add a blank line after line 79:
option("NullAway:AnnotatedPackages", "com.uber")
-
+
// Disable NullAway on test code }
Also applies to: 72-72, 79-79
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
51-51: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In README.md around lines 51, 72 and 79: remove the single trailing space at
line 51, remove the 8 trailing spaces inside the code block at line 72, and add
one blank line immediately after the closing code fence at line 79 so there is
an empty line following the code block; save the file and re-run markdown
linting to confirm the trailing spaces are gone and the blank line after the
code fence is present.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
README.md (3)
51-51: Remove trailing space.Line 51 has 1 trailing space after the colon, which violates markdown linting rules.
-or to `build.gradle.kts` if you use the [Kotlin Gradle DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html): +or to `build.gradle.kts` if you use the [Kotlin Gradle DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html):
72-72: Remove trailing spaces inside code block.Line 72 contains 8 trailing spaces on a blank line within the code block, which violates markdown linting rules.
option("NullAway:AnnotatedPackages", "com.uber") - + // Disable NullAway on test code
79-80: Add blank line after code fence.The closing code fence at line 79 should be followed by a blank line to comply with markdown linting rules (fenced code blocks should be surrounded by blank lines).
}
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: ASSERTIVE **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between ea6e7f59bc2ddcf00a5ecbd2c930ef4206a70f4b and 9e6f380028a7cba40d9fdcd568625db30b460cb2. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🧠 Learnings (2)</summary> <details> <summary>📓 Common learnings</summary>Learnt from: msridhar
Repo: uber/NullAway PR: 1245
File: guava-recent-unit-tests/src/test/java/com/uber/nullaway/guava/NullAwayGuavaParametricNullnessTests.java:101-102
Timestamp: 2025-08-14T18:50:06.159Z
Learning: In NullAway JSpecify tests, when JDK version requirements exist due to bytecode annotation reading capabilities, prefer failing tests over skipping them on unsupported versions to ensure CI catches regressions and enforces proper JDK version usage for developers.</details> <details> <summary>📚 Learning: 2025-08-14T18:50:06.159Z</summary>Learnt from: msridhar
Repo: uber/NullAway PR: 1245
File: guava-recent-unit-tests/src/test/java/com/uber/nullaway/guava/NullAwayGuavaParametricNullnessTests.java:101-102
Timestamp: 2025-08-14T18:50:06.159Z
Learning: In NullAway JSpecify tests, when JDK version requirements exist due to bytecode annotation reading capabilities, prefer failing tests over skipping them on unsupported versions to ensure CI catches regressions and enforces proper JDK version usage for developers.**Applied to files:** - `README.md` </details> </details><details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>README.md</summary> 51-51: Trailing spaces Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) --- 72-72: Trailing spaces Expected: 0 or 2; Actual: 8 (MD009, no-trailing-spaces) --- 73-73: Code block style Expected: fenced; Actual: indented (MD046, code-block-style) --- 79-79: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 79-79: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>README.md (1)</summary><blockquote> `54-78`: **Configuration looks good, package name is consistent.** The Kotlin DSL example correctly mirrors the Groovy DSL configuration with appropriate Kotlin syntax (`tasks.withType<JavaCompile>()`, `configureEach {}`, etc.), and the `AnnotatedPackages` configuration matches the Groovy example at line 40. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
msridhar
left a comment
msridhar
left a comment
There was a problem hiding this comment.
Looks great to me, thank you!
|
@sdelamo have you signed the CLA? We'll need that signature before we can merge this. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1347 +/- ##
=========================================
Coverage 88.39% 88.39%
Complexity 2592 2592
=========================================
Files 97 97
Lines 8702 8702
Branches 1732 1732
=========================================
Hits 7692 7692
Misses 505 505
Partials 505 505 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@sdelamo any update on the CLA? |
3 participants
This pull-request modifies the
README.mdfile to provide an example of the necessary Gradle configuration with the Kotlin DSL (the default DSL)Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.