|
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 | +- Fully supported via auto-fix |
| 7 | +- Partially supported |
| 8 | +- Not feasible to auto-fix |
| 9 | + |
| 10 | +### Status Legend |
| 11 | + |
| 12 | +| Status | Meaning | |
| 13 | +|--------|------------------------------------------------------------------------------| |
| 14 | +| 🟢 | **Full Coverage** – Complete auto-fix capability for all violation scenarios | |
| 15 | +| 🟡 | **Partial Coverage** – Auto-fix available for some violation scenarios | |
| 16 | +| 🔴 | **Won't Be Covered** – Auto-fix not feasible or not planned | |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +### Annotations |
| 21 | + |
| 22 | +_No checks analyzed yet_ |
| 23 | + |
| 24 | + |
| 25 | +### Block Checks |
| 26 | + |
| 27 | +_No checks analyzed yet_ |
| 28 | + |
| 29 | + |
| 30 | +### Class Design |
| 31 | + |
| 32 | +_No checks analyzed yet_ |
| 33 | + |
| 34 | + |
| 35 | +### Coding |
| 36 | + |
| 37 | +| Status | Check | Recipe | Coverage Notes | |
| 38 | +|--------|--------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------| |
| 39 | +| 🟢 | [`FinalLocalVariable`](https://checkstyle.sourceforge.io/checks/coding/finallocalvariable.html#FinalLocalVariable) | `TBD` | | |
| 40 | +| 🔴 | [`MagicNumber`](https://checkstyle.sourceforge.io/checks/coding/magicnumber.html#MagicNumber) | | it requires contextual understanding to replace literals with meaningful named constants | |
| 41 | + |
| 42 | + |
| 43 | +### Headers |
| 44 | + |
| 45 | +| Status | Check | Recipe | Coverage Notes | |
| 46 | +|--------|---------------------------------------------------------------------------------|------------------|----------------| |
| 47 | +| 🟢 | [`Header`](https://checkstyle.sourceforge.io/checks/header/header.html#Header ) | `TBD` | | |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +### Imports |
| 52 | + |
| 53 | + |
| 54 | +| Status | Check | Recipe | Coverage Notes | |
| 55 | +|--------|-------------------------------------------------------------------------------------------------------------|------------------|----------------| |
| 56 | +| 🟢 | [`RedundantImport`](https://checkstyle.sourceforge.io/checks/imports/redundantimport.html#RedundantImport ) | `TBD` | | |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +### Javadoc Comments |
| 61 | + |
| 62 | +_No checks analyzed yet_ |
| 63 | + |
| 64 | + |
| 65 | +### Metrics |
| 66 | + |
| 67 | +_No checks analyzed yet_ |
| 68 | + |
| 69 | + |
| 70 | +### Miscellaneous |
| 71 | + |
| 72 | +| Status | Check | Recipe | Coverage Notes | |
| 73 | +|--------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------------| |
| 74 | +| 🟢 | [`UpperEll`](https://checkstyle.sourceforge.io/checks/misc/upperell.html#UpperEll ) | [`UpperEll`](https://github.com/checkstyle/checkstyle-openrewrite-recipes/blob/main/src/main/java/org/checkstyle/autofix/recipe/UpperEll.java ) | | |
| 75 | + |
| 76 | + |
| 77 | +### Modifiers |
| 78 | + |
| 79 | +_No checks analyzed yet_ |
| 80 | + |
| 81 | + |
| 82 | +### Naming Conventions |
| 83 | + |
| 84 | +_No checks analyzed yet_ |
| 85 | + |
| 86 | + |
| 87 | +### Regexp |
| 88 | + |
| 89 | +_No checks analyzed yet_ |
| 90 | + |
| 91 | + |
| 92 | +### Size Violations |
| 93 | + |
| 94 | +_No checks analyzed yet_ |
| 95 | + |
| 96 | + |
| 97 | +### Whitespace |
| 98 | + |
| 99 | +_No checks analyzed yet_ |
| 100 | + |
0 commit comments