Adding the sample chatmode from https://code.visualstudio.com/docs/copilot/chat/chat-modes\#_custom-chat-modes

Fixed the update script to support chatmodes

README.md

@@ -58,6 +58,15 @@ Ready-to-use prompt templates for specific development scenarios and tasks. Thes
 
 > 💡 **Usage**: Use `/prompt-name` in VS Code chat or run `Chat: Run Prompt` command. Prompt files support variables like `${input:name}` for dynamic content.
 
+## 🎭 Custom Chat Modes
+
+Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows. These `.chatmode.md` files can be loaded by selecting "Chat with Custom Mode" from the Copilot menu.
+
+- [Planning mode instructions](chatmodes/planner.chatmode.md) - Generate an implementation plan for new features or refactoring existing code.
+
+
+> 💡 **Usage**: Create a `.chatmode.md` file in your workspace or repository, then select "Chat with Custom Mode" from the Copilot Chat menu and select your chat mode file.
+
 ## 📚 Additional Resources
 
 - [VS Code Copilot Customization Documentation](https://code.visualstudio.com/docs/copilot/copilot-customization) - Official Microsoft documentation

chatmodes/planner.chatmode.md

@@ -0,0 +1,14 @@
+---
+description: Generate an implementation plan for new features or refactoring existing code.
+tools: ['codebase', 'fetch', 'findTestFiles', 'githubRepo', 'search', 'usages']
+---
+# Planning mode instructions
+You are in planning mode. Your task is to generate an implementation plan for a new feature or for refactoring existing code.
+Don't make any code edits, just generate a plan.
+
+The plan consists of a Markdown document that describes the implementation plan, including the following sections:
+
+* Overview: A brief description of the feature or refactoring task.
+* Requirements: A list of requirements for the feature or refactoring task.
+* Implementation Steps: A detailed list of steps to implement the feature or refactoring task.
+* Testing: A list of tests that need to be implemented to verify the feature or refactoring task.

update-readme.js

@@ -8,7 +8,7 @@ function extractTitle(filePath) {
     const content = fs.readFileSync(filePath, "utf8");
 
     // For prompt files, look for the main heading after frontmatter
-    if (filePath.includes(".prompt.md")) {
+    if (filePath.includes(".prompt.md") || filePath.includes(".chatmode.md")) {
       const lines = content.split("\n");
       let inFrontmatter = false;
       let frontmatterEnded = false;
@@ -29,7 +29,10 @@ function extractTitle(filePath) {
       }
 
       // For prompt files without heading, clean up filename
-      const basename = path.basename(filePath, ".prompt.md");
+      const basename = path.basename(
+        filePath,
+        filePath.includes(".prompt.md") ? ".prompt.md" : ".chatmode.md"
+      );
       return basename
         .replace(/[-_]/g, " ")
         .replace(/\b\w/g, (l) => l.toUpperCase());
@@ -129,6 +132,7 @@ function extractDescription(filePath) {
 function generateReadme() {
   const instructionsDir = path.join(__dirname, "instructions");
   const promptsDir = path.join(__dirname, "prompts");
+  const chatmodesDir = path.join(__dirname, "chatmodes");
   const readmePath = path.join(__dirname, "README.md");
 
   // Check if README file exists
@@ -154,6 +158,14 @@ function generateReadme() {
     .filter((file) => file.endsWith(".prompt.md"))
     .sort();
 
+  // Get all chat mode files - we'll use this to update the chat modes section
+  const chatmodeFiles = fs.existsSync(chatmodesDir)
+    ? fs
+        .readdirSync(chatmodesDir)
+        .filter((file) => file.endsWith(".chatmode.md"))
+        .sort()
+    : [];
+
   // Update instructions section - rebuild the whole list
   const instructionsSection = currentReadme.match(
     /## 📋 Custom Instructions\n\nTeam and project-specific instructions.+?(?=\n\n>)/s
@@ -204,11 +216,7 @@ function generateReadme() {
     (file) => !existingPromptLinks.includes(file)
   );
 
-  if (newPromptFiles.length === 0) {
+  if (newPromptFiles.length > 0) {
-    console.log("No new prompts to add.");
-    return currentReadme; // No changes needed
-  }
-
     console.log(`Found ${newPromptFiles.length} new prompts to add.`);
 
     // Create content for new prompts (in Uncategorised section)
@@ -216,7 +224,8 @@ function generateReadme() {
 
     // Check if we already have an Uncategorised section
     const uncategorisedSectionRegex = /### Uncategorised\n/;
-  const hasUncategorisedSection = uncategorisedSectionRegex.test(currentReadme);
+    const hasUncategorisedSection =
+      uncategorisedSectionRegex.test(currentReadme);
 
     // If we need to add the section header
     if (!hasUncategorisedSection) {
@@ -324,7 +333,9 @@ function generateReadme() {
             newPromptsContent +
             currentReadme.slice(insertPos);
         } else {
-        console.error("Could not find a suitable place to insert new prompts.");
+          console.error(
+            "Could not find a suitable place to insert new prompts."
+          );
         }
       } else {
         console.error(
@@ -332,6 +343,80 @@ function generateReadme() {
         );
       }
     }
+  } else {
+    console.log("No new prompts to add.");
+  }
+
+  // Update chat modes section
+  const chatmodesSection = currentReadme.match(
+    /## 🎭 Custom Chat Modes\n\nCustom chat modes define.+?(?=\n\n>)/s
+  );
+
+  if (chatmodesSection && chatmodeFiles.length > 0) {
+    let chatmodesListContent = "\n\n";
+
+    // Generate list of chat mode links
+    for (const file of chatmodeFiles) {
+      const filePath = path.join(chatmodesDir, file);
+      const title = extractTitle(filePath);
+      const link = `chatmodes/${file}`;
+
+      // Check if there's a description in the frontmatter
+      const customDescription = extractDescription(filePath);
+
+      if (customDescription) {
+        // Use the description from frontmatter
+        chatmodesListContent += `- [${title}](${link}) - ${customDescription}\n`;
+      } else {
+        // Just add a link without description
+        chatmodesListContent += `- [${title}](${link})\n`;
+      }
+    }
+
+    // Replace the current chat modes section with the updated one
+    const newChatmodesSection =
+      '## 🎭 Custom Chat Modes\n\nCustom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows. These `.chatmode.md` files can be loaded by selecting "Chat with Custom Mode" from the Copilot menu.' +
+      chatmodesListContent;
+
+    currentReadme = currentReadme.replace(
+      chatmodesSection[0],
+      newChatmodesSection
+    );
+  } else if (!chatmodesSection && chatmodeFiles.length > 0) {
+    // Chat modes section doesn't exist yet but we have chat mode files
+    const chatmodesListContent = chatmodeFiles
+      .map((file) => {
+        const filePath = path.join(chatmodesDir, file);
+        const title = extractTitle(filePath);
+        const link = `chatmodes/${file}`;
+        const customDescription = extractDescription(filePath);
+
+        if (customDescription) {
+          return `- [${title}](${link}) - ${customDescription}`;
+        } else {
+          return `- [${title}](${link})`;
+        }
+      })
+      .join("\n");
+
+    const newChatmodesSection =
+      "## 🎭 Custom Chat Modes\n\n" +
+      'Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows. These `.chatmode.md` files can be loaded by selecting "Chat with Custom Mode" from the Copilot menu.\n\n' +
+      chatmodesListContent +
+      '\n\n> 💡 **Usage**: Create a `.chatmode.md` file in your workspace or repository, then select "Chat with Custom Mode" from the Copilot Chat menu and select your chat mode file.\n';
+
+    // Insert before Additional Resources section
+    const additionalResourcesPos = currentReadme.indexOf(
+      "## 📚 Additional Resources"
+    );
+    if (additionalResourcesPos !== -1) {
+      currentReadme =
+        currentReadme.slice(0, additionalResourcesPos) +
+        newChatmodesSection +
+        "\n" +
+        currentReadme.slice(additionalResourcesPos);
+    }
+  }
 
   return currentReadme;
 }