forks
/
dfmt
mirror of https://github.com/dlang-community/dfmt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Hackerpilot 2015-04-20 10:23:11 -07:00
parent f5fe035bf7
commit 269188338e
1 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -2,8 +2,8 @@
**dfmt** is a formatter for D source code
## Status
**dfmt** is alpha-quality. Make backups of your files or use source control.
**dfmt** is beta quality. Make backups of your files or use source control
when using the **--inplace** option.
## Building
### Using Make
@ -21,7 +21,7 @@ file instead, and output will be written to **stdout**.
* **--help**: Display command line options
* **--inplace**: A file name is required and the file will be edited in-place.
* **--align_switch_statements**: See **dfmt_align_switch_statements** below
* **--brace_style**: See ``brace_style** below
* **--brace_style**: See **brace_style** below
* **--end_of_line**: See **end_of_line** below
* **--indent_size**: See **indent_size** below
* **--indent_style**: See **indent_style** below
@ -34,7 +34,10 @@ file instead, and output will be written to **stdout**.
* **--tab_width**: See **tab_width** below
### Example
```dfmt --inplace --space_after_cast=false --max_line_length=80 --soft_max_line_length=70 file.d```
```
dfmt --inplace --space_after_cast=false --max_line_length=80 \
--soft_max_line_length=70 file.d
```
## Configuration
**dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files.
@ -42,25 +45,25 @@ file instead, and output will be written to **stdout**.
### Standard EditorConfig properties
Property Name | Allowed Values | Default Value | Description
--------------|----------------|---------------|------------
end_of_line | **cr**, **crlf** and **lf** | **lf** | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#end_of_line)
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** | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_style)
indent_size | positive integers | **4** | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_size)
tab_width | positive integers | **8** | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#tab_width)
trim_trailing_whitespace | | **true** | Not supported. **dfmt** does not emit trailing whitespace.
max_line_length | positive integers | **120** | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#max_line_length)
end_of_line | `cr`, `crlf` and `lf` | `lf` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#end_of_line)
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` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_style)
indent_size | positive integers | `4` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_size)
tab_width | positive integers | `8` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#tab_width)
trim_trailing_whitespace | | `true` | Not supported. `dfmt` does not emit trailing whitespace.
max_line_length | positive integers | `120` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#max_line_length)
### dfmt-specific properties
Property Name | Allowed Values | Default Value | Description
--------------|----------------|---------------|------------
dfmt_brace_style | **allman**, **otbs**, or **stroustrup** | **allman** | [See Wikipedia](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 **(**
dfmt_brace_style | `allman`, `otbs`, or `stroustrup` | `allman` | [See Wikipedia](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 `}`