Skip to content

Commit f777b19

Browse files
committed
Updated README.md
1 parent 8b71126 commit f777b19

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

README.md

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,96 @@
1-
# checkstyle-openrewrite-recipes
1+
# checkstyle-openrewrite-recipes
2+
## OpenRewrite Recipe Coverage for Checkstyle Checks
3+
4+
This table tracks the auto-fix support status of OpenRewrite recipes for each Checkstyle check. Organized by Checkstyle categories, it helps contributors identify which checks are:
5+
6+
### Status Legend
7+
8+
| Status | Meaning |
9+
|--------|------------------------------------------------------------------------------|
10+
| 🟢 | **Full Coverage** – Complete auto-fix capability for all violation scenarios |
11+
| 🟡 | **Partial Coverage** – Auto-fix available for some violation scenarios |
12+
| 🔴 | **Won't Be Covered** – Auto-fix not feasible or not planned |
13+
14+
---
15+
16+
### Annotations
17+
18+
_No checks analyzed yet_
19+
20+
---
21+
### Block Checks
22+
23+
_No checks analyzed yet_
24+
25+
---
26+
### Class Design
27+
28+
_No checks analyzed yet_
29+
30+
---
31+
### Coding
32+
33+
| Status | Check | Recipe | Coverage Notes |
34+
|--------|-----------------------|------------------|-----------------------------------------------------------------------------------------------|
35+
| 🟢 | `FinalLocalVariable` | `TBD` | Automatically makes eligible local variables `final` |
36+
| 🔴 | `MagicNumber` | `TBD` | it requires contextual understanding to replace literals with <br/>meaningful named constants |
37+
38+
---
39+
### Headers
40+
41+
| Status | Check | Recipe | Coverage Notes |
42+
|--------|---------------|------------------|-------------------------------------------------------------------------------------------------------------|
43+
| 🟢 | `Header` | `TBD` | Ensures the file contains the expected header comment block, replaces or inserts it if missing or incorrect |
44+
45+
---
46+
47+
### Imports
48+
49+
50+
| Status | Check | Recipe | Coverage Notes |
51+
|--------|-------------------|------------------|-------------------------------------------|
52+
| 🟢 | `RedundantImport` | `TBD` | Automatically removes `Redundant` imports |
53+
54+
---
55+
56+
### Javadoc Comments
57+
58+
_No checks analyzed yet_
59+
60+
---
61+
### Metrics
62+
63+
_No checks analyzed yet_
64+
65+
---
66+
### Miscellaneous
67+
68+
| Status | Check | Recipe | Coverage Notes |
69+
|--------|-----------------------|------------------|--------------------------------------------------------------------|
70+
| 🟢 | `UpperEll` | `UpperEll` | Replaces lowercase `l` suffix in long literals with uppercase `L` |
71+
72+
---
73+
### Modifiers
74+
75+
_No checks analyzed yet_
76+
77+
---
78+
### Naming Conventions
79+
80+
_No checks analyzed yet_
81+
82+
---
83+
### Regexp
84+
85+
_No checks analyzed yet_
86+
87+
---
88+
### Size Violations
89+
90+
_No checks analyzed yet_
91+
92+
---
93+
### Whitespace
94+
95+
_No checks analyzed yet_
96+

0 commit comments

Comments
 (0)