feat: Support loading Cursor Rules

Author: huytd

build.sbt

@@ -12,11 +12,12 @@ lazy val root = project
       "io.circe" %% "circe-core" % "0.14.5",
       "io.circe" %% "circe-generic" % "0.14.5",
       "io.circe" %% "circe-parser" % "0.14.5",
-      "org.jline" % "jline" % "3.21.0"
+      "org.jline" % "jline" % "3.21.0",
+      "com.github.scopt" %% "scopt" % "4.1.0"
     )
   )
 
 enablePlugins(JavaAppPackaging)
 packageName := "supercoder"
-mainClass := Some("com.supercoder.run")
+mainClass := Some("com.supercoder.Main")
 maintainer := "[email protected]"

src/main/scala/com/supercoder/Main.scala

@@ -2,10 +2,19 @@ package com.supercoder
 
 import com.supercoder.ui.TerminalChat
 import com.supercoder.agents.CoderAgent
+import com.supercoder.config.ArgsParser
+import com.supercoder.lib.CursorRulesLoader
 
 object Main {
   def main(args: Array[String]): Unit = {
-    val agent = new CoderAgent()
-    TerminalChat.run(agent)
+    ArgsParser.parse(args) match {
+      case Some(config) =>
+        val additionalPrompt = if config.useCursorRules then CursorRulesLoader.loadRules() else ""
+        val agent = new CoderAgent(additionalPrompt)
+        TerminalChat.run(agent)
+      case None =>
+        // invalid options, usage error message is already printed by scopt
+        sys.exit(1)
+    }
   }
 }

src/main/scala/com/supercoder/agents/CoderAgent.scala

@@ -21,8 +21,8 @@ The discussion is about the code of the current project/folder. Always use the r
 project if you are unsure before giving answer.
 """
 
-class CoderAgent()
-    extends BaseChatAgent(coderAgentPrompt) {
+class CoderAgent(additionalPrompt: String = "")
+    extends BaseChatAgent(coderAgentPrompt + additionalPrompt) {
 
   final val availableTools = List(
     CodeSearchTool,

src/main/scala/com/supercoder/config/ArgsParser.scala

@@ -0,0 +1,22 @@
+package com.supercoder.config
+
+import scopt.OParser
+
+case class Config(useCursorRules: Boolean = false)
+
+object ArgsParser {
+  def parse(args: Array[String]): Option[Config] = {
+    val builder = OParser.builder[Config]
+    val parser = {
+      import builder._
+      OParser.sequence(
+        programName("SuperCoder"),
+        opt[String]('c', "use-cursor-rules")
+          .action((x, c) => c.copy(useCursorRules = (x == "true")))
+          .text("use Cursor rules for the agent"),
+        help("help").text("prints this usage text")
+      )
+    }
+    OParser.parse(parser, args, Config())
+  }
+}

src/main/scala/com/supercoder/lib/CursorRulesLoader.scala

@@ -0,0 +1,54 @@
+package com.supercoder.lib
+
+import java.nio.file.{Files, Paths, Path}
+import java.nio.charset.StandardCharsets
+import scala.jdk.CollectionConverters._
+
+object CursorRulesLoader {
+  /**
+   * Loads all *.mdc files in the project's .cursor/rules directory, then reads the .cursorrules file in the project's root,
+   * combines them and returns them as a single string.
+   * 
+   * The returned string consists of the content of all .mdc files (separated by newlines) followed by a newline and the 
+   * content of the .cursorrules file.
+   */
+  def loadRules(): String = {
+    // Determine the project root directory
+    val projectRoot = Paths.get(System.getProperty("user.dir"))
+
+    // Define the path for .cursorrules file in the project's root
+    val cursorRulesFile: Path = projectRoot.resolve(".cursorrules")
+
+    // Define the directory path for .cursor/rules
+    val rulesDir: Path = projectRoot.resolve(Paths.get(".cursor", "rules"))
+
+    // Initialize content for .mdc files
+    val mdcContent: String = if (Files.exists(rulesDir) && Files.isDirectory(rulesDir)) {
+      // List all files in the rulesDir ending with .mdc
+      val mdcFiles = Files.list(rulesDir).iterator().asScala
+        .filter(path => Files.isRegularFile(path) && path.getFileName.toString.endsWith(".mdc"))
+        .toList
+      // Read each file and concatenate contents separated by newline
+      mdcFiles.map { path =>
+        new String(Files.readAllBytes(path), StandardCharsets.UTF_8)
+      }.mkString("\n")
+    } else {
+      ""
+    }
+
+    // Read the .cursorrules file if it exists
+    val mainRulesContent: String = if (Files.exists(cursorRulesFile) && Files.isRegularFile(cursorRulesFile)) {
+      new String(Files.readAllBytes(cursorRulesFile), StandardCharsets.UTF_8)
+    } else {
+      ""
+    }
+
+    // Combine the content from .mdc files and .cursorrules file
+    // Separating the two parts with a newline if both are non-empty
+    if (mdcContent.nonEmpty && mainRulesContent.nonEmpty) {
+      mdcContent + "\n" + mainRulesContent
+    } else {
+      mdcContent + mainRulesContent
+    }
+  }
+}