branch: externals/ellama
commit ac5a793ef5740b49b770dd628f7c952a46ca2af8
Merge: c20394170b 1204c32352
Author: Sergey Kostyaev <s-kosty...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
Merge pull request #211 from s-kostyaev/improve-code-add
Simplify prompt template and context handling in `ellama-code-add`
---
NEWS.org | 6 ++++++
README.org | 6 ++++--
ellama.el | 32 ++++++++++++++------------------
3 files changed, 24 insertions(+), 20 deletions(-)
diff --git a/NEWS.org b/NEWS.org
index 6d6904f524..4a87a7277f 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -1,3 +1,9 @@
+* Version 1.0.1
+- Refactor ellama-code-add function for better efficiency. Remove
+ redundant context handling in ~ellama-code-add~. Simplify the prompt
+ template by removing unnecessary context instructions. Improve
+ function documentation for clarity. Add region selection handling
+ outside of ~ellama-stream~ call.
* Version 1.0.0
- Added ~ellama-write~ command.
- Added ~ellama-proofread~ command.
diff --git a/README.org b/README.org
index 8fa8a8ffc5..18516b9a2d 100644
--- a/README.org
+++ b/README.org
@@ -192,8 +192,10 @@ provided change using Ellama.
*** ellama-code-add
-Add new code according to a description, generating it with a provided
-context from the selected region or the current buffer using Ellama.
+Generate and insert new code based on description. This function
+prompts the user to describe the code they want to generate. If a
+region is active, it includes the selected text as context for code
+generation.
*** ellama-code-edit
diff --git a/ellama.el b/ellama.el
index 2ad36970f7..895f6fab94 100644
--- a/ellama.el
+++ b/ellama.el
@@ -6,7 +6,7 @@
;; URL: http://github.com/s-kostyaev/ellama
;; Keywords: help local tools
;; Package-Requires: ((emacs "28.1") (llm "0.22.0") (spinner "1.7.4")
(transient "0.7") (compat "29.1") (posframe "1.4.0"))
-;; Version: 1.0.0
+;; Version: 1.0.1
;; SPDX-License-Identifier: GPL-3.0-or-later
;; Created: 8th Oct 2023
@@ -305,7 +305,7 @@ Write text, based on provided context and instruction. Do
not add any explanatio
:group 'ellama
:type 'string)
-(defcustom ellama-code-add-prompt-template "Context: \n```\n%s\n```\nBased on
this context, %s, only output the result in format ```\n...\n```\nWrite all the
code in single code block."
+(defcustom ellama-code-add-prompt-template "Based on context, %s, only output
the result in format ```\n...\n```\nWrite all the code in single code block."
"Prompt template for `ellama-code-add'."
:group 'ellama
:type 'string)
@@ -2330,23 +2330,19 @@ prefix (\\[universal-argument]), prompt the user to
amend the template."
;;;###autoload
(defun ellama-code-add (description)
- "Add new code according to DESCRIPTION.
-Code will be generated with provided context from selected region or current
-buffer."
+ "Generate and insert new code based on DESCRIPTION.
+This function prompts the user to describe the code they want to generate.
+If a region is active, it includes the selected text as context for code
+generation."
(interactive "sDescribe the code to be generated: ")
- (let* ((beg (if (region-active-p)
- (region-beginning)
- (point-min)))
- (end (if (region-active-p)
- (region-end)
- (point-max)))
- (text (buffer-substring-no-properties beg end)))
- (ellama-stream
- (format
- ellama-code-add-prompt-template
- text description)
- :provider ellama-coding-provider
- :filter #'ellama--code-filter)))
+ (when (region-active-p)
+ (ellama-context-add-selection))
+ (ellama-stream
+ (format
+ ellama-code-add-prompt-template
+ description)
+ :provider ellama-coding-provider
+ :filter #'ellama--code-filter))
;;;###autoload
