Formatting Features

Typstyle follows a consistent set of formatting rules to ensure your Typst code is readable, maintainable, and follows established conventions. This page documents the core formatting styles applied by Typstyle.

• Default line width: 80 characters (configurable with --line-width--line-width)
• Default indentation: 2 spaces per level (configurable with --indent-width--indent-width)
• File endings: Documents containing content end with a newline character. Partial formatting follows the selected node’s layout.

Typstyle preserves trailing spaces and whitespace-only lines inside multiline strings, raw blocks, and source protected by @typstyle off@typstyle off. These spaces can affect content and are not removed by a global cleanup pass.

Blank lines created by the layout carry no indentation, and generated flow separators are omitted at line boundaries. The same behavior applies to partial formatting and aligned math.

Comments have their own normalization rules: trailing whitespace is removed from line comments and from block-comment lines with leading stars.

Inline comments are preserved and positioned correctly:

1
#let conf(   title: none,//comments
2
authors: (),
3
  abstract: [],
4
    lang:     "zh",// language
5
  doctype: "book",//comments
6
7
doc,// my docs
8
) = { doc
9
}
10
11
#{
12
  let c = 0// my comment
13
}

1
#let conf(   title: none,//comments
2
authors: (),
3
  abstract: [],
4
    lang:     "zh",// language
5
  doctype: "book",//comments
6
7
doc,// my docs
8
) = { doc
9
}
10
11
#{
12
  let c = 0// my comment
13
}

1
#let conf(
2
  title: none, //comments
3
  authors: (),
4
  abstract: [],
5
  lang: "zh", // language
6
  doctype: "book", //comments
7
8
  doc, // my docs
9
) = { doc }
10
11
#{
12
  let c = 0 // my comment
13
}
14

1
#let conf(
2
  title: none, //comments
3
  authors: (),
4
  abstract: [],
5
  lang: "zh", // language
6
  doctype: "book", //comments
7
8
  doc, // my docs
9
) = { doc }
10
11
#{
12
  let c = 0 // my comment
13
}
14

Block comments are automatically aligned and formatted:

1
#{
2
  let x = 1   /* Attached block comment
3
      that spans
4
 multiple lines
5
  */
6
7
  /* Block comment
8
      that spans
9
 multiple lines
10
  */
11
}
12
13
Aligned: /* Block comment with leading stars
14
    *  that
15
        *  spans
16
 *  multiple
17
    *  lines
18
  */

1
#{
2
  let x = 1   /* Attached block comment
3
      that spans
4
 multiple lines
5
  */
6
7
  /* Block comment
8
      that spans
9
 multiple lines
10
  */
11
}
12
13
Aligned: /* Block comment with leading stars
14
    *  that
15
        *  spans
16
 *  multiple
17
    *  lines
18
  */

1
#{
2
  let x = 1 /* Attached block comment
3
                 that spans
4
            multiple lines
5
             */
6
7
  /* Block comment
8
       that spans
9
  multiple lines
10
   */
11
}
12
13
Aligned: /* Block comment with leading stars
14
          *  that
15
          *  spans
16
          *  multiple
17
          *  lines
18
          */
19

1
#{
2
  let x = 1 /* Attached block comment
3
                 that spans
4
            multiple lines
5
             */
6
7
  /* Block comment
8
       that spans
9
  multiple lines
10
   */
11
}
12
13
Aligned: /* Block comment with leading stars
14
          *  that
15
          *  spans
16
          *  multiple
17
          *  lines
18
          */
19

Use // @typstyle off// @typstyle off to disable formatting for specific code regions:

1
// @typstyle off
2
#let intentionally_bad_format    =    "preserved";
3
#let properly_formatted="cleaned up"

1
// @typstyle off
2
#let intentionally_bad_format    =    "preserved";
3
#let properly_formatted="cleaned up"

1
// @typstyle off
2
#let intentionally_bad_format    =    "preserved";
3
#let properly_formatted = "cleaned up"
4

1
// @typstyle off
2
#let intentionally_bad_format    =    "preserved";
3
#let properly_formatted = "cleaned up"
4

For details, please see Escape Hatch.