Style & Conventions rules

Returning null from a Task or Task<T> method causes a NullReferenceException if awaited. Use Task.CompletedTask or Task.FromResult<T>(null) instead.

Detect uses of `re.sub()` where regular expressions are not needed. For simple string replacements, `str.replace()` is more efficient and should be used instead.

Ensure that factory method injection is used in `@Configuration` classes instead of `@Autowired` field injection.

Define constructors for `@immutable` classes as `const` to ensure that instances are created efficiently and cannot be modified.

Ensure that all control structures (if, for, while) use braces `{}` even for single statements.

Use curly braces `{}` around all control structures (`if`, `for`, `while`, `do`-`while`) to improve readability and prevent logic errors.

Verify that API controllers inherit from `ControllerBase` instead of `Controller` unless views are explicitly required.

Never use `v-if` on the same element as `v-for`.

Detect the use of the 'any' type in TypeScript. Using 'any' disables type checking and can lead to runtime errors. Recommend using specific types or generics instead.

Ensure that `@Qualifier` is not used on `@Bean` methods, as explicit bean titles should be used instead.

Check if `goto` statements are avoided. Ensure that structured control flow statements (`if`, `for`, `while`) are used instead.

Do not use constant patterns with type literals as it can lead to unexpected behavior. Prefer direct type checking instead.

Detect occurrences of the comma operator in expressions. The comma operator can make code harder to read and debug, as it executes two expressions but only returns the last one. Suggest alternative structures for better readability.

Avoid assigning values to `void` variables as `void` is not a compatible type and doing so results in runtime errors.

Starting a route template with '/' in ASP.NET makes it absolute, ignoring controller-level routes and potentially breaking expected routing behavior.

Detect occurrences of the 'with' statement. This construct is banned in strict mode due to unpredictable behavior and makes debugging harder.

Every package must have a package comment, and each exported identifier must have a comment starting with the identifier name and a full-sentence summary.

All public modules, classes, and functions must include a docstring immediately after the definition, using PEP 257 conventions (one-line summary + optional sections like Args, Returns, Raises).

Ensure that `@PathVariable` is used correctly in Spring applications to bind URI path variables to method parameters.

Verify that method parameters in overrides and interface implementations match the base method’s parameter titles to maintain consistency.

All public classes, interfaces, and methods must include Javadoc with a summary sentence, @param for each parameter, @return when not void, and @throws where applicable.

All exported JS/TS functions, classes, and public members must include JSDoc with a summary and @param/@returns; include @throws when applicable.

Docstrings must match parameter names, optional defaults, return type, and raised exceptions; update the docstring in the same PR as any signature change.

Ensure that variables that never change are marked as `const` to prevent accidental modification and enhance code clarity.