refactor tools

README.md

@@ -111,5 +111,7 @@ buffer
 - [Aerial.nvim](https://github.com/stevearc/aerial.nvim) for the Tree-sitter parsing which inspired the symbols Slash
 Command
 - [Saghen](https://github.com/Saghen) for the fantastic docs inspiration from [blink.cmp](https://github.com/Saghen/blink.cmp)
+- [Catwell](https://github.com/catwell) for the [queue](https://github.com/catwell/cw-lua/blob/master/deque/deque.lua)
+inspiration that I use to stack agents and tools
 
 <!-- panvimdoc-ignore-end -->

codecompanion-workspace.json

@@ -140,6 +140,42 @@
           "url": "https://raw.githubusercontent.com/olimorris/codecompanion.nvim/refs/heads/main/lua/codecompanion/strategies/inline/init.lua"
         }
       ]
+    },
+    {
+      "name": "Tools",
+      "system_prompt": "In the CodeCompanion plugin, tools can be leveraged by an LLM to execute lua functions or shell commands on the users machine. By responding with XML, CodeCompanion will pass the response, call the corresponding tool. This feature has been implemented via the agent/init.lua file, which passes all of the tools and adds them to a queue. Then those tools are run consecutively by the executor/init.lua file.",
+      "opts": {
+        "remove_config_system_prompt": true
+      },
+      "vars": {
+        "base_dir": "lua/codecompanion/strategies/chat/agents"
+      },
+      "files": [
+        {
+          "description": "This is the entry point for the agent. If XML is detected in an LLM's response then this file is triggered which in turns add tools to a queue before calling the executor",
+          "path": "${base_dir}/init.lua"
+        },
+        {
+          "description": "The executor file then runs the tools in the queue, whether they're functions or commands:",
+          "path": "${base_dir}/executor/init.lua"
+        },
+        {
+          "description": "This is how function tools are run:",
+          "path": "${base_dir}/executor/func.lua"
+        },
+        {
+          "description": "This is how command tools are run:",
+          "path": "${base_dir}/executor/cmd.lua"
+        },
+        {
+          "description": "This is the queue implementation",
+          "path": "${base_dir}/executor/queue.lua"
+        },
+        {
+          "description": "This is how the queue object can look. This is an example of a function tool, a command tool, followed by a function tool:",
+          "path": "tests/stubs/queue.txt"
+        }
+      ]
     }
   ]
 }

doc/.vitepress/config.mjs

@@ -1,5 +1,6 @@
 import { defineConfig } from "vitepress";
 import { execSync } from "node:child_process";
+import { withMermaid } from "vitepress-plugin-mermaid";
 
 const inProd = process.env.NODE_ENV === "production";
 
