# Windsurf Formatter

<!-- Auto-generated by `pnpm docs:formatters`. Do not edit manually. -->

PromptScript compiles your `.prs` sources to native Windsurf configuration. The main output is `.windsurf/rules/project.md`. It is not enabled by default, add it to `targets` to use it.

## Enable the Target

```yaml
targets:
  - windsurf
```

Pick an output version when you need more than the default:

```yaml
targets:
  - windsurf:
      version: full
```

## At a Glance

| Property          | Value                                    |
| ----------------- | ---------------------------------------- |
| **Tier**          | Tier 1                                   |
| **Main output**   | `.windsurf/rules/project.md`             |
| **Dot directory** | `.windsurf/`                             |
| **Skills**        | Yes (`.windsurf/skills/<name>/SKILL.md`) |
| **Agents**        | No                                       |
| **Commands**      | No                                       |
| **Local files**   | No                                       |

## Output Files

| File              | Path                               | Purpose                                       |
| ----------------- | ---------------------------------- | --------------------------------------------- |
| Main instructions | `.windsurf/rules/project.md`       | Primary rule file                             |
| Lifecycle hooks   | `.windsurf/hooks.json`             | Project hooks in `multifile` and `full` modes |
| Skills            | `.windsurf/skills/<name>/SKILL.md` | Reusable skill definitions                    |

## Output Versions

| Version          | Output                                                        |
| ---------------- | ------------------------------------------------------------- |
| `simple`         | Single .windsurf/rules/project.md file                        |
| `multifile`      | Single .windsurf/rules/project.md file (skills via full mode) |
| `full` (default) | .windsurf/rules/project.md + .windsurf/skills/<name>/SKILL.md |

## MCP and Hooks

| Block         | Support                                                         |
| ------------- | --------------------------------------------------------------- |
| `@mcpServers` | `.windsurf/mcp_config.json` (json)                              |
| `@hooks`      | `.windsurf/hooks.json` in `multifile`, `full`                   |
| Hook events   | `pre-terminal-command`, `pre-tool-use`, `post-tool-use`, `stop` |

Native hook reference: <https://docs.windsurf.com/windsurf/cascade/hooks>

## Supported Features

| Feature                    | Supported |
| -------------------------- | --------- |
| Markdown Output            | Yes       |
| MDC Format                 | No        |
| Code Blocks                | Yes       |
| Mermaid Diagrams           | Yes       |
| Single File Output         | Yes       |
| Multiple Rule Files        | No        |
| Workflow Files             | No        |
| Nested Directory Structure | No        |
| YAML Frontmatter           | Planned   |
| Description in Frontmatter | No        |
| Globs in Frontmatter       | No        |
| Activation Type            | Planned   |
| Glob Pattern Targeting     | No        |
| Always Apply Rules         | Planned   |
| Manual Activation          | No        |
| Auto/Model Activation      | No        |
| Structured Examples        | Yes       |
| Character Limit Validation | No        |
| Content Section Splitting  | Yes       |
| Guard Dependencies         | Yes       |
| Context File Inclusion     | No        |
| @-Mentions                 | No        |
| Tool Integration           | No        |
| Path-Specific Rules        | No        |
| Prompt Files               | No        |
| Slash Commands             | No        |
| Skills                     | Yes       |
| Agent Instructions         | No        |
| Local Memory               | No        |
| Nested Memory              | No        |

## See Also

- [Platform matrix](https://getpromptscript.dev/reference/formatters/index.md)
- [Configuration reference](https://getpromptscript.dev/reference/config/index.md)
- [Target platforms and output families](https://getpromptscript.dev/features/target-platforms/index.md)