@aragon-agent/cli 0.6.17 → 0.6.18

package/skills/project-indexer/templates/index-template.md

@@ -0,0 +1,129 @@
+# Project Index: {project-name}
+
+> Auto-generated by project-indexer | Last updated: {YYYY-MM-DD}
+
+## Project Overview
+
+- **Type:** {Frontend | Backend | Fullstack | Library | CLI | Monorepo}
+- **Languages:** {TypeScript (70%), Python (30%)}
+- **Frameworks:** {Next.js, FastAPI, etc.}
+- **Entry Points:** `{src/index.ts}`, `{api/main.py}`
+
+---
+
+## Feature Map
+
+### {Feature Name} (`{path}/`)
+
+Entry: `{entry-file}`
+
+{One-line description of this feature area}
+
+**Key exports:**
+- `{functionName}({params}): {returnType}` - {description}
+- `{ClassName}` - {description}
+- `{CONSTANT_NAME}` - {description}
+
+---
+
+### Example: Authentication (`src/auth/`)
+
+Entry: `src/auth/index.ts`
+
+User authentication, session management, and authorization logic.
+
+**Key exports:**
+- `login(credentials: LoginInput): Promise<User>` - Authenticate user with email/password
+- `logout(): void` - Clear session and revoke tokens
+- `useAuth(): AuthContext` - React hook for accessing auth state
+- `withAuth(Component): Component` - HOC for protected routes
+- `AuthProvider` - Context provider for auth state
+
+---
+
+### Example: API Layer (`src/api/`)
+
+Entry: `src/api/client.ts`
+
+REST API client with error handling, request interceptors, and response caching.
+
+**Key exports:**
+- `apiClient` - Pre-configured axios instance
+- `useQuery<T>(endpoint: string): SWRResponse<T>` - Data fetching hook with caching
+- `useMutation<T>(endpoint: string): MutationResult<T>` - Data mutation hook
+- `ApiError` - Custom error class for API errors
+
+---
+
+## Module Dependencies
+
+```
+{module-a} → {module-b} ({relationship description})
+```
+
+Example:
+```
+auth → api (uses apiClient for authentication requests)
+pages → auth, components (imports hooks and UI components)
+api → (standalone, no internal dependencies)
+components → utils (uses helper functions)
+hooks → api, auth (combines data fetching with auth state)
+```
+
+---
+
+## File Index
+
+### {directory}/
+
+| File | Description |
+|------|-------------|
+| {filename.ext} | {One-line description} |
+
+---
+
+### Example: src/auth/
+
+| File | Description |
+|------|-------------|
+| index.ts | Module entry point, re-exports public API |
+| login.ts | Login logic, credential validation, token handling |
+| logout.ts | Logout logic, session cleanup, token revocation |
+| session.ts | Session storage, refresh token management |
+| hooks.ts | React hooks: useAuth, useUser, usePermissions |
+| context.tsx | AuthContext and AuthProvider implementation |
+| types.ts | TypeScript types for auth entities |
+| constants.ts | Auth-related constants and configuration |
+
+### Example: src/api/
+
+| File | Description |
+|------|-------------|
+| client.ts | Axios instance with interceptors and base config |
+| endpoints.ts | API endpoint path constants |
+| types.ts | Request/response type definitions |
+| errors.ts | Custom error classes and error handling utilities |
+| hooks.ts | Data fetching hooks: useQuery, useMutation |
+| cache.ts | Response caching configuration |
+
+### Example: src/components/
+
+| File | Description |
+|------|-------------|
+| Button.tsx | Reusable button with variants (primary, secondary, ghost) |
+| Modal.tsx | Dialog component with portal and focus trap |
+| Toast.tsx | Notification toast with auto-dismiss |
+| Spinner.tsx | Loading spinner component |
+| Form/index.tsx | Form wrapper with validation context |
+| Form/Input.tsx | Text input with label and error display |
+| Form/Select.tsx | Dropdown select component |
+| Form/Checkbox.tsx | Checkbox with label |
+| Layout/Header.tsx | App header with navigation |
+| Layout/Sidebar.tsx | Collapsible sidebar navigation |
+| Layout/Footer.tsx | App footer |
+
+---
+
+## Notes
+
+{Any additional notes about the project structure, conventions, or important information}