Prompt
Names for variables, methods, and classes should be descriptive, semantically accurate, and consistent with established conventions. Follow these guidelines:
- Use names that clearly describe the purpose or content:
// Bad const val: any = getValue(); // Good const fileOrFiles: File | File[] = getUploadedFiles(); - Follow semantic naming conventions:
- Boolean variables/methods should use “is”, “has”, or “should” prefixes
- Error classes should be specific (e.g.,
RouterAliasErrorinstead ofError) - Maintain consistent pluralization (e.g.,
PostsServicefor a service handling multiple posts)
- Align with framework and library conventions:
- Match external library naming patterns when extending their functionality
- Follow project’s established naming patterns for consistency
- Preserve meaningful naming from referenced libraries
- Avoid generic or ambiguous names:
- Replace generic names like ‘data’, ‘value’, ‘info’ with context-specific alternatives
- Use type-specific prefixes/suffixes when appropriate
- Consider the scope and usage when choosing names
Remember that good names serve as self-documentation and improve code maintainability.