Refactor confirm prompt and enable LLM result caching #678
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
The changes in the pull request are relatively straightforward. The developer has changed the functionality of the Previously, the If the change was intended, it appears to be implemented consistently across the affected files. However, this change should be clearly communicated to users to avoid confusion. The code changes seem to be fine and do not introduce any obvious functional issues. Overall, it's a LGTM 🚀 from a functional standpoint.
|
| ```bash | ||
| npx -p @inquirer/prompts -p genaiscript -- genaiscript run gcm | ||
| ``` | ||
|
|
||
| This command will run the script, and guide you through the process of generating and committing a Git message using AI, making your commits more informative and consistent. | ||
|
|
||
| You can wrap this command in a `gcm.sh` file or in your package `script` section in `package.json`: |
There was a problem hiding this comment.
A section about using npx has been removed. Ensure this information is not necessary or is included elsewhere in the documentation.
generated by pr-docs-review-commit
removed_section
| @@ -44,6 +44,7 @@ Options: | |||
| -se, --seed <number> seed for the run | |||
| -em, --embeddings-model <string> embeddings model for the run | |||
| --no-cache disable LLM result cache | |||
| --cache enable LLM result cache | |||
There was a problem hiding this comment.
A new option '--cache' has been added to enable LLM result cache. Make sure this is properly explained in the documentation.
generated by pr-docs-review-commit
new_option
This pull request includes a refactoring of the confirm prompt and removes the usage instructions for the
npxcommand from the auto-git-commit-message guide. Additionally, it enables LLM result caching and updates the CLI options to reflect this change.Indentation Change 📏: The first change is to
auto-git-commit-message.mdx. The indentation of a section of javascript has been reduced to be in line with good style practices for a consistent and clean codebase. 🧼Removing Unneeded Info 🗑️: The next change also to
auto-git-commit-message.mdxremoves unneeded information regarding how to use npx which cleans up the documentation. 📝Option Switch 🔁: In several
.mdand.tsfiles, the--no-cacheoption has been changed to--cache. This alters the default behavior of cache settings, effectively enabling cache by default, which can enhance the performance of command-line interactions executed by users, thus speeding up overall execution. 🚀Cache Settings Applied ✔️: The updated cache option has been applied to several commands in various
.tsfiles. This includes adding--cacheoption in conditions where it was previously omitted if cache was disabled.Please note that, although these changes seem to be relatively minor, they are important for the overall efficiency, speed, and cleanliness of the codebase. This all can lead to a superior user experience. 👩💻👨💻