Add global rules support

Author: ericdallo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add support for global rules.
+
 ## 0.3.1
 
 - Improve default model logic to check for configs and env vars of known models.

docs/configuration.md

@@ -43,8 +43,8 @@ ECA_CONFIG='{"myConfig": "my_value"}' eca server
 
 ## Rules
 
-Rules are contexts that are passed to the LLM during a prompt.
-There are 2 possible ways following this order of priority:
+Rules are contexts that are passed to the LLM during a prompt and are useful to tune prompts or LLM behavior.
+There are 3 possible ways following this order of priority:
 
 ### Project file
 
@@ -59,6 +59,19 @@ name: Funny rule
 - Talk funny like Mickey!
 ```
 
+### Global file
+
+A `$XDG_CONFIG_HOME/eca/rules` or `~/.config/eca/rules` folder containing `.md` files with the rules.
+
+`~/.config/eca/rules/talk_funny.md`
+```markdown
+--- 
+name: Funny rule
+---
+
+- Talk funny like Mickey!
+```
+
 ### Config 
 
 Just add to your config the `:rules` pointing to `.md` files that will be searched from the workspace root if not an absolute path:

docs/protocol.md

@@ -252,7 +252,7 @@ interface ChatPromptParams {
     /**
      * The chat behavior used by server to handle chat communication and actions.
      */
-    behavior?: 'agent' | 'ask';
+    behavior?: ChatBehavior;
 
     /**
      * Optional contexts about the current workspace.

src/eca/features/rules.clj

@@ -1,12 +1,26 @@
 (ns eca.features.rules
   (:require
    [babashka.fs :as fs]
+   [clojure.java.io :as io]
    [clojure.string :as string]
+   [eca.config :as config]
    [eca.shared :as shared]))
 
 (set! *warn-on-reflection* true)
 
-(defn ^:private file-rules [roots]
+(defn ^:private global-file-rules []
+  (let [xdg-config-home (or (config/get-env "XDG_CONFIG_HOME")
+                            (io/file (config/get-property "user.home") ".config"))
+        rules-dir (io/file xdg-config-home "eca" "rules")]
+    (when (fs/exists? rules-dir)
+      (map (fn [file]
+             {:name (fs/file-name file)
+              :path (str (fs/canonicalize file))
+              :type :user-global-file
+              :content (slurp (fs/file file))})
+           (fs/list-dir rules-dir)))))
+
+(defn ^:private local-file-rules [roots]
   (->> roots
        (mapcat (fn [{:keys [uri]}]
                  (let [rules-dir (fs/file (shared/uri->filename uri) ".eca" "rules")]
@@ -15,7 +29,7 @@
        (map (fn [file]
               {:name (fs/file-name file)
                :path (str (fs/canonicalize file))
-               :type :user-file
+               :type :user-local-file
                :content (slurp (fs/file file))}))))
 
 (defn ^:private config-rules [config roots]
@@ -55,4 +69,5 @@
            variables))
         (concat (system-rules)
                 (config-rules config roots)
-                (file-rules roots))))
+                (global-file-rules)
+                (local-file-rules roots))))

test/eca/features/rules_test.clj

@@ -2,6 +2,7 @@
   (:require
    [babashka.fs :as fs]
    [clojure.test :refer [deftest is testing]]
+   [eca.config :as config]
    [eca.features.rules :as f.rules]
    [eca.test-helper :as h]
    [matcher-combinators.matchers :as m]
@@ -20,7 +21,7 @@
     (testing "absolute config rule"
       (with-redefs [clojure.core/slurp (constantly "MY_RULE_CONTENT")
                     fs/absolute? (constantly true)
-                    fs/exists? (constantly true)
+                    fs/exists? #(= (h/file-path "/path/to/my-rule.md") %)
                     fs/canonicalize identity
                     fs/file-name (constantly "cool-name")]
         (let [config {:rules [{:path (h/file-path "/path/to/my-rule.md")}]}]
@@ -33,29 +34,44 @@
 
     (testing "relative config rule"
       (with-redefs [fs/absolute? (constantly false)
-                    fs/exists? (constantly true)
+                    fs/exists? #(contains? #{(h/file-path "/my/project/.eca/rules")
+                                             (h/file-path "/my/project/.foo/cool-rule.md")} (str %))
                     fs/list-dir (constantly [])
                     fs/canonicalize identity
                     fs/file-name (constantly "cool-name")
                     clojure.core/slurp (constantly "MY_RULE_CONTENT")]
         (let [config {:rules [{:path ".foo/cool-rule.md"}]}
               roots [{:uri (h/file-uri "file:///my/project")}]]
           (is (match?
-                (m/embeds [{:type :user-config
-                            :path (h/file-path "/my/project/.foo/cool-rule.md")
-                            :name "cool-name"
-                            :content "MY_RULE_CONTENT"}])
-                (f.rules/all config roots vars))))))
+               (m/embeds [{:type :user-config
+                           :path (h/file-path "/my/project/.foo/cool-rule.md")
+                           :name "cool-name"
+                           :content "MY_RULE_CONTENT"}])
+               (f.rules/all config roots vars))))))
 
-    (testing "file rules"
-      (with-redefs [fs/exists? (constantly true)
+    (testing "local file rules"
+      (with-redefs [fs/exists? #(= (h/file-path "/my/project/.eca/rules") (str %))
+                    fs/list-dir (constantly [(fs/path "cool.md")])
+                    fs/canonicalize identity
+                    fs/file-name (constantly "cool-name")
+                    clojure.core/slurp (constantly "MY_RULE_CONTENT")]
+        (let [roots [{:uri (h/file-uri "file:///my/project")}]]
+          (is (match?
+               (m/embeds [{:type :user-local-file
+                           :path "cool.md"
+                           :name "cool-name"
+                           :content "MY_RULE_CONTENT"}])
+               (f.rules/all {} roots vars))))))
+    (testing "global file rules"
+      (with-redefs [config/get-env (constantly (h/file-path "/home/someuser/.config"))
+                    fs/exists? #(= (h/file-path "/home/someuser/.config/eca/rules") (str %))
                     fs/list-dir (constantly [(fs/path "cool.md")])
                     fs/canonicalize identity
                     fs/file-name (constantly "cool-name")
                     clojure.core/slurp (constantly "MY_RULE_CONTENT")]
         (let [roots [{:uri (h/file-uri "file:///my/project")}]]
           (is (match?
-               (m/embeds [{:type :user-file
+               (m/embeds [{:type :user-global-file
                            :path "cool.md"
                            :name "cool-name"
                            :content "MY_RULE_CONTENT"}])