Back to all reviewers

Maintain semantic naming consistency

n8n-io/n8n
Based on 4 comments
Typescript

Names should be semantically meaningful and consistent across related concepts in the codebase. This applies to variables, functions, components, and types. When naming:

Naming Conventions Typescript

Reviewer Prompt

Names should be semantically meaningful and consistent across related concepts in the codebase. This applies to variables, functions, components, and types. When naming:

  1. Use consistent suffixes/prefixes for related concepts
  2. Choose descriptive verbs for functions
  3. Avoid abbreviations unless widely understood
  4. Maintain naming patterns across similar features

Example of poor naming consistency:

// Inconsistent naming pattern
interface User {
  customer_id: string;  // Uses _id suffix
  group: string;        // Missing _id suffix
}

function enableStreaminOption() {}  // Misspelled, unclear verb

Improved version:

// Consistent naming pattern
interface User {
  customerId: string;   // Consistent camelCase
  groupId: string;      // Consistent naming pattern
}

function createStreamingOption() {}  // Clear verb, correct spelling

This helps maintain code readability and reduces cognitive load when working across different parts of the codebase.

4
Comments Analyzed
Typescript
Primary Language
Naming Conventions
Category

Source Discussions