FlowScript Language Support
FlowScript turns your architecture into living documentation. Write a .flow file,
click Preview, and watch it render as docs and diagrams — that stay linked to the
rest of your system instead of going stale in a wiki somewhere.
What is FlowScript?
A .flow file describes one piece of your system — a flow, a service, a workflow — and
can reference other .flow files instead of repeating them. A login flow can point at
the signup flow it falls back to, and at the token service it calls into, without
re-explaining either.
@use "./jwt_tokens.flow" as jwt
@use "./signup.flow" as signup
@doc
# User Authentication (Login Flow)
Handles credential verification, rate limiting, and token minting via @jwt.
If the user has no account, they're routed to @signup.
@end
@sequencediagram
title User Login Flow
actor User as End User
participant Client as Web Application
participant API as Auth Gateway
participant Auth as JWT Minting Engine @jwt
User ->> Client : Enter credentials
Client ->> API : POST /api/v1/auth/login
API ->> Auth : Issue JWT Access & Refresh Token @jwt
Auth -->> API : JWT Access Token
API -->> Client : 200 OK
@end
@jwt and @signup are live, clickable references — everywhere they appear.
Getting Started
- Install the extension.
- Create a file ending in
.flow and start writing.
- Click Preview in the editor toolbar to see it rendered — docs on one side,
diagram on the other, updating as you type.
That's it. No setup, no config.
Features
- Syntax highlighting — Markdown inside
@doc, Mermaid inside @sequencediagram,
@references always distinctly colored.
- Live Preview — a side panel that renders your docs and diagrams as you type, with
clickable
@references for jumping around your architecture.
- Diagnostics — errors, unresolved references, and typos flagged inline.
- Autocomplete — for block names, references, and diagram syntax.
- Jump to definition & hover — on any
@reference.
Contributing
Building, testing, and publishing this extension is covered in
CONTRIBUTING.md.
License
MIT
