Skip to main content

Branch Naming Helper

Branch Naming Helper - focused on branch naming pattern application.

Overview​

This helper handles: - Branch pattern application - Branch name creation and validation - Pattern completion and suggestions - Spec ID validation

Classes​

BranchNamingHelper​

Helper for branch naming operations.

Methods​

apply_branch_pattern​
apply_branch_pattern(self, pattern: str, **kwargs) -> str

Apply variables to branch naming pattern.

Parameters:

  • pattern (str, required) - Branch naming pattern with placeholders
  • kwargs (Any, required)

Returns: str

branch_to_directory_name​
branch_to_directory_name(self, branch_name: str, naming_config: Optional[Dict] = None) -> str

Convert branch name to directory name following project conventions.

Parameters:

  • branch_name (str, required) - Branch name to convert
  • naming_config (Optional, optional) - Optional naming configuration

Returns: str

complete_branch_name​
complete_branch_name(self, partial_name: str, available_branches: Optional[List[str]] = None, max_suggestions: int = 5) -> List[str]

Provide completion suggestions for partial branch names.

Parameters:

  • partial_name (str, required) - Partial branch name to complete
  • available_branches (Optional, optional) - List of available branches to suggest from
  • max_suggestions (int, optional) - Maximum number of suggestions to return - Default: 5

Returns: List

create_branch_name​
create_branch_name(self, description: str, feature_num: str) -> str

Create branch name following project patterns.

Parameters:

  • description (str, required) - Feature description
  • feature_num (str, required) - Feature number

Returns: str

validate_branch_name_against_patterns​
validate_branch_name_against_patterns(self, branch_name: str, patterns: Optional[List[str]] = None) -> Tuple[bool, Optional[str]]

Validate branch name against configured patterns.

Parameters:

  • branch_name (str, required) - Branch name to validate
  • patterns (Optional, optional) - Optional list of patterns to validate against

Returns: Tuple

validate_spec_id_format​
validate_spec_id_format(self, spec_id: str) -> Tuple[bool, Optional[str]]

Validate spec ID format.

Parameters:

  • spec_id (str, required) - Spec ID to validate

Returns: Tuple