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

make readme look nicer

This commit is contained in:
Viktor 2019-04-13 15:04:22 +03:00 committed by GitHub
parent 793a575b1c
commit ac5f8b18aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@ -23,33 +23,33 @@ 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 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**. file instead, and output will be written to **stdout**.
**dfmt** uses EditorConfig files for configuration. If you run **dfmt** on a **dfmt** uses [EditorConfig](http://editorconfig.org/) files for configuration. If you run **dfmt** on a
source file it will look for .editorconfig files that apply to that source file. source file it will look for *.editorconfig* files that apply to that source file.
If no file is specified on the command line, **dfmt** will look for .editorconfig If no file is specified on the command line, **dfmt** will look for *.editorconfig*
files that would apply to a D file in the current working directory. Command files that would apply to a D file in the current working directory. Command
line options can be used instead of .editorconfig files, or to override options line options can be used instead of *.editorconfig* files, or to override options
found in .editorconfig files. found there.
### Options ### Options
* **--help | -h**: Display command line options * `--help | -h`: Display command line options
* **--inplace | -i**: A file name is required and the file will be edited in-place. * `--inplace | -i`: A file name is required and the file will be edited in-place.
* **--align_switch_statements**: See **dfmt_align_switch_statements** below * `--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 * `--end_of_line`: See **end_of_line** below
* **--indent_size**: See **indent_size** below * `--indent_size`: See **indent_size** below
* **--indent_style | -t**: See **indent_style** below * `--indent_style | -t`: See **indent_style** below
* **--max_line_length**: See **max_line_length** below * `--max_line_length`: See **max_line_length** below
* **--soft_max_line_length**: See **dfmt_soft_max_line_length** below * `--soft_max_line_length`: See **dfmt_soft_max_line_length** below
* **--outdent_attributes**: See **dfmt_outdent_attributes** below * `--outdent_attributes`: See **dfmt_outdent_attributes** below
* **--single_template_constraint_indent**: See **dfmt_template_constraint_style** below * `--single_template_constraint_indent`: See **dfmt_template_constraint_style** below
* **--space_after_cast**: See **dfmt_space_after_cast** below * `--space_after_cast`: See **dfmt_space_after_cast** below
* **--space_before_function_parameters**: See **dfmt_space_before_function_parameters** below * `--space_before_function_parameters`: See **dfmt_space_before_function_parameters** below
* **--split_operator_at_line_end**: See **dfmt_split_operator_at_line_end** below * `--split_operator_at_line_end`: See **dfmt_split_operator_at_line_end** below
* **--tab_width**: See **tab_width** below * `--tab_width`: See **tab_width** below
* **--selective_import_space**: See **dfmt_selective_import_space** below * `--selective_import_space`: See **dfmt_selective_import_space** below
* **--compact_labeled_statements**: See **dfmt_compact_labeled_statements** below * `--compact_labeled_statements`: See **dfmt_compact_labeled_statements** below
* **--template_constraint_style**: See **dfmt_template_constraint_style** below * `--template_constraint_style`: See **dfmt_template_constraint_style** below
* **--space_before_aa_colon**: See **dfmt_space_before_aa_colon** below * `--space_before_aa_colon`: See **dfmt_space_before_aa_colon** below
### Example ### Example
``` ```
@ -68,7 +68,7 @@ void main(string[] args)
// dfmt has no way of knowing that "getopt" is special, so it wraps the // dfmt has no way of knowing that "getopt" is special, so it wraps the
// argument list normally // argument list normally
getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree); getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree);
// dfmt off // dfmt off
getopt(args, getopt(args,
@ -83,32 +83,32 @@ void main(string[] args)
**dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files. **dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files.
**dfmt**-specific properties are prefixed with *dfmt_*. **dfmt**-specific properties are prefixed with *dfmt_*.
### Standard EditorConfig properties ### Standard EditorConfig properties
Property Name | Allowed Values | Default Value | Description Property Name | Allowed Values | Description
--------------|----------------|---------------|------------ --------------|----------------|------------
end_of_line | `cr`, `crlf` and `lf` | `lf` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#end_of_line) end_of_line | `cr`, `crlf` and **`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. insert_final_newline | **`true`** | Not supported. `dfmt` always inserts a final newline.
charset | | `UTF-8` | Not supported. `dfmt` only works correctly on UTF-8. 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_style | `tab`, **`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) indent_size | positive integers (**`4`**) | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_size)
tab_width | positive integers | `4` | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#tab_width) tab_width | positive integers (**`4`**) | [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. 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) max_line_length | positive integers (**`120`**) | [See EditorConfig documentation.](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#max_line_length)
### dfmt-specific properties ### dfmt-specific properties
Property Name | Allowed Values | Default Value | Description Property Name | Allowed Values | Description
--------------|----------------|---------------|------------ --------------|----------------|------------
dfmt_brace_style | `allman`, `otbs`, or `stroustrup` | `allman` | [See Wikipedia](https://en.wikipedia.org/wiki/Brace_style) dfmt_brace_style | **`allman`**, `otbs`, or `stroustrup` | [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_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_align_switch_statements (Not yet implemented) | `true`, `false` | `true` | Align labels, cases, and defaults with their enclosing switch. dfmt_align_switch_statements (Not yet implemented) | **`true`**, `false` | 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_outdent_attributes (Not yet implemented) | **`true`**, `false`| Decrease the indentation level of attributes.
dfmt_split_operator_at_line_end | `true`, `false` | `false` | Place operators on the end of the previous line when splitting lines. dfmt_split_operator_at_line_end | `true`, **`false`** | Place operators on the end of the previous line when splitting lines.
dfmt_space_after_cast | `true`, `false` | `true` | Insert space after the closing paren of a `cast` expression. dfmt_space_after_cast | **`true`**, `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_space_after_keywords (Not yet implemented) | **`true`**, `false` | Insert space after `if`, `while`, `foreach`, etc, and before the `(`.
dfmt_space_before_function_parameters | `true`, `false` | `false` | Insert space before the opening paren of a function parameter list. dfmt_space_before_function_parameters | `true`, **`false`** | Insert space before the opening paren of a function parameter list.
dfmt_selective_import_space | `true`, `false` | `true` | Insert space after the module name and before the `:` for selective imports. dfmt_selective_import_space | **`true`**, `false` | Insert space after the module name and before the `:` for selective imports.
dfmt_compact_labeled_statements | `true`, `false` | `true` | Place labels on the same line as the labeled `switch`, `for`, `foreach`, or `while` statement. dfmt_compact_labeled_statements | **`true`**, `false` | Place labels on the same line as the labeled `switch`, `for`, `foreach`, or `while` statement.
dfmt_template_constraint_style | `conditional_newline_indent` `conditional_newline` `always_newline` `always_newline_indent` | `conditional_newline_indent` | Control the formatting of template constraints. dfmt_template_constraint_style | **`conditional_newline_indent`** `conditional_newline` `always_newline` `always_newline_indent` | Control the formatting of template constraints.
dfmt_single_template_constraint_indent | `true`, `false` | `false` | Set if the constraints are indented by a single tab instead of two. Has only an effect for if indentation style if set to `always_newline_indent` or `conditional_newline_indent`. dfmt_single_template_constraint_indent | `true`, **`false`** | Set if the constraints are indented by a single tab instead of two. Has only an effect if the style set to `always_newline_indent` or `conditional_newline_indent`.
dfmt_space_before_aa_colon | `true`, `false` | `false` | Adds a space after an associative array key before the `:` like in older dfmt versions. dfmt_space_before_aa_colon | `true`, **`false`** | Adds a space after an associative array key before the `:` like in older dfmt versions.
## Terminology ## Terminology
* Braces - `{` and `}` * Braces - `{` and `}`