feat: checkstyle suppressions #1
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a checkstyle suppressions configuration file to suppress MemberName check violations for two member variables (m_autonomousCommand and m_robotContainer) in the Robot.java file that use the WPILib naming convention with the m_ prefix.
Key Changes:
- New
checkstyle-suppressions.xmlfile created with suppressions for MemberName violations in Robot.java
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| message="m_autonomousCommand"/> | ||
|
|
||
| <suppress | ||
| files="src/main/java/frc/robot/Robot.java" | ||
| checks="MemberName" | ||
| message="m_robotContainer"/> |
There was a problem hiding this comment.
The 'message' attribute in suppress rules is intended to match the violation message text, not just the variable name. This configuration will only suppress violations where the message contains 'm_autonomousCommand', which may not work as expected. Consider using a more targeted approach by suppressing based on the line numbers or using a regex pattern in the 'id' or 'checks' attribute. Alternatively, you could modify the MemberName check pattern in checkstyle.xml to allow the WPILib naming convention (m_ prefix) rather than suppressing it.
| message="m_autonomousCommand"/> | |
| <suppress | |
| files="src/main/java/frc/robot/Robot.java" | |
| checks="MemberName" | |
| message="m_robotContainer"/> | |
| message=".*m_autonomousCommand.*"/> | |
| <suppress | |
| files="src/main/java/frc/robot/Robot.java" | |
| checks="MemberName" | |
| message=".*m_robotContainer.*"/> |
| checks="MemberName" | ||
| message="m_autonomousCommand"/> | ||
|
|
||
| <suppress | ||
| files="src/main/java/frc/robot/Robot.java" | ||
| checks="MemberName" | ||
| message="m_robotContainer"/> | ||
|
|
There was a problem hiding this comment.
The 'message' attribute in suppress rules is intended to match the violation message text, not just the variable name. This configuration will only suppress violations where the message contains 'm_robotContainer', which may not work as expected. Consider using a more targeted approach by suppressing based on the line numbers or using a regex pattern in the 'id' or 'checks' attribute. Alternatively, you could modify the MemberName check pattern in checkstyle.xml to allow the WPILib naming convention (m_ prefix) rather than suppressing it.
| checks="MemberName" | |
| message="m_autonomousCommand"/> | |
| <suppress | |
| files="src/main/java/frc/robot/Robot.java" | |
| checks="MemberName" | |
| message="m_robotContainer"/> | |
| checks="MemberName"/> |
No description provided.