supercli AGENTS.md

Agent Instructions for Supercode Monorepo

Build Commands

# Root level commands
bun run dev          # Start all dev servers
bun run build        # Build all packages and apps
bun run lint         # Run linting across all packages
bun run typecheck    # Run TypeScript checks across all packages

# Individual app/package commands
bun run dev:web      # Start only web app (Next.js)
bun run dev:api      # Start only API app
bun run dev:cli      # Start only CLI app

# Package-specific commands (run from package directory)
cd packages/db && bun run db:generate    # Generate Prisma client
cd packages/db && bun run db:migrate     # Deploy Prisma migrations

Note: This project uses Bun as the package manager ([email protected]).

Testing

Uses bun test (Bun's built-in test runner). Test files use *.test.ts convention.

# Run all tests
bun test

# Run a single test file
bun test path/to/file.test.ts

# Run tests in watch mode
bun test --watch

Code Style Guidelines

Imports

• Use absolute imports with path aliases: @/components/ui/button for web app
• Use workspace imports for cross-package dependencies: @super/db, @super/auth
• Import order: React/Next → External libs → Internal aliases → Relative imports
• Group imports by category with blank lines between groups

Formatting

• No semicolons at end of statements
• Use double quotes for strings
• 2-space indentation
• Trailing commas in multi-line objects/arrays
• No explicit return type on function components (inferred)

Naming Conventions

• Components: PascalCase (e.g., Button.tsx, HeroSection.tsx)
• Files: kebab-case for non-component files (e.g., utils.ts, query-provider.tsx)
• Functions: camelCase (e.g., signIn, getSession)
• Types/Interfaces: PascalCase (e.g., VariantProps)
• Constants: UPPER_SNAKE_CASE for true constants

Types & TypeScript

• Strict mode enabled (strict: true in tsconfig)
• Use type for type aliases when possible
• Export types explicitly when needed for consumers
• Use interface for object shapes that may be extended
• Prefer explicit return types on library functions