diff options
| author | Jason Kölker <jason@koelker.net> | 2024-01-24 02:00:07 +0000 |
|---|---|---|
| committer | Jason Kölker <jason@koelker.net> | 2024-01-24 02:34:44 +0000 |
| commit | 9e6f8e8d037a477c55939ece36ab7b000f876e85 (patch) | |
| tree | 457b7c81b511b42ece0704e03b673702a6786d0e /README.md | |
| parent | 4692eec84b5aa9d95256bef515bd1d17471e5570 (diff) | |
| download | vim-ai-9e6f8e8d037a477c55939ece36ab7b000f876e85.tar.gz | |
feat(chat): add `include` role to include files
Files may be included in the chat by a special `include` role. Each
file's contents will be added to an additional `user` role message with
the files separated by `==> {path} <==` where `{path}` is the path to
the file. Globbing is expanded out via `glob.glob` and relative apths to
the current working directory (as determined by `getcwd()`) will be
resolved to absolute paths.
Example:
```
>>> user
Generate documentation for the following files
>>> include
/home/user/myproject/src/../requirements.txt
/home/user/myproject/**/*.py
```
Fixes: #69
Diffstat (limited to '')
| -rw-r--r-- | README.md | 17 |
1 files changed, 16 insertions, 1 deletions
@@ -131,7 +131,22 @@ You are a Clean Code expert, I have the following code, please refactor it in a ``` -Supported chat roles are **`>>> system`**, **`>>> user`** and **`<<< assistant`** +To include files in the chat a special `include` role is used: + +``` +>>> user + +Generate documentation for the following files + +>>> include + +/home/user/myproject/requirements.txt +/home/user/myproject/**/*.py +``` + +Each file's contents will be added to an additional `user` role message with the files separated by `==> {path} <==`, where path is the path to the file. Globbing is expanded out via `glob.gob` and relative paths to the current working directory (as determined by `getcwd()`) will be resolved to absolute paths. + +Supported chat roles are **`>>> system`**, **`>>> user`**, **`>>> include`** and **`<<< assistant`** ### `:AINewChat` |