dfmt/README.md

dfmt

dfmt is a formatter for D source code

Status

dfmt is alpha-quality. Make backups of your files or use source control.

Building

Using Make

• Clone the repository
• Run git submodule update --init in the dfmt directory
• To compile with DMD, run make in the dfmt directory. To compile with LDC, run make ldc instead. The generated binary will be placed in dfmt/bin/.

Using

By default, dfmt reads its input from stdin and writes to stdout. If a file name is specified on the command line, input will be read from the file instead, and output will be written to stdout.

Options

• --inplace: a file name is required and the file will be edited in-place.
• --braces=otbs: Use "The One True Brace Style", placing open braces on the same line as the previous token.
• --braces=allman: Use "Allman Style", placing opening braces on their own line. This is the default.
• --tabs: Use tabs for indentation instead of spaces.

Configuration

dfmt uses EditorConfig configuration files. dfmt-specific properties are prefixed with dfmt_.

Standard EditorConfig properties

Property Name	Allowed Values	Default Value	Description
end_of_line		TODO	Not yet supported
insert_final_newline		true	Not supported. dfmt always inserts a final newline
charset		UTf-8	Not supported. dfmt only works correctly on UTF-8.
indent_style	tab, space	space	Supported
indent_size	positive integers	4	Supported
tab_width	positive integers	8	Supported
trim_trailing_whitespace		true	Not supported. dfmt does not emit trailing whitespace
max_line_length	positive integers	120	Supported

dfmt-specific properties

Property Name	Allowed Values	Default Value	Description
dfmt_brace_style	allman, otbs, or stroustrup	stroustrup	https://en.wikipedia.org/wiki/Brace_style
dfmt_soft_max_line_length	positive integers	80	The formatting process will usually keep lines below this length, but they may be up to max_line_length columns long.
dfmt_outdent_labels (Not yet implemented)	true, false	true	Decrease the indentation of labels
dfmt_align_switch_statements (Not yet implemented)	true, false	true	Align labels, cases, and defaults with their enclosing switch
dfmt_outdent_attributes (Not yet implemented)	true, false	true	Decrease the indentation level of attributes
dfmt_split_operator_at_line_end (Not yet implemented)	true, false	false	Place operators on the end of the previous line when splitting lines
dfmt_space_after_cast	true, false	false	Insert space after the closing paren of a cast expression
dfmt_space_after_keywords (Not yet implemented)	true, false	true	Insert space after if, while, foreach, etc, and before the (

Terminology

• Braces - { and }
• Brackets - [ and ]
• Parenthesis / Parens - ( and )