Download
Width-sensitive formatter for Julia code. Inspired by gofmt, refmt, black, and prettier. Built with CSTParser. Sane defaults out of the box with options to customize. Supports YAS, Blue and SciML style guides. JuliaFormatter.toml configuration file to store options. JuliaFormatter exports format, format_file, format_text, and format_md. format_md has the same API as format_text but differ in that format_md expects the text content to be a Markdown document. See format_text docstring for formatting options at the text level and format_file docstring for formatting options at the file level. JuliaFormatter should work on any valid Julia and Markdown files. If JuliaFormatter cannot parse the code for any reason, it will throw an error pointing to the line that could not be parsed. If running format on multiple files, you may want to set verbose = true to print information about which file is being formatted.
Features
- JuliaFormatter exports format, format_file, format_text, and format_md
- Format code docstrings with the same options used for the code source
- Markdown is formatted with CommonMark alongside Julia code
- Integration with other editors
- Inspired by gofmt, refmt, and black
- JuliaFormatter should work on any valid Julia and Markdown files
Project Samples
