Back to all reviewers

Maintain naming consistency

dyad-sh/dyad
Based on 2 comments
TypeScript

Ensure naming follows consistent patterns within the codebase and adheres to official framework conventions. When creating related types or functions, use matching naming schemes to maintain clarity and prevent synchronization issues. Prefer established conventions over custom variations unless there's a compelling reason to deviate.

Naming Conventions TypeScript

Reviewer Prompt

Ensure naming follows consistent patterns within the codebase and adheres to official framework conventions. When creating related types or functions, use matching naming schemes to maintain clarity and prevent synchronization issues. Prefer established conventions over custom variations unless there’s a compelling reason to deviate.

For example, if you have CloneRepoParams, create a corresponding CloneRepoReturnType rather than using a generic return type. Similarly, when working with frameworks like Supabase, stick to their official function-name/index.ts convention rather than implementing broader custom patterns.

// Good: Consistent naming pattern
interface CloneRepoParams { ... }
interface CloneRepoReturnType { ... }

// Good: Following official convention
// supabase/functions/my-function/index.ts

// Avoid: Inconsistent or custom naming
interface CloneRepoParams { ... }
interface GenericResponse { ... } // Should be CloneRepoReturnType

This approach reduces cognitive load, prevents naming conflicts, and ensures the codebase remains maintainable as it scales.

2
Comments Analyzed
TypeScript
Primary Language
Naming Conventions
Category

Source Discussions