UltraciteUltracite
Read the docs
UltraciteWindsurf

Ultracite for Windsurf

Use Ultracite with Windsurf to pair standard VS Code workspace settings with Windsurf-specific rules and optional hooks that tidy AI-generated edits after every write.

$

Setup files for Windsurf

Ultracite uses these Windsurf settings, rules, and hooks files to keep editor behavior and AI output aligned with your repo standards.

Workspace settings

This workspace settings file keeps Windsurf aligned with Ultracite for format on save, auto-fixes, and TypeScript defaults.

.vscode/settings.json
JSON config
JSON

.vscode/settings.json

{  "editor.defaultFormatter": "esbenp.prettier-vscode",  "editor.formatOnPaste": true,  "editor.formatOnSave": true,  "emmet.showExpandedAbbreviation": "never",  "js/ts.tsdk.path": "node_modules/typescript/lib",  "js/ts.tsdk.promptToUseWorkspaceVersion": true,  "[css]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[graphql]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[html]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[javascript]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[javascriptreact]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[json]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[jsonc]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[markdown]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[mdx]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[svelte]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[typescript]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[typescriptreact]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[vue]": {    "editor.defaultFormatter": "biomejs.biome"  },  "[yaml]": {    "editor.defaultFormatter": "biomejs.biome"  },  "editor.codeActionsOnSave": {    "source.fixAll.biome": "explicit",    "source.organizeImports.biome": "explicit"  }}

AI rules

Use `.windsurf/rules/ultracite.md` to teach Windsurf how Ultracite expects code to be written before the formatter and linter run.

.windsurf/rules/ultracite.md
Markdown guidance
Shapes AI output before review
JSON

.windsurf/rules/ultracite.md

# Ultracite Code StandardsThis project uses **Ultracite**, a zero-config preset that enforces strict code quality standards through automated formatting and linting.## Quick Reference- **Format code**: `npx ultracite fix`- **Check for issues**: `npx ultracite check`- **Diagnose setup**: `npx ultracite doctor`your configured linter (the underlying engine) provides robust linting and formatting. Most issues are automatically fixable.---## Core PrinciplesWrite code that is **accessible, performant, type-safe, and maintainable**. Focus on clarity and explicit intent over brevity.### Type Safety & Explicitness- Use explicit types for function parameters and return values when they enhance clarity- Prefer `unknown` over `any` when the type is genuinely unknown- Use const assertions (`as const`) for immutable values and literal types- Leverage TypeScript's type narrowing instead of type assertions- Use meaningful variable names instead of magic numbers - extract constants with descriptive names### Modern JavaScript/TypeScript- Use arrow functions for callbacks and short functions- Prefer `for...of` loops over `.forEach()` and indexed `for` loops- Use optional chaining (`?.`) and nullish coalescing (`??`) for safer property access- Prefer template literals over string concatenation- Use destructuring for object and array assignments- Use `const` by default, `let` only when reassignment is needed, never `var`### Async & Promises- Always `await` promises in async functions - don't forget to use the return value- Use `async/await` syntax instead of promise chains for better readability- Handle errors appropriately in async code with try-catch blocks- Don't use async functions as Promise executors### React & JSX- Use function components over class components- Call hooks at the top level only, never conditionally- Specify all dependencies in hook dependency arrays correctly- Use the `key` prop for elements in iterables (prefer unique IDs over array indices)- Nest children between opening and closing tags instead of passing as props- Don't define components inside other components- Use semantic HTML and ARIA attributes for accessibility:  - Provide meaningful alt text for images  - Use proper heading hierarchy  - Add labels for form inputs  - Include keyboard event handlers alongside mouse events  - Use semantic elements (`<button>`, `<nav>`, etc.) instead of divs with roles### Error Handling & Debugging- Remove `console.log`, `debugger`, and `alert` statements from production code- Throw `Error` objects with descriptive messages, not strings or other values- Use `try-catch` blocks meaningfully - don't catch errors just to rethrow them- Prefer early returns over nested conditionals for error cases### Code Organization- Keep functions focused and under reasonable cognitive complexity limits- Extract complex conditions into well-named boolean variables- Use early returns to reduce nesting- Prefer simple conditionals over nested ternary operators- Group related code together and separate concerns### Security- Add `rel="noopener"` when using `target="_blank"` on links- Avoid `dangerouslySetInnerHTML` unless absolutely necessary- Don't use `eval()` or assign directly to `document.cookie`- Validate and sanitize user input### Performance- Avoid spread syntax in accumulators within loops- Use top-level regex literals instead of creating them in loops- Prefer specific imports over namespace imports- Avoid barrel files (index files that re-export everything)- Use proper image components (e.g., Next.js `<Image>`) over `<img>` tags### Framework-Specific Guidance**Next.js:**- Use Next.js `<Image>` component for images- Use `next/head` or App Router metadata API for head elements- Use Server Components for async data fetching instead of async Client Components**React 19+:**- Use ref as a prop instead of `React.forwardRef`**Solid/Svelte/Vue/Qwik:**- Use `class` and `for` attributes (not `className` or `htmlFor`)---## Testing- Write assertions inside `it()` or `test()` blocks- Avoid done callbacks in async tests - use async/await instead- Don't use `.only` or `.skip` in committed code- Keep test suites reasonably flat - avoid excessive `describe` nesting## When your configured linter Can't Helpyour configured linter's linter will catch most issues automatically. Focus your attention on:1. **Business logic correctness** - your configured linter can't validate your algorithms2. **Meaningful naming** - Use descriptive names for functions, variables, and types3. **Architecture decisions** - Component structure, data flow, and API design4. **Edge cases** - Handle boundary conditions and error states5. **User experience** - Accessibility, performance, and usability considerations6. **Documentation** - Add comments for complex logic, but prefer self-documenting code---Most formatting and common issues are automatically fixed by your configured linter. Run `npx ultracite fix` before committing to ensure compliance.

