Back to all reviewers

Consistent descriptive naming conventions

helix-editor/helix
Based on 6 comments
Markdown

Use consistent and descriptive naming conventions across the codebase: 1. Use kebab-case for configuration options and snake_case for internal modifiers

Naming Conventions Markdown

Reviewer Prompt

Use consistent and descriptive naming conventions across the codebase:

  1. Use kebab-case for configuration options and snake_case for internal modifiers
  2. Prefer descriptive names over technical terms
  3. Keep names concise while maintaining clarity
  4. Use semantic prefixes to group related items

Example:

# Instead of:
[editor.bufferline]
behaviour = "hidden"
matches_couter_limit = 100

# Prefer:
[editor.bufferline]
show = "never"
max-matches = 100

# Group related commands with semantic prefixes:
:align-text-left
:align-text-center
:align-text-right

This convention ensures consistency, improves code readability, and makes configuration more intuitive for users. Descriptive names make the purpose immediately clear, while consistent casing helps distinguish between different types of identifiers.

6
Comments Analyzed
Markdown
Primary Language
Naming Conventions
Category

Source Discussions