AI.NVIM

AI chatbot plugin written in vimscript with test driven development.

This repo follows the kernel's style guide but with 4 space indenting instead of 8.

TDD

This project uses Plenary Busted for its test suite and cqfd for reproducible setups inside docker.

To run the tests with cqfd:

make

To run the tests without cqfd:

make test

Currently the tests look something like this:

Starting...Scheduling: tests/ai_spec.lua

========================================
Testing:        /home/kin/src/nvim.cfg/pack/ai.nvim/start/ai.nvim/tests/ai_spec.lua
Success ||      :Ai does not error
Success ||      :Ai reuses the last chat name
Success ||      :Ai reuses the last chat window
Success ||      :Ai puts the cursor at the bottom of the chat
Success ||      :Ai! does not error
Success ||      :Ai! creates a new empty chat
Success ||      :Ai! reuses the last chat window
Success ||      :Ai! puts the cursor at the bottom of the chat
Success ||      :Ai <prompt> accepts a prompt as an argument
Success ||      :Ai <prompt> passes <prompt> to the buffer
...
Success:        28
Failed :        0
Errors :        0
========================================
--------------------------------------------------------------------------------
language                       files          blank        comment          code
--------------------------------------------------------------------------------
test code:
 json                              2              0              0           768
 lua                               2            101             38           276
application code:
 vimscript                         4             51              5           169
other:
 markdown                          1             19              0            45
 make                              1              2              0            21
 dockerfile                        1              2              0            10
--------------------------------------------------------------------------------
 sum:                             12            176             43          1294
--------------------------------------------------------------------------------

DOCS

The tests document themselves so the tests and the test output are the documentation. Hopefully, I will find time to generate actual vimdocs.

CLOC

This plugin was made out of spite against the growing trend of all lua-based Neovim plugins that reinvent half of the features already present in Neovim leading to excessive bloat.

The cloc Makefile target uses the cloc cli tool to Count Lines Of Code to emphasize that this plugin is lean. TDD also inherently promotes a lean codebase.

VIMSCRIPT

This plugin is written in vimscript and tested in lua.

Vimscript teaches you more about vim than lua does. Vimscript also has the best developer experience a language could offer due to the immediate in-editor documentation for the entire language. Which doesn't work as well with lua.

I love Lua but some of the following reasons are why I dislike lua:

• error() truncates filepaths
• 0 is truthy
• 1 based indexing
• 2 space indenting is the norm
• vim.fn.readfile() in lua != readfile() in vimscript
• "^ghu_[[:alnum:]]\\{36}$" couldn't figure out how to do this lua