You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-8Lines changed: 35 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ effectively replacing proprietary providers Large Language Models (LLMs) web pla
20
20
21
21
||
22
22
|:--:|
23
-
| prompter.vim in action editinga prompt to simulate a phone conversation, with the tecnique below described as "dialogues as part of the text prompt"|
23
+
| prompter.vim in action: editing/interacting with a prompt that simulate a phone conversation (with a tecnique below described as "dialogues as part of the text prompt")|
24
24
25
25
## ⚠ A Tool for Prompt Engineers, Not Coders!
26
26
@@ -390,8 +390,28 @@ PrompterSetup <F9>
390
390
391
391
## 🛠 Other useful vim settings
392
392
393
-
- To read all statistics print of your completions:
393
+
- Use (embedded in vim) spell checker!
394
+
When you write a LLM prompt it's very very important to avoid typos!
395
+
I many time experienced that LLM completion worst if you mistake just a verb.
396
+
397
+
Things go even worst if you are writing prompts in more than one languages.
398
+
personally I usually write conversational prompts in English, for some reasons described in my article
399
+
[Non-English Languages Prompt Engineering Trade-offs](https://convcomp.it/non-english-languages-prompt-engineering-trade-offs-7e529866faba),
400
+
but the target langugae of the chat prompt is my native language: Italian.
401
+
All in all the prompt contains text in both English and Italian. In this case I run this small vimscript function:
402
+
394
403
```viml
404
+
function! Spell()
405
+
set spelllang=en_us,it
406
+
setlocal spell
407
+
echom "Spell check set for Italian and English languages"
408
+
endfunction
409
+
com! SPELL call Spell()
410
+
```
411
+
412
+
- To read all statistics print of your completions:
413
+
414
+
```viml
395
415
messages
396
416
```
397
417
vim will show last completion statistics info. By example, if you just run 3 completions:
@@ -402,6 +422,12 @@ PrompterSetup <F9>
402
422
```
403
423
404
424
- Enabling Soft Wrap
425
+
426
+
I usually work with a full-screen vim setting. That helps mme to maximize my attention.
427
+
Nevertheless having very long lines (after a `PrompterGenerate`) doen't help the reading.
428
+
Unfortunately, in vim is not easy to configure a fixed column width soft wrap.
429
+
See [discussion](https://vi.stackexchange.com/questions/43028/how-to-soft-wrap-text-at-column-number-lower-than-window-width).
430
+
You can set set soft warp with follwing command:
405
431
```viml
406
432
set wrap linebreak nolist
407
433
```
@@ -457,12 +483,13 @@ Other vim commands that could be useful:
457
483
map <F7> :normal oa: <CR>
458
484
```
459
485
460
-
## OS Environment
486
+
## Dev/Test Environment
461
487
462
-
- 😓 I developed on WLS (Window Linux Subsystem) on a Windows 10 operating system, using an Ubuntu 20.04 distribution.
463
-
- 😊 I tested the plugin using Python 3.8.10 and 3.11
464
-
- 🤔 As LLM provider, I tested just using my Azure OpenAI account.
465
-
- 😊 Vim version: VIM - Vi IMproved 9.0
488
+
-[x] Vim version: VIM - Vi IMproved 9.0
489
+
-[x] I developed on WLS (Window Linux Subsystem) on a Windows 10 operating system, using an Ubuntu 20.04 distribution.
490
+
-[x] I tested the plugin using both Python 3.8.10 and 3.11
491
+
-[ ] As LLM provider, I tested just using my Azure OpenAI account.
492
+
-[ ] I din't tested using an OpenAI account.
466
493
467
494
468
495
## Features to do in future releases
@@ -509,7 +536,7 @@ Other vim commands that could be useful:
509
536
## Similar projects
510
537
511
538
-[vim-ai](https://github.com/madox2/vim-ai)
512
-
Very similar to prompter.vim. Nevertheless it's focused on code completion allowing small prompts from the command line.
539
+
Very similar to prompter.vim, nevertheless it's focused on code completion allowing small prompts from the command line.
0 commit comments