Format Dream code

1 min read

Use the same formatter in your editor and at the command line.

dream fmt src/
dream fmt app.dream tests/

Files are updated in place. A directory is searched recursively; generated output in target, .dream, node_modules, .git, and site is skipped. Directory searches do not follow symbolic links. You can pass a specific file or output directory explicitly.

Check formatting in CI

dream fmt --check src/ tests/

The check leaves files unchanged and returns a nonzero exit status if a file needs formatting, cannot be read, or cannot be safely formatted. Fix invalid tokens before retrying a skipped file.

Style

The formatter uses four spaces and a target width of 100 characters. Nonempty bodies use separate lines. Long argument lists and expressions wrap; short calls stay compact. Attributes appear above their declarations, and documentation comments stay with the item they describe.

class Greeting {
    public static fun hello(name: string): string {
        return "Hello, " + name;
    }
}

One blank line separates declarations. Within a function, use blank lines to separate setup, validation, work, and cleanup when that helps readers follow the task. The formatter preserves one blank line between those groups. String contents and comments are retained; long literals and comments can exceed the target width.

In the editor, use Format Document, or enable format on save for Dream files. See editor setup if the language tools are not available.