@@ -28,103 +29,113 @@ const headers = inProd ? [baseHeaders, umamiScript] : baseHeaders;
 const siteUrl = "https://codecompanion.olimorris.dev";
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
-  title: "CodeCompanion",
-  description: "AI-powered coding, seamlessly in Neovim",
-  head: headers,
-  sitemap: { hostname: siteUrl },
-  themeConfig: {
-    logo: "https://github.com/user-attachments/assets/825fc040-9bc8-4743-be2a-71e257f8a7be",
-    nav: [
-      {
-        text: `${version}`,
-        items: [
-          {
-            text: "Changelog",
-            link: "https://github.com/olimorris/codecompanion.nvim/blob/main/CHANGELOG.md",
-          },
-          {
-            text: "Contributing",
-            link: "https://github.com/olimorris/codecompanion.nvim/blob/main/.github/contributing.md",
-          },
-        ],
-      },
-    ],
+export default withMermaid(
+  defineConfig({
+    mermaid: {
+      securityLevel: "loose", // Allows more flexibility
+      theme: "base", // Use base theme to allow CSS variables to take effect
+    },
+    // optionally set additional config for plugin itself with MermaidPluginConfig
+    title: "CodeCompanion",
+    description: "AI-powered coding, seamlessly in Neovim",
+    head: headers,
+    sitemap: { hostname: siteUrl },
+    themeConfig: {
+      logo: "https://github.com/user-attachments/assets/825fc040-9bc8-4743-be2a-71e257f8a7be",
+      nav: [
+        {
+          text: `${version}`,
+          items: [
+            {
+              text: "Changelog",
+              link: "https://github.com/olimorris/codecompanion.nvim/blob/main/CHANGELOG.md",
+            },
+            {
+              text: "Contributing",
+              link: "https://github.com/olimorris/codecompanion.nvim/blob/main/.github/contributing.md",
+            },
+          ],
+        },
+      ],
 
-    sidebar: [
-      { text: "Introduction", link: "/" },
-      { text: "Installation", link: "/installation" },
-      { text: "Getting Started", link: "/getting-started" },
-      {
-        text: "Configuration",
-        collapsed: true,
-        items: [
-          { text: "Introduction", link: "/configuration/introduction" },
-          { text: "Action Palette", link: "/configuration/action-palette" },
-          { text: "Adapters", link: "/configuration/adapters" },
-          { text: "Chat Buffer", link: "/configuration/chat-buffer" },
-          { text: "Inline Assistant", link: "/configuration/inline-assistant" },
-          { text: "Prompt Library", link: "/configuration/prompt-library" },
-          { text: "System Prompt", link: "/configuration/system-prompt" },
-          { text: "Others", link: "/configuration/others" },
-        ],
-      },
-      {
-        text: "Usage",
-        collapsed: false,
-        items: [
-          { text: "Introduction", link: "/usage/introduction" },
-          { text: "Action Palette", link: "/usage/action-palette" },
-          {
-            text: "Chat Buffer",
-            link: "/usage/chat-buffer/",
-            collapsed: true,
-            items: [
-              { text: "Agents/Tools", link: "/usage/chat-buffer/agents" },
-              {
-                text: "Slash Commands",
-                link: "/usage/chat-buffer/slash-commands",
-              },
-              { text: "Variables", link: "/usage/chat-buffer/variables" },
-            ],
-          },
-          { text: "Events", link: "/usage/events" },
-          { text: "Inline Assistant", link: "/usage/inline-assistant" },
-          { text: "User Interface", link: "/usage/ui" },
-          { text: "Workflows", link: "/usage/workflows" },
-        ],
+      sidebar: [
+        { text: "Introduction", link: "/" },
+        { text: "Installation", link: "/installation" },
+        { text: "Getting Started", link: "/getting-started" },
+        {
+          text: "Configuration",
+          collapsed: true,
+          items: [
+            { text: "Introduction", link: "/configuration/introduction" },
+            { text: "Action Palette", link: "/configuration/action-palette" },
+            { text: "Adapters", link: "/configuration/adapters" },
+            { text: "Chat Buffer", link: "/configuration/chat-buffer" },
+            {
+              text: "Inline Assistant",
+              link: "/configuration/inline-assistant",
+            },
+            { text: "Prompt Library", link: "/configuration/prompt-library" },
+            { text: "System Prompt", link: "/configuration/system-prompt" },
+            { text: "Others", link: "/configuration/others" },
+          ],
+        },
+        {
+          text: "Usage",
+          collapsed: false,
+          items: [
+            { text: "Introduction", link: "/usage/introduction" },
+            { text: "Action Palette", link: "/usage/action-palette" },
+            {
+              text: "Chat Buffer",
+              link: "/usage/chat-buffer/",
+              collapsed: true,
+              items: [
+                { text: "Agents/Tools", link: "/usage/chat-buffer/agents" },
+                {
+                  text: "Slash Commands",
+                  link: "/usage/chat-buffer/slash-commands",
+                },
+                { text: "Variables", link: "/usage/chat-buffer/variables" },
+              ],
+            },
+            { text: "Events", link: "/usage/events" },
+            { text: "Inline Assistant", link: "/usage/inline-assistant" },
+            { text: "User Interface", link: "/usage/ui" },
+            { text: "Workflows", link: "/usage/workflows" },
+          ],
+        },
+        {
+          text: "Extending the Plugin",
+          collapsed: false,
+          items: [
+            { text: "Creating Adapters", link: "/extending/adapters" },
+            { text: "Creating Prompts", link: "/extending/prompts" },
+            { text: "Creating Tools", link: "/extending/tools" },
+            { text: "Creating Workflows", link: "/extending/workflows" },
+            { text: "Creating Workspaces", link: "/extending/workspace" },
+          ],
+        },
+      ],
+
+      editLink: {
+        pattern:
+          "https://github.com/olimorris/codecompanion.nvim/edit/main/doc/:path",
+        text: "Edit this page on GitHub",
       },
-      {
-        text: "Extending the Plugin",
-        collapsed: false,
-        items: [
-          { text: "Creating Adapters", link: "/extending/adapters" },
-          { text: "Creating Prompts", link: "/extending/prompts" },
-          { text: "Creating Tools", link: "/extending/tools" },
-          { text: "Creating Workflows", link: "/extending/workflows" },
-          { text: "Creating Workspaces", link: "/extending/workspace" },
-        ],
+
+      footer: {
+        message: "Released under the MIT License.",
+        copyright: "Copyright © 2024-present Oli Morris",
       },
-    ],
 
-    editLink: {
-      pattern:
-        "https://github.com/olimorris/codecompanion.nvim/edit/main/doc/:path",
-      text: "Edit this page on GitHub",
-    },
+      socialLinks: [
+        {
+          icon: "github",
+          link: "https://github.com/olimorris/codecompanion.nvim",
+        },
+      ],
 
-    footer: {
-      message: "Released under the MIT License.",
-      copyright: "Copyright © 2024-present Oli Morris",
+      search: { provider: "local" },
     },
-
-    socialLinks: [
-      {
-        icon: "github",
-        link: "https://github.com/olimorris/codecompanion.nvim",
-      },
-    ],
-
-    search: { provider: "local" },
-  },
-});
+  }),
+);

doc/.vitepress/theme/vaporwave.css

@@ -91,3 +91,81 @@
   /* Override base background for dark mode */
   --vw-base-bg-mixer: 20%;
 }
