Everduin94 / better-commits

A CLI for creating better commits following the conventional commits specification

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Branch Template Property

Everduin94 opened this issue ยท comments

Context

Based on #68 (@groovyghoul)

Today, although each part is optional, the order in the branch name when running better-branch is fixed.

USER/TYPE/TICKET-DESCRIPTION

Tasks

Create a property branch_template

  • Default: user/type/ticket-description

Zod Validation

  • Enforce key words: ["user", "type", "ticket", "description", "version"]
  • Enforce separators: ["/", "-", "_"]

Regex

  • Update builder to use template
  • See #70 make sure to not break inference between these two changes

Add either

  • A way to make custom fields / prompts
  • Optional version number field (leaning towards this for now)

Outstanding Tasks

  • This will effectively make fields like optional or separator redundant in some cases. Should we deprecate?

๐ŸŽ‰ This issue has been resolved in version 1.11.0 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€

@Everduin94 I finally got a chance to install and configure. This is working EXACTLY how I want it! Thanks for going above and beyond.