feat(util): #117 cache last value (#118)

Added config "cache_last_value", default . When re-running better-commits, will use values from the previous run.

Closes: #117

Author: Everduin94

readme.md

@@ -91,7 +91,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
   "commit_type": {
     "enable": true,
     "initial_value": "feat",
-    "max_items": Infinity,
+    "max_items": 20,
     "infer_type_from_branch": true,
     "append_emoji_to_label": false,
     "append_emoji_to_commit": false,
@@ -170,7 +170,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
     "enable": true,
     "custom_scope": false,
     "initial_value": "app",
-    "max_items": Infinity
+    "max_items": 20
     "options": [
       {
         "value": "app",
@@ -219,6 +219,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
     "add_exclamation_to_title": true
   },
   "confirm_commit": true,
+  "cache_last_value": true,
   "confirm_with_editor": false,
   "print_commit_output": true,
   "branch_pre_commands": [],
@@ -316,6 +317,7 @@ Expand to see explanations and possible values
 | `breaking_change.add_exclamation_to_title` | If true adds exclamation mark to title for breaking changes                                         |
 | `confirm_commit`                           | If true manually confirm commit at end                                                              |
 | `confirm_with_editor`                      | Confirm / Edit commit with $GIT_EDITOR / $EDITOR                                                    |
+| `cache_last_value`                         | Reuse last prompt value after cancel                                                                |
 | `print_commit_output`                      | If true pretty print commit preview                                                                 |
 | `overrides.shell`                          | Override default shell, useful for windows users                                                    |
 

src/index.ts

@@ -21,16 +21,23 @@ import {
   get_git_root,
   REGEX_SLASH_UND,
   REGEX_START_UND,
+  get_value_from_cache,
+  set_value_cache,
+  NOOP_PROMPT_CACHE,
 } from "./utils";
 import { git_add, git_status } from "./git";
 import { CUSTOM_SCOPE_KEY, V_FOOTER_OPTIONS } from "./valibot-consts";
 import { flags } from "./args";
+import Configstore from "configstore";
 
 main(load_setup());
 
 export async function main(config: Output<typeof Config>) {
   let commit_state = parse(CommitState, {});
   chdir(get_git_root());
+  const prompt_cache = config.cache_last_value
+    ? new Configstore("better-commits")
+    : NOOP_PROMPT_CACHE;
 
   if (config.check_status) {
     let { index, work_tree } = git_status();
@@ -94,11 +101,13 @@ export async function main(config: Output<typeof Config>) {
     }
     const commit_type = await p.select({
       message,
-      initialValue: initial_value,
+      initialValue:
+        get_value_from_cache(prompt_cache, "commit_type") || initial_value,
       maxItems: config.commit_type.max_items,
       options: config.commit_type.options,
     });
     if (p.isCancel(commit_type)) process.exit(0);
+    set_value_cache(prompt_cache, "commit_type", commit_type);
     commit_state.trailer = value_to_data[commit_type].trailer;
     commit_state.type =
       config.commit_type.append_emoji_to_commit &&
@@ -110,11 +119,15 @@ export async function main(config: Output<typeof Config>) {
   if (config.commit_scope.enable) {
     let commit_scope = await p.select({
       message: "Select a commit scope",
-      initialValue: config.commit_scope.initial_value,
+      initialValue:
+        get_value_from_cache(prompt_cache, "commit_scope") ||
+        config.commit_scope.initial_value,
       maxItems: config.commit_scope.max_items,
       options: config.commit_scope.options,
     });
     if (p.isCancel(commit_scope)) process.exit(0);
+    set_value_cache(prompt_cache, "commit_scope", commit_scope);
+
     if (commit_scope === CUSTOM_SCOPE_KEY && config.commit_scope.custom_scope) {
       commit_scope = await p.text({
         message: "Write a custom scope",
@@ -158,9 +171,12 @@ export async function main(config: Output<typeof Config>) {
         ? `Ticket / issue inferred from branch ${color.dim("(confirm / edit)")}`
         : `Add ticket / issue ${OPTIONAL_PROMPT}`,
       placeholder: "",
-      initialValue: commit_state.ticket,
+      initialValue:
+        get_value_from_cache(prompt_cache, "commit_ticket") ||
+        commit_state.ticket,
     });
     if (p.isCancel(user_commit_ticket)) process.exit(0);
+    set_value_cache(prompt_cache, "commit_ticket", user_commit_ticket);
     commit_state.ticket = user_commit_ticket ?? "";
   }
 
@@ -174,6 +190,7 @@ export async function main(config: Output<typeof Config>) {
 
   const commit_title = await p.text({
     message: "Write a brief title describing the commit",
+    initialValue: get_value_from_cache(prompt_cache, "commit_title") || "",
     placeholder: "",
     validate: (value) => {
       if (!value) return "Please enter a title";
@@ -195,6 +212,8 @@ export async function main(config: Output<typeof Config>) {
     },
   });
   if (p.isCancel(commit_title)) process.exit(0);
+  set_value_cache(prompt_cache, "commit_title", commit_title);
+
   let commit_title_with_emoji = commit_title;
   if (
     config.commit_type.append_emoji_to_commit &&
@@ -206,20 +225,26 @@ export async function main(config: Output<typeof Config>) {
   if (config.commit_body.enable) {
     const commit_body = await p.text({
       message: `Write a detailed description of the changes ${OPTIONAL_PROMPT}`,
+      initialValue: get_value_from_cache(prompt_cache, "commit_body") || "",
       placeholder: "",
       validate: (val) => {
         if (config.commit_body.required && !val)
           return "Please enter a description";
       },
     });
     if (p.isCancel(commit_body)) process.exit(0);
+    set_value_cache(prompt_cache, "commit_body", commit_body);
     commit_state.body = commit_body ?? "";
   }
 
   if (config.commit_footer.enable) {
+    const cache_footer = get_value_from_cache(
+      prompt_cache,
+      "commit_footer",
+    ).split(",");
     const commit_footer = await p.multiselect({
       message: `Select optional footers ${SPACE_TO_SELECT}`,
-      initialValues: config.commit_footer.initial_value,
+      initialValues: cache_footer || config.commit_footer.initial_value,
       options: COMMIT_FOOTER_OPTIONS as {
         value: Output<typeof V_FOOTER_OPTIONS>;
         label: string;
@@ -228,6 +253,7 @@ export async function main(config: Output<typeof Config>) {
       required: false,
     });
     if (p.isCancel(commit_footer)) process.exit(0);
+    set_value_cache(prompt_cache, "commit_footer", commit_footer.join(","));
 
     if (commit_footer.includes("breaking-change")) {
       const breaking_changes_title = await p.text({
@@ -332,6 +358,7 @@ export async function main(config: Output<typeof Config>) {
     p.log.error("Something went wrong when committing: " + err);
   }
   p.log.success("Commit Complete");
+  prompt_cache.clear();
 }
 
 function build_commit_string(

src/utils.ts

@@ -8,6 +8,7 @@ import { Config } from "./valibot-state";
 import { V_BRANCH_ACTIONS } from "./valibot-consts";
 import { argv } from "process";
 import { flags } from "./args";
+import Configstore from "configstore";
 
 export const CONFIG_FILE_NAME = ".better-commits.json";
 export const SPACE_TO_SELECT = `${color.dim("(<space> to select)")}`;
@@ -56,6 +57,12 @@ export const BRANCH_ACTION_OPTIONS: {
   { value: "worktree", label: "Worktree" },
 ];
 
+export const NOOP_PROMPT_CACHE = {
+  get: () => "",
+  set: (key: string, value: string) => {},
+  clear: () => {},
+} as unknown as Configstore;
+
 /* LOAD */
 export function load_setup(
   cli_name = " better-commits ",
@@ -84,6 +91,7 @@ export function load_setup(
             ? global_config.overrides
             : repo_config.overrides,
           confirm_with_editor: global_config.confirm_with_editor,
+          cache_last_value: global_config.cache_last_value,
         }
       : repo_config;
   }
@@ -187,3 +195,32 @@ export function clean_commit_title(title: string): string {
 function set_non_configuration_arguments() {
   flags.git_args = `${argv[2] ?? ""} ${argv[3] ?? ""}`.trim();
 }
+
+export function get_value_from_cache(
+  config_store: Configstore,
+  key: string,
+): string {
+  try {
+    return config_store.get(key) ?? "";
+  } catch (err) {
+    p.log.warn(
+      `Could not access ${key} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`,
+    );
+  }
+
+  return "";
+}
+
+export function set_value_cache(
+  config_store: Configstore,
+  key: string,
+  value: string,
+): void {
+  try {
+    config_store.set(key, value);
+  } catch (err) {
+    p.log.warn(
+      `Could not access ${key} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`,
+    );
+  }
+}

src/valibot-state.ts

@@ -162,6 +162,7 @@ export const Config = v.object({
     }),
     {},
   ),
+  cache_last_value: v.optional(v.boolean(), true),
   confirm_with_editor: v.optional(v.boolean(), false),
   confirm_commit: v.optional(v.boolean(), true),
   print_commit_output: v.optional(v.boolean(), true),