(1) Brandon Edley Example .cursorrules Cursor AI Prompt Files

NEW

SvelteKit TypeScript Guide .cursorrules prompt file

You are an expert in Svelte 5, SvelteKit, TypeScript, Supabase, Drizzle and modern web development.

Key Principles

Write concise, technical code with accurate Svelte 5 and SvelteKit examples.
Leverage SvelteKit's server-side rendering (SSR) and static site generation (SSG) capabilities.
Prioritize performance optimization and minimal JavaScript for optimal user experience.
Use descriptive variable names and follow Svelte and SvelteKit conventions.
Organize files using SvelteKit's file-based routing system.
Write concise, technical responses with accurate TypeScript examples.
Use functional, declarative programming. Avoid classes.
Prefer iteration and modularization over duplication.
Use descriptive variable names with auxiliary verbs (e.g., isLoading, hasError).
Use lowercase with dashes for directories (e.g., components/auth-wizard).
Favor named exports for components.
Use the Receive an Object, Return an Object (RORO) pattern.

Code Style and Structure

Write concise, TypeScript code with accurate examples.
Use functional and declarative programming patterns; avoid unnecessary classes except for state machines.
Prefer iteration and modularization over code duplication.
Structure files: component logic, markup, styles, helpers, types.
Follow Svelte's official documentation for setup and configuration: https://svelte.dev/docs
Use "function" keyword for pure functions. Omit semicolons.
Use TypeScript for all code. Prefer interfaces over types.
File structure: Exported component, subcomponents, helpers, static content, types.
Avoid unnecessary curly braces in conditional statements.
For single-line statements in conditionals, omit curly braces.
Use concise, one-line syntax for simple conditional statements (e.g., if (condition) doSomething()).
-Implement the preload pattern to prevent waterfalls.
Leverage Supabase for real-time data synchronization and state management.

Naming Conventions

Use lowercase with hyphens for component files (e.g., components/auth-form.svelte).
Use PascalCase for component names in imports and usage.
Use camelCase for variables, functions, and props.

TypeScript Usage

Use TypeScript for all code; prefer interfaces over types.
Avoid enums; use const objects instead.
Use functional components with TypeScript interfaces for props.
Enable strict mode in TypeScript for better type safety.

Svelte Runes

$state: Declare reactive state
```typescript
let count = $state(0);
```
$derived: Compute derived values
```typescript
let doubled = $derived(count * 2);
```
$effect: Manage side effects and lifecycle
```typescript
$effect(() => {
console.log(Count is now ${count});
});
```
$props: Declare component props
```typescript
let { optionalProp = 42, requiredProp } = $props();
```
$bindable: Create two-way bindable props
```typescript
let { bindableProp = $bindable() } = $props();
```
$inspect: Debug reactive state (development only)
```typescript
$inspect(count);
```

UI and Styling

Use Tailwind CSS for utility-first styling approach.
Leverage Shadcn components for pre-built, customizable UI elements.
Import Shadcn components from $lib/components/ui.
Organize Tailwind classes using the cn() utility from $lib/utils.
Use Svelte's built-in transition and animation features.

Shadcn Color Conventions

Use background and foreground convention for colors.
Define CSS variables without color space function:
```css
--primary: 222.2 47.4% 11.2%;
--primary-foreground: 210 40% 98%;
```
Usage example:
```svelte
<div class="bg-primary text-primary-foreground">Hello</div>
```
Key color variables:
--background, --foreground: Default body colors
--muted, --muted-foreground: Muted backgrounds
--card, --card-foreground: Card backgrounds
--popover, --popover-foreground: Popover backgrounds
--border: Default border color
--input: Input border color
--primary, --primary-foreground: Primary button colors
--secondary, --secondary-foreground: Secondary button colors
--accent, --accent-foreground: Accent colors
--destructive, --destructive-foreground: Destructive action colors
--ring: Focus ring color
--radius: Border radius for components

SvelteKit Project Structure

Use the recommended SvelteKit project structure:
```
src/
- lib/
- routes/
- app.html
static/
svelte.config.js
vite.config.js
```

Component Development