+
+/* Mermaid */
+.mermaid * {
+  font-family: var(--vp-font-family-base) !important;
+  font-weight: var(--vp-font-weight-regular, 400) !important;
+}
+
+.mermaid .noteText,
+.mermaid .loopText {
+  font-size: 0.9em !important;
+}
+
+.mermaid .note {
+  fill: color-mix(in srgb, var(--vw-purple) 40%, var(--vw-base-bg)) !important;
+  stroke: var(--vw-purple) !important;
+}
+
+.mermaid .actor {
+  fill: color-mix(in srgb, var(--vw-blue) 20%, var(--vw-base-bg)) !important;
+  stroke: var(--vw-blue) !important;
+  font-weight: var(--vp-font-weight-medium, 500) !important;
+}
+
+.mermaid text.actor > tspan {
+  fill: var(--vw-base-fg) !important;
+  stroke: none !important;
+  font-weight: var(--vp-font-weight-medium, 500) !important;
+}
+
+.mermaid .messageText {
+  fill: var(--vw-base-fg) !important;
+  stroke: none !important;
+}
+
+.mermaid .messageLine0,
+.mermaid .messageLine1 {
+  stroke: var(--vw-green) !important;
+}
+
+.mermaid .sequenceNumber {
+  fill: var(--vw-base-bg) !important;
+}
+
+.mermaid .loopLine {
+  stroke: var(--vw-yellow) !important;
+}
+
+.mermaid .loopText > tspan {
+  fill: var(--vw-base-fg) !important;
+  stroke: none !important;
+}
+
+.mermaid .labelBox {
+  fill: color-mix(in srgb, var(--vw-yellow) 20%, var(--vw-base-bg)) !important;
+  stroke: var(--vw-yellow) !important;
+}
+
+.mermaid .labelText {
+  fill: var(--vw-base-fg) !important;
+}
+
+.mermaid line.divider {
+  stroke: var(--vw-purple) !important;
+}
+
+.mermaid .noteText > tspan {
+  fill: var(--vw-base-fg) !important;
+  stroke: none !important;
+  font-weight: var(--vp-font-weight-regular, 400) !important;
+}
+
+/* Adds styling for the activation boxes */
+.mermaid .activation0,
+.mermaid .activation1,
+.mermaid .activation2 {
+  fill: color-mix(in srgb, var(--vw-green) 20%, var(--vw-base-bg)) !important;
+  stroke: var(--vw-green) !important;
+}