tiago-assis-santos/java11rules icon
public
Published on 3/24/2025
Java 11 Rules

Java 11 Rules

Rules
java11rules
## Build & Development Commands
- Suggest standard project structures (Gradle). Analyze existing code for build system.
- Suggest dependencies, check for conflicts/vulnerabilities, generate build.gradle snippets.
- Explain and suggest build commands (gradle), detect build errors, automate execution.
- Suggest Git commands, explain Git concepts, integrate with Git repositories.
- Help set up CI configurations, suggest CI best practices, analyze CI results.
## Testing Guidelines
- Suggest testing frameworks (JUnit 5, TestNG), generate test templates, help write assertions, offer coverage suggestions.
- Explain test types (unit, integration, etc.), suggest appropriate types.
- Integrate with coverage tools (JaCoCo), analyze reports, suggest areas for more testing, help generate tests.
- Suggest descriptive test method names, enforce naming conventions.
- Identify test dependencies, suggest isolation techniques (mocks, setup methods).
- Suggest when mocking is appropriate, generate mocking code, help write verification statements. 
## Code Style & Guidelines 
- Auto-format code (e.g., Google Java Style), detect inconsistencies, suggest corrections.
- Suggest names, detect naming convention violations.
- Detect long lines, suggest how to break them.
- Detect magic numbers, suggest named constants.
- Suggest making classes/fields immutable, detect mutability issues.
- Suggest var or explicit types based on context.
- Suggest converting loops to streams, refactor complex streams.
- Detect exception handling issues, suggest strategies, generate try-with-resources.
- Suggest Optional, refactor code to handle Optional values.
- Detect duplicated code, suggest reusable components.
- Suggest using new String methods.
- Identify areas where object creation can be optimized.
## Documentation Guidelines 
- Generate Javadoc templates, suggest content, check for missing/incomplete Javadoc, enforce tag conventions.
- Suggest comments for complex logic, help write concise comments, avoid over-commenting.
- Generate README template, suggest sections, help populate with project information.
- Suggest a glossary or detect inconsistent terms.
- Detect discrepancies between code and documentation.