Post-edit hooks

Run Ultracite automatically after Windsurf edits files so generated code is formatted and safe fixes are applied right away.

.windsurf/hooks.json
JSON config
Runs after AI file edits
JSON

.windsurf/hooks.json

{  "hooks": {    "post_write_code": [      {        "command": "npx ultracite fix",        "show_output": true      }    ]  }}

Why Windsurf teams choose Ultracite

Codeium's agentic IDE that combines AI assistance with a powerful VS Code-based development environment.

Built for post-write automation

Windsurf's agentic workflow benefits from a dedicated rules file plus a hook that can run right after generated edits land.

Reuses the same workspace configuration as VS Code

Ultracite keeps Windsurf aligned with standard VS Code workspace settings instead of forcing a separate editor-only config path.

Keeps agent-driven edits reviewable

The combination of rules and hooks reduces the amount of cleanup you need after Codeium agents make broad file changes.

Workflow tips for Windsurf

Keep Ultracite present in the day-to-day Windsurf workflow with a few editor-specific habits, not just a one-time setup.

1

Start with the shared .vscode/settings.json so Windsurf follows the repo's formatter and save-time fixes.

2

Add .windsurf/rules/ultracite.md to steer Codeium agents toward Ultracite's code standards before they write code.

3

Turn on .windsurf/hooks.json if you want Ultracite to run automatically after Windsurf finishes writing files.

Windsurf FAQ

Editor-specific answers for teams rolling out Ultracite in Windsurf.

Trusted by top companies

And used by thousands of open source projects.

Vercel
Profound
Adobe
Clerk
Alan Turing Institute
Consent
VA
French Government
Tencent
Posthog
Axiom
Resend
Redpanda
Workday
ElevenLabs
Mintlify
Sentry
Raycast
Moonshot
Augment Code

What the community is saying

Here's what some of the most innovative and forward-thinking developers in the React ecosystem have to say about Ultracite.

Install in seconds. Run in milliseconds.

Install Ultracite and start shipping code faster in seconds.

$