feat(main): #81 prepend ticket (#87)

add prepend ticket config with never, prompt, and always

DEPRECATED: append_ticket has been deprecated, see prepend_ticket

Closes: #81

.better-commits.json

@@ -34,7 +34,7 @@
     ]
   },
   "check_ticket": {
-    "append_hashtag": true
+    "prepend_hashtag": "Always"
   },
   "branch_pre_commands": [
     "git stash",

readme.md

@@ -192,6 +192,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
         "confirm_ticket": true,
         "add_to_title": true,
         "append_hashtag": false,
+        "prepend_hashtag": "Never",
         "surround": "",
         "title_position": "start"
     },
@@ -263,8 +264,14 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
 
 </details>
 
+> [!NOTE]<br>
+> Some properties use sets of string values
+> See *confile file explanations* for possible values
+
 ### 🔭 Config File Explanations
 
+Expand to see explanations and possible values
+
 <details>
 <summary>Expand / Collapse</summary>
 
@@ -297,7 +304,8 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
 | `check_ticket.infer_ticket`                | If true infer ticket from branch name                       |
 | `check_ticket.confirm_ticket`              | If true manually confirm inference                          |
 | `check_ticket.add_to_title`                | If true add ticket to title                                 |
-| `check_ticket.append_hashtag`              | If true add hashtag to ticket (Ideal for Github Issues)     |
+| `check_ticket.append_hashtag`              | **Deprecated**: see prepend_hashtag                         |
+| `check_ticket.prepend_hashtag`             | "Never" (default), "Prompt", or "Always"                    |
 | `check_ticket.title_position`              | "start" (of description) (default), "end", "before-colon"   |
 | `check_ticket.surround`                    | "" (default), "[]", "()", "{}" - Wraps ticket in title      |
 | `commit_title.max_size`                    | Max size of title including scope, type, etc...             |

src/index.ts

@@ -98,7 +98,9 @@ export async function main(config: z.infer<typeof Config>) {
       .filter(v => v != null)
       .map(v => v && v.length >= 2 ?  v[1] : '')
       if (found.length && found[0]) {
-        commit_state.ticket = config.check_ticket.append_hashtag ? '#' + found[0] : found[0]
+        commit_state.ticket = config.check_ticket.append_hashtag 
+          || config.check_ticket.prepend_hashtag === 'Prompt'
+          ? '#' + found[0] : found[0]
       }
     } catch(err: any) {
       // Can't find branch, fail silently
@@ -115,6 +117,12 @@ export async function main(config: z.infer<typeof Config>) {
     commit_state.ticket = user_commit_ticket ?? '';
   }
 
+  if (config.check_ticket.prepend_hashtag === 'Always' 
+    && commit_state.ticket 
+    && !commit_state.ticket.startsWith('#')) {
+    commit_state.ticket = '#' + commit_state.ticket;
+  }
+
   const commit_title = await p.text(
       {
 					message: 'Write a brief title describing the commit',

src/zod-state.ts

@@ -97,6 +97,7 @@ export const Config = z
         confirm_ticket: z.boolean().default(true),
         add_to_title: z.boolean().default(true),
         append_hashtag: z.boolean().default(false),
+        prepend_hashtag: z.enum(['Never', 'Always', 'Prompt']).default("Never"),
         surround: z.enum(["", "()", "[]", "{}"]).default(""),
         title_position: z.enum(["start", "end", "before-colon"]).default("start"),
       })