Compare commits

...

6 Commits

Author SHA1 Message Date
Mathias Fredriksson
453a8ac15d style(docs): remove emoji to match original doc style
Remove 🚨 emoji from "Critical Pattern Migrations" section header to
maintain consistency with the original document style which uses no
emojis, only text emphasis and formatting.

All other style elements match the original:
- Section headers with ## and ###
- Bold emphasis for important terms
- Simple bullet lists with -
- Direct, imperative tone
- "(MUST FOLLOW)" matches original "(USE FIRST)" pattern
2025-11-27 10:03:09 +00:00
Mathias Fredriksson
9aac7ecfc5 refactor(docs): remove duplicate content from site/CLAUDE.md
Remove redundant sections and repeated information:

- Remove entire "Migration" section (lines 192-207) that duplicated
  Components, Styling, and Tailwind sections
- Remove duplicate "leave campsite better" mention (already in line 13)
- Remove duplicate "Never import from @emotion/react" (already stated)

Reduces documentation from 250 to 232 lines while maintaining all
unique information. Each concept is now documented once in its most
appropriate section.
2025-11-27 09:57:51 +00:00
Mathias Fredriksson
6e08d9c5a2 refactor(docs): reduce wordiness in pattern documentation
Condense verbose sections to be more scannable and direct:
- Icon section: Single-line import, inline replacement mappings
- Radix section: Consolidated prop changes into one sentence
- Emotion section: Reduced from 5 to 4 bullets, combined redundant points
- Chromatic section: Reduced from 5 to 3 bullets
- localStorage section: Reduced from 8 to 4 lines

Overall ~30% reduction in text while maintaining clarity. AI agents
scan for patterns and use code examples - keeping prose minimal and
directive improves efficiency.
2025-11-27 09:50:32 +00:00
Mathias Fredriksson
d75fefba27 refactor(docs): remove deprecated pattern examples to prevent AI misuse
Remove code examples showing deprecated patterns (OLD/DO NOT USE blocks)
that could mislead AI agents into copying the wrong patterns.

Changes:
- Icon section: Only show lucide-react imports, not MUI icons
- Radix section: Only show correct Radix pattern, not MUI pattern
- Emotion section: Only show Tailwind classes, not emotion imports
- Testing section: Only show queries parameter, not spyOn pattern

This prevents AI agents from pattern-matching and copying deprecated
code while maintaining clear guidance on what to replace and how.
2025-11-27 09:48:04 +00:00
Mathias Fredriksson
a72a0cd29c fix(docs): add blank lines around lists for markdown linter
Fix markdown linting errors MD032 and MD031:
- Add blank lines around lists (MD032)
- Add blank lines around fenced code blocks (MD031)

Ensures site/CLAUDE.md passes markdownlint-cli2 checks.
2025-11-26 13:49:02 +00:00
Mathias Fredriksson
1f0280e6fb docs(site): document critical frontend pattern migrations
Add comprehensive documentation for active frontend pattern migrations
discovered through analysis of 200+ git commits touching site/ files:

Core Migrations:
- Emotion → Tailwind CSS (strict 'no new emotion' policy)
- MUI Components → Custom/Radix/shadcn (Tooltips, Tables, Buttons)
- MUI Icons → lucide-react with specific icon mappings
- spyOn → queries parameter for GET endpoint mocks in Storybook
- localStorage → user_configs table for user preferences

New Documentation:
- Icon migration mappings (BusinessIcon→Building2Icon, etc.)
- Radix component prop naming conventions (placement→side)
- cn() utility usage for conditional className merging
- Chromatic testing best practices (prefer snapshots over assertions)

Includes concrete before/after examples and migration patterns to guide
developers away from deprecated approaches toward current best practices.

Analysis based on PRs: #20948, #20946, #20938, #20905, #20900, #20869,
#20849, #20808, #20530, #20479, #20261, #20201, #20200, #20193, #20318

---

🤖 This change was written by Claude Sonnet 4.5 Thinking using mux and reviewed by a human 🏂
2025-11-26 13:43:55 +00:00

View File

@@ -1,5 +1,17 @@
# Frontend Development Guidelines
## Critical Pattern Migrations (MUST FOLLOW)
The following patterns are actively being migrated and have **STRICT policies**:
1. **Emotion → Tailwind**: "No new emotion styles, full stop" - Always use Tailwind CSS
2. **MUI Components → Custom/Radix Components**: Replace MUI components (Tooltips, Tables, Buttons) with custom/shadcn equivalents
3. **MUI Icons → lucide-react**: All icons must use lucide-react, never MUI icons
4. **spyOn → queries parameter**: Use `queries` in story parameters for GET endpoint mocks
5. **localStorage → user_configs**: Store user preferences in backend, not browser storage
When touching existing code, **"leave the campsite better than you found it"** - refactor old patterns to new ones even if not directly related to your changes.
## TypeScript LSP Navigation (USE FIRST)
When investigating or editing TypeScript/React code, always use the TypeScript language server tools for accurate navigation:
@@ -26,25 +38,84 @@ When investigating or editing TypeScript/React code, always use the TypeScript l
## Components
- MUI components are deprecated - migrate away from these when encountered
- Use shadcn/ui components first - check `site/src/components` for existing implementations.
- **MUI components are deprecated** - migrate away from these when encountered
- Replace `@mui/material/Tooltip` with custom `Tooltip` component (Radix-based)
- Default 100ms delay via global tooltip provider
- Use `delayDuration={0}` when immediate tooltip needed
- Replace MUI Tables with custom table components
- Replace MUI Buttons with shadcn Button components
- Systematically replace MUI components with custom/shadcn equivalents
- Use shadcn/ui components first - check `site/src/components` for existing implementations
- Do not use shadcn CLI - manually add components to maintain consistency
- The modules folder should contain components with business logic specific to the codebase.
- The modules folder should contain components with business logic specific to the codebase
- Create custom components only when shadcn alternatives don't exist
### Icon Migration: MUI Icons → lucide-react
Never import from `@mui/icons-material`. Use `lucide-react` instead.
```tsx
import { Building2Icon, UsersIcon, GlobeIcon, UserIcon } from "lucide-react";
```
**Common replacements:** `BusinessIcon``Building2Icon`, `GroupIcon``UsersIcon`, `PublicIcon``GlobeIcon`, `PersonIcon``UserIcon`
### MUI → Radix Component Prop Naming
When migrating from MUI to Radix components, use Radix naming conventions:
```tsx
<Tooltip side="top">
<TooltipTrigger>Hover me</TooltipTrigger>
<TooltipContent>Tooltip text</TooltipContent>
</Tooltip>
```
**Prop changes from MUI:** Use `side` instead of `placement`, remove `PopperProps`, and use `TooltipContent` children instead of `title` prop.
## Styling
- Emotion CSS is deprecated. Use Tailwind CSS instead.
- Use custom Tailwind classes in tailwind.config.js.
- **Emotion CSS is STRICTLY DEPRECATED: "no new emotion styles, full stop"**
- Never use `@emotion/react`, `css` prop, `useTheme()`, or emotion styled components
- Always use Tailwind CSS utility classes instead
- Use custom Tailwind classes in tailwind.config.js
- Tailwind CSS reset is currently not used to maintain compatibility with MUI
- Responsive design - use Tailwind's responsive prefixes (sm:, md:, lg:, xl:)
- Do not use `dark:` prefix for dark mode
### Common Emotion → Tailwind Migrations
Use Tailwind CSS utility classes:
```tsx
<div className="flex flex-col gap-2">
<div className="flex items-center gap-6">
<span className="font-medium text-content-primary">
Content here
</span>
</div>
</div>
```
**Common replacements:**
- Replace `css={visuallyHidden}` with `className="sr-only"`
- Replace `Stack` component with Tailwind flex (`flex`, `flex-col`, `gap-*`)
- Replace emotion `css` prop and theme colors with Tailwind utilities (`text-content-primary`, `bg-surface-secondary`, `border-border-default`)
- Use lucide-react icons with `size-icon-sm`, `size-icon-xs` classes
## Tailwind Best Practices
- Group related classes
- Use semantic color names from the theme inside `tailwind.config.js` including `content`, `surface`, `border`, `highlight` semantic tokens
- Prefer Tailwind utilities over custom CSS when possible
- For conditional classes, use the `cn()` utility (from `utils/cn`) which combines `clsx` and `tailwind-merge`
```tsx
import { cn } from "utils/cn";
<div className={cn("base-classes", condition && "conditional-classes", className)} />
```
## General Code style
@@ -53,6 +124,54 @@ When investigating or editing TypeScript/React code, always use the TypeScript l
- Prefer `for...of` over `forEach` for iteration
- **Biome** handles both linting and formatting (not ESLint/Prettier)
## Testing Patterns
### Storybook: queries parameter for GET endpoint mocks
**PREFERRED PATTERN**: For GET endpoint mocks in Storybook stories, use `queries` parameter instead of `spyOn`.
```tsx
// Use queries parameter pattern
parameters: {
queries: [
{
key: usersKey({ q: "" }),
data: {
users: MockUsers,
count: MockUsers.length,
},
},
{
key: getTemplatesQueryKey({ q: "has-ai-task:true" }),
data: [MockTemplate],
},
],
}
```
**Important notes:**
- This applies specifically to GET endpoint mocks in Storybook stories
- `spyOn` is still appropriate for other mock types (POST, PUT, DELETE, non-GET endpoints)
- Must import the correct query key functions (e.g., `usersKey`, `getTemplatesQueryKey`)
### Chromatic/Storybook Testing Best Practices
- Prefer visual validation through Chromatic snapshots over programmatic assertions
- Remove redundant assertions that duplicate snapshot validation
- Stories are snapshot tests - rely on screenshots to verify correctness
## State Storage
### localStorage vs user_configs table
**IMPORTANT**: Use `user_configs` table for user preferences, NOT `localStorage`.
- localStorage is browser-specific; user preferences should persist across devices
- Follow `theme_preference` as reference implementation
- Use localStorage only for truly transient UI state
- **Key principle**: User preferences should be tied to their account, not their browser
## Workflow
- Be sure to typecheck when you're done making a series of code changes
@@ -69,23 +188,6 @@ When investigating or editing TypeScript/React code, always use the TypeScript l
4. `pnpm test` - Run affected unit tests
5. Visual check in Storybook if component changes
## Migration (MUI → shadcn) (Emotion → Tailwind)
### Migration Strategy
- Identify MUI components in current feature
- Find shadcn equivalent in existing components
- Create wrapper if needed for missing functionality
- Update tests to reflect new component structure
- Remove MUI imports once migration complete
### Migration Guidelines
- Use Tailwind classes for all new styling
- Replace Emotion `css` prop with Tailwind classes
- Leverage custom color tokens: `content-primary`, `surface-secondary`, etc.
- Use `className` with `clsx` for conditional styling
## React Rules
### 1. Purity & Immutability