Skip to content

docs: add the format command - #344

Merged
magnus-madsen merged 2 commits into
masterfrom
docs/format-command
Oct 14, 2026
Merged

magnus-madsen merged 2 commits into
masterfrom
docs/format-command

Conversation

@magnus-madsen

Copy link
Copy Markdown
Member

Flix now has a format command (CLI, :format in the REPL, and Format Document through the language server). This documents it lightly:

  • Checking, Running, and Testing: a new Formatting the Source Code section between Generating Documentation and Printing Statistics, with a before-and-after example of src/Main.flix and a note that a project that does not compile is left untouched.
  • Projects and Packages: a format row in the command table.
  • Visual Studio Code: a Formatting bullet in the feature list.

The example output was produced with a build of flix/flix master at e892eae89. The formatter is a no-op in 0.78.0 (the real pretty printer landed in flix/flix#12465 on 2026-10-13), so this should go out with the next release.

🤖 Generated with Claude Code

magnus-madsen and others added 2 commits October 14, 2026 12:03
Add a Formatting the Source Code section to the Checking, Running, and
Testing chapter with a before-and-after example, list `format` in the
command table, and mention formatting among the VS Code features.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@magnus-madsen
magnus-madsen merged commit 64d81bd into master Oct 14, 2026
1 check passed
@magnus-madsen
magnus-madsen deleted the docs/format-command branch October 14, 2026 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant