codingbuddy-rules 2.0.0 → 2.1.0

package/.ai-rules/checklists/accessibility.json

@@ -0,0 +1,132 @@
+{
+  "domain": "accessibility",
+  "icon": "♿",
+  "description": "Accessibility (a11y) review items for WCAG 2.1 AA compliance",
+  "categories": [
+    {
+      "name": "forms",
+      "triggers": {
+        "files": [
+          "**/form/**",
+          "**/input/**",
+          "**/login/**",
+          "**/signup/**",
+          "**/contact/**"
+        ],
+        "imports": ["react-hook-form", "formik", "@radix-ui/react-form"],
+        "patterns": ["<form", "<input", "<select", "<textarea", "onSubmit"]
+      },
+      "items": [
+        {
+          "id": "a11y-form-001",
+          "text": "Associate labels with form inputs using htmlFor/id",
+          "priority": "critical",
+          "reason": "Screen readers need label association to announce field purpose",
+          "reference": "WCAG 1.3.1"
+        },
+        {
+          "id": "a11y-form-002",
+          "text": "Provide clear error messages with aria-describedby",
+          "priority": "high",
+          "reason": "Users need to understand what went wrong"
+        },
+        {
+          "id": "a11y-form-003",
+          "text": "Mark required fields with aria-required",
+          "priority": "medium",
+          "reason": "Assistive technologies should announce required fields"
+        },
+        {
+          "id": "a11y-form-004",
+          "text": "Ensure form can be submitted with keyboard (Enter key)",
+          "priority": "high",
+          "reason": "Keyboard-only users must be able to submit forms"
+        }
+      ]
+    },
+    {
+      "name": "interactive_elements",
+      "triggers": {
+        "files": [
+          "**/button/**",
+          "**/modal/**",
+          "**/dialog/**",
+          "**/dropdown/**",
+          "**/menu/**",
+          "**/components/**"
+        ],
+        "imports": [
+          "@radix-ui/*",
+          "@headlessui/*",
+          "react-aria",
+          "react-modal"
+        ],
+        "patterns": ["onClick", "onKeyDown", "role=", "aria-", "<button", "<a "]
+      },
+      "items": [
+        {
+          "id": "a11y-interactive-001",
+          "text": "Ensure all interactive elements are keyboard accessible",
+          "priority": "critical",
+          "reason": "Not all users can use a mouse",
+          "reference": "WCAG 2.1.1"
+        },
+        {
+          "id": "a11y-interactive-002",
+          "text": "Provide visible focus indicators",
+          "priority": "critical",
+          "reason": "Keyboard users need to see where focus is",
+          "reference": "WCAG 2.4.7"
+        },
+        {
+          "id": "a11y-interactive-003",
+          "text": "Use semantic HTML elements (button, a) instead of div with onClick",
+          "priority": "high",
+          "reason": "Semantic elements have built-in accessibility"
+        },
+        {
+          "id": "a11y-interactive-004",
+          "text": "Manage focus when opening/closing modals",
+          "priority": "high",
+          "reason": "Focus should move to modal and return when closed"
+        }
+      ]
+    },
+    {
+      "name": "content",
+      "triggers": {
+        "files": ["**/page/**", "**/layout/**", "**/*.tsx", "**/*.jsx"],
+        "imports": ["next/image", "next/link"],
+        "patterns": ["<img", "<Image", "<h1", "<h2", "<main", "<nav", "<aside"]
+      },
+      "items": [
+        {
+          "id": "a11y-content-001",
+          "text": "Provide alt text for all meaningful images",
+          "priority": "critical",
+          "reason": "Screen reader users cannot see images",
+          "reference": "WCAG 1.1.1"
+        },
+        {
+          "id": "a11y-content-002",
+          "text": "Use proper heading hierarchy (h1 > h2 > h3)",
+          "priority": "high",
+          "reason": "Headings provide document structure for navigation"
+        },
+        {
+          "id": "a11y-content-003",
+          "text": "Ensure sufficient color contrast (4.5:1 for text)",
+          "priority": "high",
+          "reason": "Low contrast text is hard to read",
+          "reference": "WCAG 1.4.3"
+        },
+        {
+          "id": "a11y-content-004",
+          "text": "Use landmark regions (main, nav, aside, footer)",
+          "priority": "medium",
+          "reason": "Landmarks help screen reader users navigate"
+        }
+      ]
+    }
+  ]
+}

package/.ai-rules/checklists/code-quality.json

@@ -0,0 +1,97 @@
+{
+  "domain": "code-quality",
+  "icon": "📏",
+  "description": "Code quality and maintainability review items",
+  "categories": [
+    {
+      "name": "general",
+      "triggers": {
+        "files": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
+        "imports": [],
+        "patterns": []
+      },
+      "items": [
+        {
+          "id": "cq-gen-001",
+          "text": "Use explicit TypeScript types (avoid 'any')",
+          "priority": "high",
+          "reason": "Type safety catches errors at compile time"
+        },
+        {
+          "id": "cq-gen-002",
+          "text": "Keep functions small (10-20 lines max)",
+          "priority": "medium",
+          "reason": "Small functions are easier to understand and test"
+        },
+        {
+          "id": "cq-gen-003",
+          "text": "Use meaningful variable and function names",
+          "priority": "high",
+          "reason": "Code should be self-documenting"
+        },
+        {
+          "id": "cq-gen-004",
+          "text": "Remove dead code and unused imports",
+          "priority": "medium",
+          "reason": "Dead code adds confusion and maintenance burden"
+        }
+      ]
+    },
+    {
+      "name": "solid_principles",
+      "triggers": {
+        "files": ["**/service/**", "**/util/**", "**/lib/**", "**/core/**"],
+        "imports": [],
+        "patterns": ["class ", "interface ", "abstract "]
+      },
+      "items": [
+        {
+          "id": "cq-solid-001",
+          "text": "Single Responsibility: Each module has one reason to change",
+          "priority": "high",
+          "reason": "Focused modules are easier to maintain"
+        },
+        {
+          "id": "cq-solid-002",
+          "text": "Dependency Inversion: Depend on abstractions, not concretions",
+          "priority": "medium",
+          "reason": "Makes code more flexible and testable"
+        },
+        {
+          "id": "cq-solid-003",
+          "text": "DRY: Eliminate code duplication",
+          "priority": "high",
+          "reason": "Duplicated code means duplicated bugs"
+        }
+      ]
+    },
+    {
+      "name": "error_handling",
+      "triggers": {
+        "files": ["**/api/**", "**/service/**", "**/handler/**"],
+        "imports": [],
+        "patterns": ["try", "catch", "throw", "Error", "Promise"]
+      },
+      "items": [
+        {
+          "id": "cq-error-001",
+          "text": "Handle all error cases explicitly",
+          "priority": "high",
+          "reason": "Unhandled errors crash applications"
+        },
+        {
+          "id": "cq-error-002",
+          "text": "Provide meaningful error messages",
+          "priority": "medium",
+          "reason": "Good error messages help debugging"
+        },
+        {
+          "id": "cq-error-003",
+          "text": "Use custom error types for domain errors",
+          "priority": "low",
+          "reason": "Enables specific error handling"
+        }
+      ]
+    }
+  ]
+}

package/.ai-rules/checklists/index.json

@@ -0,0 +1,47 @@
+{
+  "version": "1.0.0",
+  "domains": [
+    {
+      "id": "security",
+      "name": "Security",
+      "icon": "🔒",
+      "file": "security.json",
+      "description": "Security-related review items (authentication, input validation, data protection)"
+    },
+    {
+      "id": "accessibility",
+      "name": "Accessibility",
+      "icon": "♿",
+      "file": "accessibility.json",
+      "description": "WCAG 2.1 AA compliance items (forms, interactive elements, content)"
+    },
+    {
+      "id": "performance",
+      "name": "Performance",
+      "icon": "⚡",
+      "file": "performance.json",
+      "description": "Performance optimization items (rendering, loading, data fetching)"
+    },
+    {
+      "id": "testing",
+      "name": "Testing",
+      "icon": "🧪",
+      "file": "testing.json",
+      "description": "Testing strategy items (unit, component, API testing)"
+    },
+    {
+      "id": "code-quality",
+      "name": "Code Quality",
+      "icon": "📏",
+      "file": "code-quality.json",
+      "description": "Code quality items (TypeScript, SOLID principles, error handling)"
+    },
+    {
+      "id": "seo",
+      "name": "SEO",
+      "icon": "🔍",
+      "file": "seo.json",
+      "description": "SEO optimization items (metadata, structure, links)"
+    }
+  ]
+}

package/.ai-rules/checklists/performance.json