Create .svelte files for Svelte components.
Use .svelte.ts files for component logic and state machines.
Implement proper component composition and reusability.
Use Svelte's props for data passing.
Leverage Svelte's reactive declarations for local state management.

State Management

Use classes for complex state management (state machines):
```typescript
// counter.svelte.ts
class Counter {
count = $state(0);
incrementor = $state(1);
increment() {
this.count += this.incrementor;
}
resetCount() {
this.count = 0;
}
resetIncrementor() {
this.incrementor = 1;
}
}
export const counter = new Counter();
```
Use in components:
```svelte
<script lang="ts">
import { counter } from './counter.svelte.ts';
</script>
<button on:click={() => counter.increment()}>
Count: {counter.count}
</button>
```

Routing and Pages

Utilize SvelteKit's file-based routing system in the src/routes/ directory.
Implement dynamic routes using [slug] syntax.
Use load functions for server-side data fetching and pre-rendering.
Implement proper error handling with +error.svelte pages.

Server-Side Rendering (SSR) and Static Site Generation (SSG)

Leverage SvelteKit's SSR capabilities for dynamic content.
Implement SSG for static pages using prerender option.
Use the adapter-auto for automatic deployment configuration.

Performance Optimization

Leverage Svelte's compile-time optimizations.
Use {#key} blocks to force re-rendering of components when needed.
Implement code splitting using dynamic imports for large applications.
Profile and monitor performance using browser developer tools.
Use $effect.tracking() to optimize effect dependencies.
Minimize use of client-side JavaScript; leverage SvelteKit's SSR and SSG.
Implement proper lazy loading for images and other assets.

Data Fetching and API Routes

Use load functions for server-side data fetching.
Implement proper error handling for data fetching operations.
Create API routes in the src/routes/api/ directory.
Implement proper request handling and response formatting in API routes.
Use SvelteKit's hooks for global API middleware.

SEO and Meta Tags

Use Svelte:head component for adding meta information.
Implement canonical URLs for proper SEO.
Create reusable SEO components for consistent meta tag management.

Forms and Actions

Utilize SvelteKit's form actions for server-side form handling.
Implement proper client-side form validation using Svelte's reactive declarations.
Use progressive enhancement for JavaScript-optional form submissions.

Internationalization (i18n) with Paraglide.js

Use Paraglide.js for internationalization: https://inlang.com/m/gerre34r/library-inlang-paraglideJs
Install Paraglide.js: npm install @inlang/paraglide-js
Set up language files in the languages directory.
Use the t function to translate strings:
```svelte
<script>
import { t } from '@inlang/paraglide-js';
</script>
<h1>{t('welcome_message')}</h1>
```
Support multiple languages and RTL layouts.
Ensure text scaling and font adjustments for accessibility.

Accessibility

Ensure proper semantic HTML structure in Svelte components.
Implement ARIA attributes where necessary.
Ensure keyboard navigation support for interactive elements.
Use Svelte's bind:this for managing focus programmatically.

Key Conventions

Embrace Svelte's simplicity and avoid over-engineering solutions.
Use SvelteKit for full-stack applications with SSR and API routes.
Prioritize Web Vitals (LCP, FID, CLS) for performance optimization.
Use environment variables for configuration management.
Follow Svelte's best practices for component composition and state management.
Ensure cross-browser compatibility by testing on multiple platforms.
Keep your Svelte and SvelteKit versions up to date.
Use the @supabase/ssr package instead of the older auth helpers packages.
Configure your Supabase client to use cookies for storing session information.
Implement the PKCE (Proof Key for Code Exchange) flow for authentication in SSR applications.
Create separate browser and server clients using the createBrowserClient and createServerClient functions.
Store access and refresh tokens in secure cookies for SSR.
Implement proper error handling for invalid refresh token errors on the server-side.
Use environment variables to store Supabase URL and API keys.
Implement Row Level Security (RLS) on all tables containing sensitive data.
Adopt a multi-stage development workflow (local -> staging -> prod).
Use database migration tools to manage schema changes.
Optimize queries, indexes, and connection management regularly.
Implement proper CORS settings in your Supabase project.
Use TypeScript for better type safety and developer experience.
Implement consistent error handling across your application.
Use a logging service for production environments to track errors and performance issues.
Implement unit tests for database interactions.