GROOVY-12039: Graduate RegexChecker and FormatStringChecker from incu…#2564
Open
paulk-asert wants to merge 1 commit into
Open
GROOVY-12039: Graduate RegexChecker and FormatStringChecker from incu…#2564paulk-asert wants to merge 1 commit into
paulk-asert wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Groovy typecheckers module documentation and annotations to reflect RegexChecker and FormatStringChecker graduating from incubating to stable, and expands the catalog of bundled auxiliary type checkers with monadic checker entries and cross-references.
Changes:
- Mark
RegexCheckerandFormatStringCheckeras stable by removing@Incubatingand documenting their@sinceversions. - Improve docs/navigation by adding anchors and cross-references between the “built-in checkers” chapter and the “type checking extensions” SDK chapter.
- Document
MonadicChecker/MonadicShapeCheckerin the bundled-checkers overview and related monadic comprehensions chapter.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| subprojects/groovy-typecheckers/src/spec/doc/typecheckers.adoc | Adds chapter anchor, stability notes for regex/format checkers, and documents monadic checkers. |
| subprojects/groovy-typecheckers/src/main/groovy/groovy/typecheckers/RegexChecker.groovy | Removes @Incubating and adds @since 4.0.0 to class GroovyDoc. |
| subprojects/groovy-typecheckers/src/main/groovy/groovy/typecheckers/FormatStringChecker.groovy | Removes @Incubating and adds @since 5.0.0 to class GroovyDoc. |
| subprojects/groovy-typecheckers/src/main/groovy/groovy/typecheckers/FormatMethod.groovy | Adds @since 5.0.0 to annotation GroovyDoc. |
| subprojects/groovy-typecheckers/src/main/groovy/groovy/typecheckers/MonadicChecker.groovy | Marks MonadicChecker as incubating (annotation/import adjustments). |
| subprojects/groovy-typecheckers/src/main/groovy/groovy/typecheckers/package-info.groovy | Refreshes package-level docs, categorizing stable vs incubating checkers. |
| subprojects/groovy-macro-library/src/spec/doc/_monadic-comprehensions.adoc | Adds documentation for MonadicShapeChecker and links back to the bundled checkers chapter. |
| src/spec/doc/_type-checking-extensions.adoc | Adds anchor and a tip block clarifying this chapter is the SDK reference and linking to bundled checkers. |
| * {@code @Nullable} / {@code @NonNull} / {@code @MonotonicNonNull} annotations, | ||
| * with an optional strict flow-sensitive mode</li> | ||
| * <li>{@link groovy.typecheckers.ModifiesChecker} – verifies method bodies | ||
| * comply with their {@code groovy.contracts.@Modifies} frame conditions</li> |
| @@ -61,6 +62,7 @@ import static org.objectweb.asm.Opcodes.ACC_BRIDGE | |||
| * | |||
| * Activate with {@code @CompileStatic(extensions='groovy.typecheckers.MonadicChecker')}. | |||
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2564 +/- ##
==================================================
+ Coverage 68.1904% 68.1984% +0.0079%
- Complexity 33103 33106 +3
==================================================
Files 1508 1508
Lines 126157 126157
Branches 22891 22891
==================================================
+ Hits 86027 86037 +10
+ Misses 32490 32481 -9
+ Partials 7640 7639 -1
🚀 New features to boost your workflow:
|
|
✅ All tests passed ✅🏷️ Commit: 1050e7e Learn more about TestLens at testlens.app. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…bating to stable