Skip to content

Commit c8aec5d

Browse files
Anmol202005romani
Anmol202005
authored and
romani
committed
Updated Readme
1 parent e016d18 commit c8aec5d

File tree

1 file changed

+64
-12
lines changed

1 file changed

+64
-12
lines changed

‎README.md‎

Lines changed: 64 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -78,29 +78,81 @@ This table tracks the auto-fix support status of OpenRewrite recipes for each Ch
7878
|--------|------------------------------------------------------------------------------------------------------------------------------|------------------|----------------|
7979
| 🟢 | [`AnnotationLocation`](https://checkstyle.sourceforge.io/checks/annotation/annotationlocation.html#AnnotationLocation) | `TBD` | |
8080
| 🟢 | [`AnnotationOnSameLine`](https://checkstyle.sourceforge.io/checks/annotation/annotationonsameline.html#AnnotationOnSameLine) | `TBD` | |
81+
| 🔴 | [`AnnotationUseStyle`](https://checkstyle.sourceforge.io/checks/annotation/annotationusestyle.html#AnnotationUseStyle) | `TBD` | Standardize annotation syntax |
82+
| 🟢 | [`MissingDeprecated`](https://checkstyle.sourceforge.io/checks/annotation/missingdeprecated.html#MissingDeprecated) | `TBD` | |
83+
| 🟢 | [`MissingOverride`](https://checkstyle.sourceforge.io/checks/annotation/missingoverride.html#MissingOverride) | `TBD` | |
84+
| 🟢 | [`PackageAnnotation`](https://checkstyle.sourceforge.io/checks/annotation/packageannotation.html#PackageAnnotation) | `TBD` | |
85+
| 🔴 | [`SuppressWarnings`](https://checkstyle.sourceforge.io/checks/annotation/suppresswarnings.html#SuppressWarnings) | `TBD` | Remove inappropriate suppressions |
8186

8287
### Block Checks
8388

84-
_No checks analyzed yet_
89+
| Status | Check | Recipe | Coverage Notes |
90+
|--------|------------------------------------------------------------------------------------------------------------------------------|------------------|----------------|
91+
| 🔴 | [`AvoidNestedBlocks`](https://checkstyle.sourceforge.io/checks/blocks/avoidnestedblocks.html#AvoidNestedBlocks) | `TBD` | Requires code restructuring |
92+
| 🟢 | [`EmptyBlock`](https://checkstyle.sourceforge.io/checks/blocks/emptyblock.html#EmptyBlock) | `TBD` | |
93+
| 🟢 | [`EmptyCatchBlock`](https://checkstyle.sourceforge.io/checks/blocks/emptycatchblock.html#EmptyCatchBlock) | `TBD` | |
94+
| 🟢 | [`LeftCurly`](https://checkstyle.sourceforge.io/checks/blocks/leftcurly.html#LeftCurly) | `TBD` | |
95+
| 🟢 | [`NeedBraces`](https://checkstyle.sourceforge.io/checks/blocks/needbraces.html#NeedBraces) | `TBD` | |
96+
| 🟢 | [`RightCurly`](https://checkstyle.sourceforge.io/checks/blocks/rightcurly.html#RightCurly) | `TBD` | |
8597

8698

8799
### Class Design
88100

89-
| Status | Check | Recipe | Coverage Notes |
90-
|--------|--------------------------------------------------------------------------------------------|------------------|----------------|
91-
| 🟢 | [`FinalClass`](https://checkstyle.sourceforge.io/checks/design/finalclass.html#FinalClass) | `TBD` | |
92-
101+
| Status | Check | Recipe | Coverage Notes |
102+
|--------|------------------------------------------------------------------------------------------------------------------------------|------------------|----------------|
103+
| 🔴 | [`DesignForExtension`](https://checkstyle.sourceforge.io/checks/design/designforextension.html#DesignForExtension) | `TBD` | Requires design decisions (final/abstract) |
104+
| 🟢 | [`FinalClass`](https://checkstyle.sourceforge.io/checks/design/finalclass.html#FinalClass) | `TBD` | |
105+
| 🟢 | [`HideUtilityClassConstructor`](https://checkstyle.sourceforge.io/checks/design/hideutilityclassconstructor.html#HideUtilityClassConstructor) | `TBD` | |
106+
| 🟢 | [`InnerTypeLast`](https://checkstyle.sourceforge.io/checks/design/innertypelast.html#InnerTypeLast) | `TBD` | |
107+
| 🔴 | [`InterfaceIsType`](https://checkstyle.sourceforge.io/checks/design/interfaceistype.html#InterfaceIsType) | `TBD` | Remove non-type interface members |
108+
| 🔴 | [`MutableException`](https://checkstyle.sourceforge.io/checks/design/mutableexception.html#MutableException) | `TBD` | Make exception fields final |
109+
| 🔴 | [`OneTopLevelClass`](https://checkstyle.sourceforge.io/checks/design/onetoplevelclass.html#OneTopLevelClass) | `TBD` | Split into separate files |
110+
| 🟢 | [`SealedShouldHavePermitsList`](https://checkstyle.sourceforge.io/checks/design/sealedshoulddhavepermitslist.html#SealedShouldHavePermitsList) | `TBD` | |
111+
| 🔴 | [`ThrowsCount`](https://checkstyle.sourceforge.io/checks/design/throwscount.html#ThrowsCount) | `TBD` | Reduce throws declarations |
112+
| 🔴 | [`VisibilityModifier`](https://checkstyle.sourceforge.io/checks/design/visibilitymodifier.html#VisibilityModifier) | `TBD` | Change visibility modifiers |
93113

94114

95115
### Coding
96116

97-
| Status | Check | Recipe | Coverage Notes |
98-
|--------|----------------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------|
99-
| 🟢 | [`FinalLocalVariable`](https://checkstyle.sourceforge.io/checks/coding/finallocalvariable.html#FinalLocalVariable) | `TBD` | |
100-
| 🔴 | [`MagicNumber`](https://checkstyle.sourceforge.io/checks/coding/magicnumber.html#MagicNumber) | | it requires contextual understanding to replace literals with meaningful named constants |
101-
| 🟢 | [`UnusedLocalVariable `](https://checkstyle.sourceforge.io/checks/coding/unusedlocalvariable.html#UnusedLocalVariable) | `TBD` | |
102-
| 🟢 | [`UnnecessaryParentheses `](https://checkstyle.sourceforge.io/checks/coding/unnecessaryparentheses.html#UnnecessaryParentheses) | `TBD` | |
103-
117+
| Status | Check | Recipe | Coverage Notes |
118+
|--------|------------------------------------------------------------------------------------------------------------------------------|------------------|----------------|
119+
| 🟢 | [`ArrayTrailingComma`](https://checkstyle.sourceforge.io/checks/coding/arraytrailingcomma.html#ArrayTrailingComma) | `TBD` | |
120+
| 🔴 | [`AvoidDoubleBraceInitialization`](https://checkstyle.sourceforge.io/checks/coding/avoiddoublebraceinitialization.html#AvoidDoubleBraceInitialization) | `TBD` | Requires refactoring initialization logic |
121+
| 🔴 | [`AvoidInlineConditionals`](https://checkstyle.sourceforge.io/checks/coding/avoidinlineconditionals.html#AvoidInlineConditionals) | `TBD` | Requires extracting to if-else statements |
122+
| 🟢 | [`AvoidNoArgumentSuperConstructorCall`](https://checkstyle.sourceforge.io/checks/coding/avoidnoargumentsuperconstructorcall.html#AvoidNoArgumentSuperConstructorCall) | `TBD` | |
123+
| 🟢 | [`ConstructorsDeclarationGrouping`](https://checkstyle.sourceforge.io/checks/coding/constructorsdeclarationgrouping.html#ConstructorsDeclarationGrouping) | `TBD` | |
124+
| 🔴 | [`CovariantEquals`](https://checkstyle.sourceforge.io/checks/coding/covariantequals.html#CovariantEquals) | `TBD` | Requires implementing proper equals(Object) |
125+
| 🟢 | [`DeclarationOrder`](https://checkstyle.sourceforge.io/checks/coding/declarationorder.html#DeclarationOrder) | `TBD` | |
126+
| 🟢 | [`DefaultComesLast`](https://checkstyle.sourceforge.io/checks/coding/defaultcomeslast.html#DefaultComesLast) | `TBD` | |
127+
| 🟢 | [`EmptyStatement`](https://checkstyle.sourceforge.io/checks/coding/emptystatement.html#EmptyStatement) | `TBD` | |
128+
| 🟢 | [`EqualsAvoidNull`](https://checkstyle.sourceforge.io/checks/coding/equalsavoidnull.html#EqualsAvoidNull) | `TBD` | |
129+
| 🔴 | [`EqualsHashCode`](https://checkstyle.sourceforge.io/checks/coding/equalshashcode.html#EqualsHashCode) | `TBD` | Implement proper equals/hashCode pair |
130+
| 🟢 | [`ExplicitInitialization`](https://checkstyle.sourceforge.io/checks/coding/explicitinitialization.html#ExplicitInitialization) | `TBD` | |
131+
| 🔴 | [`FallThrough`](https://checkstyle.sourceforge.io/checks/coding/fallthrough.html#FallThrough) | `TBD` | Add break statements or intentional comments |
132+
| 🟢 | [`FinalLocalVariable`](https://checkstyle.sourceforge.io/checks/coding/finallocalvariable.html#FinalLocalVariable) | `TBD` | |
133+
| 🔴 | [`HiddenField`](https://checkstyle.sourceforge.io/checks/coding/hiddenfield.html#HiddenField) | `TBD` | Rename variables or use this. prefix |
134+
| 🔴 | [`IllegalCatch`](https://checkstyle.sourceforge.io/checks/coding/illegalcatch.html#IllegalCatch) | `TBD` | Change catch block exception types |
135+
| 🔴 | [`IllegalInstantiation`](https://checkstyle.sourceforge.io/checks/coding/illegalinstantiation.html#IllegalInstantiation) | `TBD` | Replace with factory methods |
136+
| 🔴 | [`IllegalThrows`](https://checkstyle.sourceforge.io/checks/coding/illegalthrows.html#IllegalThrows) | `TBD` | Change throws declarations |
137+
| 🔴 | [`IllegalToken`](https://checkstyle.sourceforge.io/checks/coding/illegaltoken.html#IllegalToken) | `TBD` | Replace illegal tokens |
138+
| 🔴 | [`IllegalTokenText`](https://checkstyle.sourceforge.io/checks/coding/illegaltokentext.html#IllegalTokenText) | `TBD` | Change token text |
139+
| 🔴 | [`IllegalType`](https://checkstyle.sourceforge.io/checks/coding/illegaltype.html#IllegalType) | `TBD` | Replace with allowed types |
140+
| 🔴 | [`InnerAssignment`](https://checkstyle.sourceforge.io/checks/coding/innerassignment.html#InnerAssignment) | `TBD` | Extract assignments to separate statements |
141+
| 🔴 | [`MagicNumber`](https://checkstyle.sourceforge.io/checks/coding/magicnumber.html#MagicNumber) | `TBD` | Extract to named constants |
142+
| 🔴 | [`MatchXpath`](https://checkstyle.sourceforge.io/checks/coding/matchxpath.html#MatchXpath) | `TBD` | Context-dependent XPath violations |
143+
| 🔴 | [`MissingCtor`](https://checkstyle.sourceforge.io/checks/coding/missingctor.html#MissingCtor) | `TBD` | Add explicit constructor |
144+
| 🟢 | [`MissingNullCaseInSwitch`](https://checkstyle.sourceforge.io/checks/coding/missingnullcaseinswitch.html#MissingNullCaseInSwitch) | `TBD` | |
145+
| 🟢 | [`MissingSwitchDefault`](https://checkstyle.sourceforge.io/checks/coding/missingswitchdefault.html#MissingSwitchDefault) | `TBD` | |
146+
| 🔴 | [`ModifiedControlVariable`](https://checkstyle.sourceforge.io/checks/coding/modifiedcontrolvariable.html#ModifiedControlVariable) | `TBD` | Restructure loop logic |
147+
| 🔴 | [`MultipleStringLiterals`](https://checkstyle.sourceforge.io/checks/coding/multiplestringliterals.html#MultipleStringLiterals) | `TBD` | Extract to constants |
148+
| 🟢 | [`MultipleVariableDeclarations`](https://checkstyle.sourceforge.io/checks/coding/multiplevariabledeclarations.html#MultipleVariableDeclarations) | `TBD` | |
149+
| 🔴 | [`NestedForDepth`](https://checkstyle.sourceforge.io/checks/coding/nestedfordepth.html#NestedForDepth) | `TBD` | Requires loop restructuring |
150+
| 🔴 | [`NestedIfDepth`](https://checkstyle.sourceforge.io/checks/coding/nestedifdepth.html#NestedIfDepth) | `TBD` | Requires conditional restructuring |
151+
| 🔴 | [`NestedTryDepth`](https://checkstyle.sourceforge.io/checks/coding/nestedtrydepth.html#NestedTryDepth) | `TBD` | Requires exception handling restructuring |
152+
| 🟢 | [`NoArrayTrailingComma`](https://checkstyle.sourceforge.io/checks/coding/noarraytrailingcomma.html#NoArrayTrailingComma) | `TBD` | |
153+
| 🔴 | [`NoClone`](https://checkstyle.sourceforge.io/checks/coding/noclone.html#NoClone) | `TBD` | Remove clone() method |
154+
| 🟢 | [`NoEnumTrailingComma`](https://checkstyle.sourceforge.io/checks/coding/noenumtrailingcomma.html#NoEnumTrailingComma) | `TBD` | |
155+
| 🔴 | [`NoFinalizer`](https://checkstyle.sourceforge.io/checks/coding/nofinalizer.html#NoFinalizer)
104156

105157

106158
### Headers

0 commit comments

Comments
 (0)