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

chore: revert changes to README 

Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
This commit is contained in:
Prajwal S N 2024-01-04 21:18:43 +05:30
parent 90bb91d2c6
commit 6ef9fba442
No known key found for this signature in database
GPG Key ID: 60701A603988FAC2
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -16,9 +16,9 @@ when using the **--inplace** option.
### Building from source using Make ### Building from source using Make
* Clone the repository * Clone the repository
* Run `git submodule update --init --recursive` in the dfmt directory * Run ```git submodule update --init --recursive``` in the dfmt directory
* To compile with DMD, run `make` in the dfmt directory. To compile with * 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/`. LDC, run ```make ldc``` instead. The generated binary will be placed in ```dfmt/bin/```.
### Building from source using dub ### Building from source using dub
* Clone the repository * Clone the repository
@ -69,8 +69,8 @@ dfmt --inplace --space_after_cast=false --max_line_length=80 \
``` ```
## Disabling formatting ## Disabling formatting
Formatting can be temporarily disabled by placing the comments `// dfmt off` Formatting can be temporarily disabled by placing the comments ```// dfmt off```
and `// dfmt on` around code that you do not want formatted. and ```// dfmt on``` around code that you do not want formatted.
```d ```d
void main(string[] args) void main(string[] args)
@ -113,7 +113,7 @@ dfmt_align_switch_statements | **`true`**, `false` | Align labels, cases, and de
dfmt_outdent_attributes (Not yet implemented) | **`true`**, `false`| 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`** | 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` | 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 | **`true`**, `false` | 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`** | 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` | 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` | 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.
@ -124,6 +124,7 @@ dfmt_space_before_named_arg_colon | `true`, **`false`** | Adds a space after a n
dfmt_keep_line_breaks | `true`, **`false`** | Keep existing line breaks if these don't violate other formatting rules. dfmt_keep_line_breaks | `true`, **`false`** | Keep existing line breaks if these don't violate other formatting rules.
dfmt_single_indent | `true`, **`false`** | Set if the code in parens is indented by a single tab instead of two. dfmt_single_indent | `true`, **`false`** | Set if the code in parens is indented by a single tab instead of two.
dfmt_reflow_property_chains | **`true`**, `false` | Recalculate the splitting of property chains into multiple lines. dfmt_reflow_property_chains | **`true`**, `false` | Recalculate the splitting of property chains into multiple lines.
dfmt_space_after_keywords | **`true`**, `false` | Insert space after keywords (if,while,foreach,for, etc.).
## Terminology ## Terminology
* Braces - `{` and `}` * Braces - `{` and `}`