Title Template Property - Githubissues

Everduin94 / better-commits

A CLI for creating better commits following the conventional commits specification

MIT License

1.88k stars 69 forks source link

Title Template Property #70

Closed Everduin94 closed 5 months ago

Everduin94 commented 5 months ago

Context

Based on https://github.com/Everduin94/better-commits/discussions/69

Today, although each property is optional, the order in the title is fixed to match conventional commits.

TYPE(SCOPE): TICKET DESCRIPTION

Tasks

Create a property title_template

Default: type(scope): ticket description

Zod Validation

Enforce key words: ["type", "scope", "ticket", "description"]
Enforce separators: ["/", "-", "_", "[]", "()", ":", "{}"]

Regex

Update string builder to use template

Concerns

More difficult to enforce things like "if () is empty remove, if no text before colon then remove colon" etc...

Outstanding Tasks

This will effectively make fields like optional or separator redundant in some cases. Should we deprecate?
We may want to add some way to add custom fields / prompts

Everduin94 commented 5 months ago

Closing. See https://github.com/Everduin94/better-commits/pull/77

Solves most common situations with existing code.