Format

In editor setup, all formatting options are flatten as shown below. However, if you're using the formatter as a Rust crate, type structures are different. For more details, please refer to the API documentation.

This page only shows basic options. For detailed options, please refer to their specific pages.

printWidth

default: 80

The line width limitation that formatter should (but not must) avoid exceeding. The formatter will try its best to keep line width less than this value, but it may exceed for some cases, for example, a very very long single word.

indentWidth

default: 2

Size of indentation. When enabled useTabs, this option may be disregarded, since only one tab will be inserted when indented once.

lineBreak

default: "lf"

Specify using \n ("lf") or \r\n ("crlf") for line break.

useTabs

default: false

Specify using space or tab for indentation.

ignoreCommentDirective

default: "fmt-ignore"

Text directive for ignoring formatting specific module or module field.