@@ -0,0 +1,97 @@
+{
+  "domain": "performance",
+  "icon": "⚡",
+  "description": "Performance optimization review items",
+  "categories": [
+    {
+      "name": "rendering",
+      "triggers": {
+        "files": ["**/components/**", "**/page/**", "**/*.tsx", "**/*.jsx"],
+        "imports": ["react", "next", "useMemo", "useCallback", "memo"],
+        "patterns": ["useState", "useEffect", "useMemo", "useCallback", "memo("]
+      },
+      "items": [
+        {
+          "id": "perf-render-001",
+          "text": "Memoize expensive calculations with useMemo",
+          "priority": "medium",
+          "reason": "Prevents unnecessary recalculations on re-render"
+        },
+        {
+          "id": "perf-render-002",
+          "text": "Use useCallback for callback props to child components",
+          "priority": "medium",
+          "reason": "Prevents unnecessary child re-renders"
+        },
+        {
+          "id": "perf-render-003",
+          "text": "Avoid inline object/array creation in JSX",
+          "priority": "low",
+          "reason": "New references cause unnecessary re-renders"
+        },
+        {
+          "id": "perf-render-004",
+          "text": "Use React.memo for pure presentational components",
+          "priority": "low",
+          "reason": "Skip re-renders when props haven't changed"
+        }
+      ]
+    },
+    {
+      "name": "loading",
+      "triggers": {
+        "files": ["**/page/**", "**/layout/**", "**/app/**"],
+        "imports": ["next/dynamic", "next/image", "react-lazy-load"],
+        "patterns": ["dynamic(", "lazy(", "Suspense", "loading"]
+      },
+      "items": [
+        {
+          "id": "perf-load-001",
+          "text": "Use code splitting with dynamic imports",
+          "priority": "high",
+          "reason": "Reduces initial bundle size"
+        },
+        {
+          "id": "perf-load-002",
+          "text": "Optimize images (WebP, proper sizing, lazy loading)",
+          "priority": "high",
+          "reason": "Images are often the largest assets"
+        },
+        {
+          "id": "perf-load-003",
+          "text": "Implement loading skeletons for async content",
+          "priority": "medium",
+          "reason": "Improves perceived performance"
+        }
+      ]
+    },
+    {
+      "name": "data_fetching",
+      "triggers": {
+        "files": ["**/api/**", "**/hook/**", "**/query/**"],
+        "imports": ["@tanstack/react-query", "swr", "axios"],
+        "patterns": ["useQuery", "useSWR", "fetch(", "getServerSideProps"]
+      },
+      "items": [
+        {
+          "id": "perf-data-001",
+          "text": "Implement proper caching strategy",
+          "priority": "high",
+          "reason": "Reduces unnecessary network requests"
+        },
+        {
+          "id": "perf-data-002",
+          "text": "Use stale-while-revalidate pattern where appropriate",
+          "priority": "medium",
+          "reason": "Shows cached data while fetching fresh data"
+        },
+        {
+          "id": "perf-data-003",
+          "text": "Paginate or virtualize large lists",
+          "priority": "high",
+          "reason": "Rendering thousands of items kills performance"
+        }
+      ]
+    }
+  ]
+}

package/.ai-rules/checklists/security.json

@@ -0,0 +1,119 @@
+{
+  "domain": "security",
+  "icon": "🔒",
+  "description": "Security-related review items",
+  "categories": [
+    {
+      "name": "authentication",
+      "triggers": {
+        "files": [
+          "**/auth/**",
+          "**/login/**",
+          "**/session/**",
+          "**/password/**",
+          "**/signin/**",
+          "**/signup/**"
+        ],
+        "imports": [
+          "bcrypt",
+          "argon2",
+          "jsonwebtoken",
+          "passport",
+          "next-auth",
+          "@auth/*",
+          "jose"
+        ],
+        "patterns": [
+          "password",
+          "token",
+          "credential",
+          "session",
+          "authenticate"
+        ]
+      },
+      "items": [
+        {
+          "id": "sec-auth-001",
+          "text": "Hash passwords using bcrypt/argon2 (never store plaintext)",
+          "priority": "critical",
+          "reason": "Plaintext passwords can be stolen if database is compromised",
+          "reference": "OWASP Authentication Cheatsheet"
+        },
+        {
+          "id": "sec-auth-002",
+          "text": "Implement rate limiting on login attempts",
+          "priority": "high",
+          "reason": "Prevents brute force attacks"
+        },
+        {
+          "id": "sec-auth-003",
+          "text": "Use secure session management (HttpOnly, Secure, SameSite cookies)",
+          "priority": "critical",
+          "reason": "Prevents session hijacking and XSS attacks"
+        },
+        {
+          "id": "sec-auth-004",
+          "text": "Implement proper logout (invalidate session server-side)",
+          "priority": "high",
+          "reason": "Ensures complete session termination"
+        }
+      ]
+    },
+    {
+      "name": "input_validation",
+      "triggers": {
+        "files": ["**/api/**", "**/form/**", "**/input/**", "**/handler/**"],
+        "imports": ["zod", "yup", "joi", "validator"],
+        "patterns": ["validate", "sanitize", "input", "formData"]
+      },
+      "items": [
+        {
+          "id": "sec-input-001",
+          "text": "Validate all user input server-side",
+          "priority": "critical",
+          "reason": "Client-side validation can be bypassed"
+        },
+        {
+          "id": "sec-input-002",
+          "text": "Sanitize input to prevent XSS attacks",
+          "priority": "critical",
+          "reason": "Unsanitized input can execute malicious scripts"
+        },
+        {
+          "id": "sec-input-003",
+          "text": "Use parameterized queries to prevent SQL injection",
+          "priority": "critical",
+          "reason": "Raw queries with user input enable SQL injection"
+        }
+      ]
+    },
+    {
+      "name": "data_protection",
+      "triggers": {
+        "files": ["**/api/**", "**/data/**", "**/user/**", "**/profile/**"],
+        "imports": ["crypto", "node:crypto"],
+        "patterns": ["encrypt", "decrypt", "secret", "private", "pii"]
+      },
+      "items": [
+        {
+          "id": "sec-data-001",
+          "text": "Encrypt sensitive data at rest",
+          "priority": "high",
+          "reason": "Protects data if storage is compromised"
+        },
+        {
+          "id": "sec-data-002",
+          "text": "Use HTTPS for all data transmission",
+          "priority": "critical",
+          "reason": "Prevents man-in-the-middle attacks"
+        },
+        {
+          "id": "sec-data-003",
+          "text": "Never log sensitive information (passwords, tokens, PII)",
+          "priority": "high",
+          "reason": "Logs can be accessed by unauthorized parties"
+        }
+      ]
+    }
+  ]
+}

