unit tests added

Author: spivx

app/api/generate/[fileName]/route.ts

@@ -2,7 +2,18 @@ import { NextRequest, NextResponse } from 'next/server'
 import { readFile } from 'fs/promises'
 import path from 'path'
 import type { WizardResponses } from '@/types/wizard'
-import { getTemplateConfig } from '@/lib/template-config'
+import { getTemplateConfig, type TemplateKey } from '@/lib/template-config'
+
+// Helper function to map output file types to template types
+function mapOutputFileToTemplateType(outputFile: string): string {
+    const mapping: Record<string, string> = {
+        'instructions-md': 'copilot-instructions',
+        'cursor-rules': 'cursor-rules',
+        'json-rules': 'json-rules',
+        'agents-md': 'agents'
+    }
+    return mapping[outputFile] || outputFile
+}
 
 export async function POST(
     request: NextRequest,
@@ -13,7 +24,24 @@ export async function POST(
         const body = await request.json()
         const responses: WizardResponses = body
 
-        const templateConfig = getTemplateConfig(fileName)
+        // Determine template configuration based on the request
+        let templateConfig
+
+        // Check if this is a combination-based request
+        if (responses.preferredIde && responses.outputFile) {
+            const templateKey: TemplateKey = {
+                ide: responses.preferredIde,
+                templateType: mapOutputFileToTemplateType(responses.outputFile),
+                framework: responses.frameworkSelection || undefined
+            }
+            templateConfig = getTemplateConfig(templateKey)
+        }
+
+        // Fallback to legacy fileName-based approach
+        if (!templateConfig) {
+            templateConfig = getTemplateConfig(fileName)
+        }
+
         if (!templateConfig) {
             return NextResponse.json(
                 { error: `Template not found for fileName: ${fileName}` },

components/instructions-wizard.tsx

@@ -17,6 +17,9 @@ import commitsData from "@/data/commits.json"
 import filesData from "@/data/files.json"
 import { InstructionsAnswerCard } from "./instructions-answer-card"
 
+import { ANALYTICS_EVENTS } from "@/lib/analytics-events"
+import { track } from "@/lib/mixpanel"
+
 const FRAMEWORK_STEP_ID = "frameworks"
 const FRAMEWORK_QUESTION_ID = "frameworkSelection"
 
@@ -504,6 +507,7 @@ export function InstructionsWizard({ onClose }: InstructionsWizardProps) {
   }
 
   const generateInstructionsFile = async () => {
+    track(ANALYTICS_EVENTS.CREATE_INSTRUCTIONS_FILE)
     // Create a JSON object with question IDs as keys and their answers as values
     const questionsAndAnswers: WizardResponses = {
       preferredIde: null,
@@ -577,6 +581,14 @@ export function InstructionsWizard({ onClose }: InstructionsWizardProps) {
       })
     })
 
+    // Ensure we have the combination data for the API
+    // The API will now use preferredIde + outputFile + frameworkSelection to determine the template
+    console.log('Template combination data:', {
+      ide: questionsAndAnswers.preferredIde,
+      outputFile: questionsAndAnswers.outputFile,
+      framework: questionsAndAnswers.frameworkSelection
+    })
+
     // console.log('Questions and Answers JSON:', JSON.stringify(questionsAndAnswers, null, 2))
 
     // Call the API to generate the instructions file

data/files.json

@@ -8,6 +8,15 @@
         "icon": "markdown",
         "docs": "https://docs.github.com/en/copilot"
     },
+    {
+        "id": "agents-md",
+        "label": "Agents Development Guide",
+        "filename": "agents.md",
+        "format": "markdown",
+        "enabled": true,
+        "icon": "markdown",
+        "docs": "https://docs.github.com/en/copilot"
+    },
     {
         "id": "cursor-rules",
         "label": "Cursor Rules",
@@ -25,4 +34,4 @@
         "icon": "json",
         "docs": "https://json-schema.org/"
     }
-]
+]

data/ides.json

@@ -6,7 +6,8 @@
         "enabled": true,
         "docs": "https://code.visualstudio.com/docs",
         "outputFiles": [
-            "instructions-md"
+            "instructions-md",
+            "agents-md"
         ]
     },
     {
@@ -41,4 +42,4 @@
             "json-rules"
         ]
     }
-]
+]

file-templates/agents-template.md

