refactor(chat): move rules files (#2993)

olimorris · web-flow · commit 7a0bb798cc8b · 2026-04-06T20:57:46.000+01:00
diff --git a/lua/codecompanion/actions/static.lua b/lua/codecompanion/actions/static.lua
@@ -1,8 +1,8 @@
 local codecompanion = require("codecompanion")
 local config = require("codecompanion.config")
 local registry = require("codecompanion.interactions.shared.registry")
-local rules = require("codecompanion.interactions.chat.rules")
-local rules_list = require("codecompanion.interactions.chat.rules.helpers").list()
+local rules = require("codecompanion.interactions.shared.rules")
+local rules_list = require("codecompanion.interactions.shared.rules.helpers").list()
 
 return {
   -- Chat
diff --git a/lua/codecompanion/init.lua b/lua/codecompanion/init.lua
@@ -162,7 +162,7 @@ CodeCompanion.chat = function(args)
   end
 
   -- Add rules to the chat buffer
-  local rules_cb = require("codecompanion.interactions.chat.rules.helpers").add_callbacks(args)
+  local rules_cb = require("codecompanion.interactions.shared.rules.helpers").add_callbacks(args)
   if rules_cb then
     args.callbacks = rules_cb
   end
diff --git a/lua/codecompanion/interactions/chat/init.lua b/lua/codecompanion/interactions/chat/init.lua
@@ -1900,7 +1900,7 @@ function Chat.toggle(args)
       chat_opts.adapter = adapter
     end
     -- Add rules to the chat buffer
-    local rules_cb = require("codecompanion.interactions.chat.rules.helpers").add_callbacks(chat_opts)
+    local rules_cb = require("codecompanion.interactions.shared.rules.helpers").add_callbacks(chat_opts)
     if rules_cb then
       chat_opts.callbacks = rules_cb
     end
diff --git a/lua/codecompanion/interactions/init.lua b/lua/codecompanion/interactions/init.lua
@@ -2,7 +2,7 @@ local adapters = require("codecompanion.adapters")
 local config = require("codecompanion.config")
 
 local log = require("codecompanion.utils.log")
-local rules_helpers = require("codecompanion.interactions.chat.rules.helpers")
+local rules_helpers = require("codecompanion.interactions.shared.rules.helpers")
 
 ---A user may specify an adapter for the prompt
 ---@param interaction CodeCompanion.Interactions
diff --git a/lua/codecompanion/interactions/inline/init.lua b/lua/codecompanion/interactions/inline/init.lua
@@ -762,7 +762,7 @@ function Inline:to_chat()
   }
 
   -- Add rules to the chat buffer
-  local rules_cb = require("codecompanion.interactions.chat.rules.helpers").add_callbacks(chat_opts)
+  local rules_cb = require("codecompanion.interactions.shared.rules.helpers").add_callbacks(chat_opts)
   if rules_cb then
     chat_opts.callbacks = rules_cb
   end
diff --git a/lua/codecompanion/interactions/shared/rules/helpers.lua b/lua/codecompanion/interactions/shared/rules/helpers.lua
@@ -120,7 +120,7 @@ function M.add_callbacks(args, rules_name)
     if current then
       -- Ensure that we extend any existing callbacks
       args.callbacks = utils.callbacks_extend(args.callbacks, "on_created", function(chat)
-        require("codecompanion.interactions.chat.rules").add_to_chat_from_config(chat, {
+        require("codecompanion.interactions.shared.rules").add_to_chat_from_config(chat, {
           name = name,
           opts = current.opts,
           parser = current.parser,
diff --git a/lua/codecompanion/interactions/shared/rules/init.lua b/lua/codecompanion/interactions/shared/rules/init.lua
@@ -1,7 +1,7 @@
 local file = require("codecompanion.utils.files")
-local helpers = require("codecompanion.interactions.chat.rules.helpers")
+local helpers = require("codecompanion.interactions.shared.rules.helpers")
 local log = require("codecompanion.utils.log")
-local parsers = require("codecompanion.interactions.chat.rules.parsers")
+local parsers = require("codecompanion.interactions.shared.rules.parsers")
 
 ---@class CodeCompanion.Chat.Rules.ProcessedFile
 ---@field name string The name of the rules file
diff --git a/lua/codecompanion/interactions/shared/rules/parsers/claude.lua b/lua/codecompanion/interactions/shared/rules/parsers/claude.lua
@@ -1,6 +1,6 @@
 --[[
 ===============================================================================
-    File:       codecompanion.interactions/chat/rules/parsers/claude.lua
+    File:       codecompanion.interactions.shared.rules/parsers/claude.lua
     Author:     Oli Morris
 -------------------------------------------------------------------------------
     Description:
diff --git a/lua/codecompanion/interactions/shared/rules/parsers/cli.lua b/lua/codecompanion/interactions/shared/rules/parsers/cli.lua
@@ -1,6 +1,6 @@
 --[[
 ===============================================================================
-    File:       codecompanion.interactions/chat/rules/parsers/cli.lua
+    File:       codecompanion.interactions.shared.rules/parsers/cli.lua
     Author:     Oli Morris
 -------------------------------------------------------------------------------
     Description:
diff --git a/lua/codecompanion/interactions/shared/rules/parsers/codecompanion.lua b/lua/codecompanion/interactions/shared/rules/parsers/codecompanion.lua
@@ -1,6 +1,6 @@
 --[[
 ===============================================================================
-    File:       codecompanion.interactions/chat/rules/parsers/codecompanion.lua
+    File:       codecompanion.interactions.shared.rules/parsers/codecompanion.lua
     Author:     Oli Morris
 -------------------------------------------------------------------------------
     Description:
diff --git a/lua/codecompanion/interactions/shared/rules/parsers/init.lua b/lua/codecompanion/interactions/shared/rules/parsers/init.lua
@@ -38,7 +38,7 @@ function M.resolve(parser)
 
   if type(parser) == "string" then
     -- The parser might be a CodeCompanion default one ...
-    ok, resolved = pcall(require, "codecompanion.interactions.chat.rules.parsers." .. parser)
+    ok, resolved = pcall(require, "codecompanion.interactions.shared.rules.parsers." .. parser)
     if ok then
       return resolved
     end
diff --git a/lua/codecompanion/interactions/shared/rules/parsers/none.lua b/lua/codecompanion/interactions/shared/rules/parsers/none.lua
diff --git a/lua/codecompanion/interactions/shared/slash_commands/rules.lua b/lua/codecompanion/interactions/shared/slash_commands/rules.lua
@@ -1,5 +1,5 @@
-local helpers = require("codecompanion.interactions.chat.rules.helpers")
-local rules = require("codecompanion.interactions.chat.rules")
+local helpers = require("codecompanion.interactions.shared.rules.helpers")
+local rules = require("codecompanion.interactions.shared.rules")
 
 ---A picker for rules
 ---@param chat? CodeCompanion.Chat
diff --git a/tests/interactions/shared/rules/parsers/test_claude_parser.lua b/tests/interactions/shared/rules/parsers/test_claude_parser.lua
@@ -37,7 +37,7 @@ T["Claude parser"] = function()
   -- Run the claude parser on the markdown content and return parsed result
   local parsed = child.lua(string.format(
     [[
-    local p = require("codecompanion.interactions.chat.rules.parsers.claude")
+    local p = require("codecompanion.interactions.shared.rules.parsers.claude")
     local md = table.concat(vim.fn.readfile(%q), "\n") .. "\n"
 
     -- Send the content to the parser
diff --git a/tests/interactions/shared/rules/parsers/test_cli_parser.lua b/tests/interactions/shared/rules/parsers/test_cli_parser.lua
@@ -35,7 +35,7 @@ T["CLI parser"] = function()
 
   local parsed = child.lua(string.format(
     [[
-    local p = require("codecompanion.interactions.chat.rules.parsers.cli")
+    local p = require("codecompanion.interactions.shared.rules.parsers.cli")
     local md = table.concat(vim.fn.readfile(%q), "\n") .. "\n"
 
     local res = p({ content = md })
diff --git a/tests/interactions/shared/rules/parsers/test_codecompanion_parser.lua b/tests/interactions/shared/rules/parsers/test_codecompanion_parser.lua
@@ -45,7 +45,7 @@ T["Claude parser"] = function()
   -- Run the claude parser on the markdown content and return parsed result
   local parsed = child.lua(string.format(
     [[
-      local p = require("codecompanion.interactions.chat.rules.parsers.codecompanion")
+      local p = require("codecompanion.interactions.shared.rules.parsers.codecompanion")
       local md = table.concat(vim.fn.readfile(%q), "\n") .. "\n"
 
       -- Send the content to the parser
diff --git a/tests/interactions/shared/rules/parsers/test_parsers.lua b/tests/interactions/shared/rules/parsers/test_parsers.lua
@@ -28,7 +28,7 @@ T["parsers.resolve()"]["handles function parsers"] = function()
   ]])
 
   local f_res = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     local p = parsers.resolve("fn_par")
     return p.content({ content = "b\n" })
   ]])
@@ -38,7 +38,7 @@ end
 T["parsers.resolve()"]["supports builtin module name and file-based parser"] = function()
   -- Mock the built-in parser module
   child.lua([[
-    package.loaded["codecompanion.interactions.chat.rules.parsers.builtinmod"] = {
+    package.loaded["codecompanion.interactions.shared.rules.parsers.builtinmod"] = {
       content = function(p) return "BUILTIN:" .. (p.content or "") end
     }
     package.loaded['codecompanion.config'] = {
@@ -47,7 +47,7 @@ T["parsers.resolve()"]["supports builtin module name and file-based parser"] = f
   ]])
 
   local built = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     local p = parsers.resolve("builtin_parser")
     return p.content({ content = "I am a builtin parser\n" })
   ]])
@@ -66,10 +66,10 @@ T["parsers.resolve()"]["supports builtin module name and file-based parser"] = f
     tmp
   ))
 
-  child.lua([[ package.loaded['codecompanion.interactions.chat.rules.parsers'] = nil ]])
+  child.lua([[ package.loaded['codecompanion.interactions.shared.rules.parsers'] = nil ]])
 
   local file_res = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     local p = parsers.resolve("file_parser")
     return p.content({ content = "I am a file-based parser\n" })
   ]])
@@ -92,19 +92,19 @@ T["parsers.parser()"]["uses file-level parser before group-level, otherwise retu
   ]])
 
   local file_first = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     return parsers.parse({ parser = "file_parser", content = "1\n" }, "group_parser")
   ]])
   h.eq(file_first.content, "1\n")
 
   local group_used = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     return parsers.parse({ content = "2\n" }, "group_parser")
   ]])
   h.eq(group_used.content, "2\n")
 
   local raw = child.lua([[
-    local parsers = require("codecompanion.interactions.chat.rules.parsers")
+    local parsers = require("codecompanion.interactions.shared.rules.parsers")
     return parsers.parse({ content = "RAW\n" }, nil)
   ]])
   h.eq(raw.content, "RAW\n")
diff --git a/tests/interactions/shared/rules/test_rules.lua b/tests/interactions/shared/rules/test_rules.lua
@@ -20,7 +20,7 @@ T["Rules:make()"]["with string file (no parser)"] = function()
   child.fn.writefile({ content }, tmp)
 
   child.lua([[
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -31,7 +31,7 @@ T["Rules:make()"]["with string file (no parser)"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({ name = "literal_file_test", files = { %q } }):make({ chat = { id = "test_chat" } })
   ]],
     tmp
@@ -63,7 +63,7 @@ T["Rules:make()"]["applies parser when provided at file level"] = function()
         }
       }
     }
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -73,7 +73,7 @@ T["Rules:make()"]["applies parser when provided at file level"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({
       name = "parser_test",
       files = { { path = %q, parser = "prefix" } },
@@ -100,7 +100,7 @@ T["Rules:make()"]["with directory file (no parser)"] = function()
   child.fn.writefile({ "second file" }, f2)
 
   child.lua([[
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -111,7 +111,7 @@ T["Rules:make()"]["with directory file (no parser)"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({ name = "directory_scan_test", files = { %q } }):make({ chat = { id = "test_chat" } })
   ]],
     tmpdir
@@ -142,7 +142,7 @@ T["Rules:make()"]["with glob pattern"] = function()
   child.fn.writefile({ "beta" }, f2)
 
   child.lua([[
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -153,7 +153,7 @@ T["Rules:make()"]["with glob pattern"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({ name = "glob_pattern_test", files = { %q } }):make({ chat = { id = "test_chat" } })
   ]],
     tmpdir .. "/*"
@@ -188,7 +188,7 @@ T["Rules:make()"]["with directory and file patterns"] = function()
   child.fn.writefile({ "test" }, f4)
 
   child.lua([[
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -199,7 +199,7 @@ T["Rules:make()"]["with directory and file patterns"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({
       name = "pattern_filter_test",
       files = {
@@ -233,7 +233,7 @@ T["Rules:make()"]["with directory and files patterns deduplicates"] = function()
   child.fn.writefile({ "claude rules" }, f1)
 
   child.lua([[
-    package.loaded['codecompanion.interactions.chat.rules.helpers'] = {
+    package.loaded['codecompanion.interactions.shared.rules.helpers'] = {
       add_context = function(processed, chat)
         _G.test_processed = processed
         _G.test_chat = chat
@@ -244,7 +244,7 @@ T["Rules:make()"]["with directory and files patterns deduplicates"] = function()
 
   child.lua(string.format(
     [[
-    local Rules = require("codecompanion.interactions.chat.rules.init")
+    local Rules = require("codecompanion.interactions.shared.rules.init")
     Rules.new({
       name = "deduplication_test",
       files = {
@@ -362,7 +362,7 @@ T["add_files_or_buffers() prevents duplicate files from being added"] = function
     h.setup_plugin()
 
     local chat_helpers = require("codecompanion.interactions.chat.helpers")
-    local rules_helpers = require("codecompanion.interactions.chat.rules.helpers")
+    local rules_helpers = require("codecompanion.interactions.shared.rules.helpers")
 
     local chat = {
       messages = {},
@@ -414,7 +414,7 @@ T["add_context() prevents duplicate rules context from being added"] = function(
     local h = require("tests.helpers")
     h.setup_plugin()
 
-    local rules_helpers = require("codecompanion.interactions.chat.rules.helpers")
+    local rules_helpers = require("codecompanion.interactions.shared.rules.helpers")
     local chat_helpers = require("codecompanion.interactions.chat.helpers")
 
     local has_context_call_count = 0

Original file line number	Diff line number	Diff line change
`@@ -762,7 +762,7 @@ function Inline:to_chat()`
`762`	`762`	`}`
`763`	`763`
`764`	`764`	`-- Add rules to the chat buffer`
`765`		`- local rules_cb = require("codecompanion.interactions.chat.rules.helpers").add_callbacks(chat_opts)`
	`765`	`+ local rules_cb = require("codecompanion.interactions.shared.rules.helpers").add_callbacks(chat_opts)`
`766`	`766`	`if rules_cb then`
`767`	`767`	`chat_opts.callbacks = rules_cb`
`768`	`768`	`end`