package/.ai-rules/checklists/seo.json

@@ -0,0 +1,97 @@
+{
+  "domain": "seo",
+  "icon": "🔍",
+  "description": "SEO optimization review items",
+  "categories": [
+    {
+      "name": "metadata",
+      "triggers": {
+        "files": ["**/page/**", "**/layout/**", "**/app/**", "**/head/**"],
+        "imports": ["next/head", "react-helmet"],
+        "patterns": ["<title", "<meta", "metadata", "generateMetadata"]
+      },
+      "items": [
+        {
+          "id": "seo-meta-001",
+          "text": "Set unique, descriptive title for each page",
+          "priority": "critical",
+          "reason": "Titles appear in search results and browser tabs"
+        },
+        {
+          "id": "seo-meta-002",
+          "text": "Write compelling meta descriptions (150-160 chars)",
+          "priority": "high",
+          "reason": "Descriptions appear in search result snippets"
+        },
+        {
+          "id": "seo-meta-003",
+          "text": "Set canonical URL to prevent duplicate content issues",
+          "priority": "medium",
+          "reason": "Helps search engines understand the primary URL"
+        },
+        {
+          "id": "seo-meta-004",
+          "text": "Add Open Graph and Twitter Card meta tags",
+          "priority": "medium",
+          "reason": "Controls appearance when shared on social media"
+        }
+      ]
+    },
+    {
+      "name": "structure",
+      "triggers": {
+        "files": ["**/page/**", "**/layout/**", "**/*.tsx", "**/*.jsx"],
+        "imports": [],
+        "patterns": ["<h1", "<h2", "<main", "<article", "<nav"]
+      },
+      "items": [
+        {
+          "id": "seo-struct-001",
+          "text": "Use exactly one h1 per page",
+          "priority": "high",
+          "reason": "H1 signals main topic to search engines"
+        },
+        {
+          "id": "seo-struct-002",
+          "text": "Use semantic HTML elements (article, section, nav)",
+          "priority": "medium",
+          "reason": "Semantic markup helps search engines understand content"
+        },
+        {
+          "id": "seo-struct-003",
+          "text": "Implement breadcrumb navigation with structured data",
+          "priority": "low",
+          "reason": "Helps users and search engines navigate site hierarchy"
+        }
+      ]
+    },
+    {
+      "name": "links",
+      "triggers": {
+        "files": ["**/page/**", "**/*.tsx", "**/*.jsx"],
+        "imports": ["next/link"],
+        "patterns": ["<a ", "<Link", "href="]
+      },
+      "items": [
+        {
+          "id": "seo-link-001",
+          "text": "Use descriptive link text (avoid 'click here')",
+          "priority": "medium",
+          "reason": "Link text signals page content to search engines"
+        },
+        {
+          "id": "seo-link-002",
+          "text": "Add rel='noopener noreferrer' to external links",
+          "priority": "medium",
+          "reason": "Security and performance best practice"
+        },
+        {
+          "id": "seo-link-003",
+          "text": "Ensure all internal links use relative paths",
+          "priority": "low",
+          "reason": "Maintains link equity within the site"
+        }
+      ]
+    }
+  ]
+}