@@ -0,0 +1,56 @@
+# Agents Development Guide
+
+This guide provides development conventions and best practices for building AI agent applications.
+
+## Project Overview
+
+- IDE: **{{preferredIde}}**
+- Framework/Language: **{{frameworkSelection}}** / **{{language}}**
+- Build tooling: **{{tooling}}**
+- Primary focus: **{{projectPriority}}**
+
+## Development Standards
+
+### Code Organization
+- File structure: **{{fileStructure}}**
+- Folder organization: **{{folders}}**
+- Naming conventions:
+  - Variables/functions: **{{variableNaming}}**
+  - Files: **{{fileNaming}}**
+  - Components/classes: **{{componentNaming}}**
+
+### Code Style & Quality
+- Code style: **{{codeStyle}}**
+- Export style: **{{exports}}**
+- Comments: **{{comments}}**
+- Testing:
+  - Unit tests: **{{testingUT}}**
+  - E2E tests: **{{testingE2E}}**
+
+## Agent-Specific Patterns
+
+### State Management
+- State handling: **{{stateManagement}}**
+- Data fetching: **{{dataFetching}}**
+
+### API Integration
+- API layer: **{{apiLayer}}**
+- Authentication: **{{auth}}**
+- Validation: **{{validation}}**
+
+### Performance & Monitoring
+- Logging: **{{logging}}**
+- Performance considerations: **{{reactPerf}}**
+
+## Collaboration & Git
+
+### Version Control
+- Commit style: **{{commitStyle}}**
+- PR rules: **{{prRules}}**
+
+### Team Collaboration
+- Collaboration approach: **{{collaboration}}**
+
+---
+
+*This agents guide was generated based on your project configuration and can be customized for your specific agent development needs.*

file-templates/copilot-instructions-template.md

@@ -1,94 +1,145 @@
-# Copilot Instructions
+---
+# Configuration for Copilot in this project
+applyTo: "**/*.{ts,tsx,js,jsx,md}"  # apply to all code files by default
+---
 
-These instructions define how GitHub Copilot should assist in this project.  
-They are tailored to our selected IDE, framework, and coding conventions, based on real developer practices.
+# Project Overview  
+These are the conventions and guardrails Copilot should follow when generating code, tests, commits, and PRs in our project.  
+They reflect the decisions we made (IDE, framework, language) and real-world best practices.
 
 ---
 
-## Environment
+## 1. Project Context & Priorities
+
+- IDE: **{{preferredIde}}**  
+- Framework: **{{frameworkSelection}}**  
+- Build tooling: **{{tooling}}**  
+- Language: **{{language}}**  
 
-- **IDE**: {{preferredIde}}  
-- **Framework**: {{frameworkSelection}}  
-- **Build Tooling**: {{tooling}}  
-- **Language**: {{language}}
+- Primary focus: **{{projectPriority}}**
+
+> Use this context — when Copilot needs to choose between simpler vs. more optimized code, prefer what aligns with **{{projectPriority}}**.
 
 ---
 
-## Project Priorities
+## 2. Naming, Style & Structure Rules
+
+### Naming & Exports
 
-- **Primary focus**: {{projectPriority}}  
-- **Code style**: {{codeStyle}}  
-- **Variable naming**: {{variableNaming}}  
-- **File naming**: {{fileNaming}}  
-- **Component naming**: {{componentNaming}}  
-- **Exports**: {{exports}}  
-- **Comments & documentation**: {{comments}}  
-- **Collaboration rules**: {{collaboration}}
+- Variables, functions, object keys: **{{variableNaming}}**  
+- Files & modules: **{{fileNaming}}**  
+- Components, types: **{{componentNaming}}**  
+- Always use **{{exports}}** exports style  
+- Comments & documentation style: **{{comments}}**  
+- Code style: follow **{{codeStyle}}**  
+
+### File and Folder Structure
+
+- Component / UI layout organization: **{{fileStructure}}**  
+- Styling approach: **{{styling}}**  
+- State management: adopt **{{stateManagement}}**  
+- API layer organization: put remote calls in **{{apiLayer}}**  
+- Folder strategy: **{{folders}}**  
+
+> Copilot should not generate code outside these structures or naming patterns.
 
 ---
 
-## Architecture & Structure
+## 3. Testing & Quality Assurance
+
+- Unit tests: **{{testingUT}}**  
+- E2E / integration: **{{testingE2E}}**  
 
-- **Component structure**: {{fileStructure}}  
-- **Styling approach**: {{styling}}  
-- **State management**: {{stateManagement}}  
-- **API layer**: {{apiLayer}}  
-- **Folder structure**: {{folders}}
+**Rules**  
+- Use descriptive test names.  
+- Always include both “happy path” and edge cases.  
+- Avoid large tests that span too many modules.  
+- Tests should live alongside modules (or in designated `__tests__` folder per convention).
 
 ---
 
-## Testing
+## 4. Performance & Data Loading
 
-- **Unit testing**: {{testingUT}}  
-- **End-to-End (E2E) testing**: {{testingE2E}}
+- Data fetching approach: **{{dataFetching}}**  
+- React performance optimizations: **{{reactPerf}}**  
+
+**Do**  
+- Use pagination or limit responses.  
+- Memoize computations or components when data is large.  
+- Lazy-load modules/components that aren’t critical at startup.
+
+**Don’t**  
+- Fetch all data at once without constraints.  
+- Place heavy logic in render without memoization.
 
 ---
 
-## Performance Guidelines
+## 5. Security, Validation, Logging
 
-- **Data fetching**: {{dataFetching}}  
-- **React performance**: {{reactPerf}}
+- Secrets / auth handling: **{{auth}}**  
+- Input validation: **{{validation}}**  
+- Logging style: **{{logging}}**
+
+**Rules**  
+- Never embed secrets in code; always use environment variables.  
+- Validate all incoming data (API or client side) using the chosen validation library.  
+- Logging messages should never reveal secrets or PII.  
+- Use structured or contextual logs (vs. free-form `console.log`) especially in production.
 
 ---
 
-## Security Guidelines
+## 6. Commit & PR Conventions
+
+- Commit message style: **{{commitStyle}}**  
+- PR rules: **{{prRules}}**
 
-- **Authentication & secrets**: {{auth}}  
-- **Validation**: {{validation}}  
-- **Logging**: {{logging}}
+**Do**  
+- Write commit messages that follow the agreed style (e.g. `feat: add login`)  
+- Keep PRs small and focused  
+- Always link the issue or ticket  
+- If PR introduces new API or breaking change, update the documentation
+
+**Don’t**  
+- Use vague commit messages like “fix stuff”  
+- Combine unrelated changes in one commit or PR
 
 ---
 
-## Commits & Pull Requests
+## 7. Copilot Usage Guidance
 
-- **Commit style**: {{commitStyle}}  
-- **Pull request rules**: {{prRules}}
+- Use Copilot to scaffold boilerplate (e.g. `useQuery`, component boilerplate), not to bypass core logic.  
+- When writing prompts/comments for Copilot, embed **context** (e.g. expected return shape, types).  
+- When Copilot suggests code that violates naming, structure, or validation rules – override or reject it.  
+- For ambiguous design choices, ask for clarification in comments (e.g. “// Should this go in services or hooks?”).  
+- Prefer completions that respect folder boundaries and import paths (don’t let Copilot propose imports from “wrong” layers).
 
 ---
 
-## IDE-Specific Guidance
+## 8. IDE-Specific Rules & Settings
+
+For **VS Code**:
 
-For **VS Code**:  
-- Always include a `.editorconfig`.  
-- Enable **Prettier** and **ESLint** extensions.  
-- Turn on `editor.formatOnSave: true`.  
-- Suggested extensions:  
-  - `dbaeumer.vscode-eslint`  
-  - `esbenp.prettier-vscode`  
-  - `formulahendry.auto-rename-tag`
+- Use `.editorconfig` for consistent indent / line endings  
+- Enable **Prettier** and **ESLint**, synced to our style rules  
+- Set `editor.formatOnSave = true`  
+- Suggested extensions: `dbaeumer.vscode-eslint`, `esbenp.prettier-vscode`, `formulahendry.auto-rename-tag`  
+- Avoid conflicting formatters or duplicated rules  
+
+> These help Copilot suggestions align more closely with how your code will be formatted and linted.
 
 ---
 
-## Copilot Usage Guidelines
+## 9. Caveats & Overrides
 
-- Use Copilot to generate **boilerplate**, but always review before committing.  
-- When writing tests, describe expected behavior clearly so Copilot can produce meaningful cases.  
-- Prefer completions aligned with **our conventions** (naming, structure, testing).  
-- Reject or edit Copilot suggestions that break the rules above.  
+- If a feature is experimental or out-of-scope, document it in comments.  
+- In rare cases, exceptions may be allowed — but always document why.  
+- Always run linters and tests on generated code before merging.
 
 ---
 
 ## Notes
 
-- This file is auto-generated by **DevContext**.  
-- Regenerate this file whenever project priorities, frameworks, or rules change.  
+- This instructions file was **auto-generated** based on your chosen configuration.  
+- Regenerate it whenever your JSON configuration changes (framework, naming, testing, etc.).  
+- You may also split this file into domain-specific `.instructions.md` files using `applyTo` frontmatter if your project grows.
+