Skip to content

Commit

Permalink
Update README.md (#6423)
Browse files Browse the repository at this point in the history
## Description

Support for configuration in the formatter is not planned.

## Checklist

- [ ] I have linked to any relevant issues.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.
  • Loading branch information
sdankel authored Aug 16, 2024
1 parent a82e954 commit 2de5daf
Showing 1 changed file with 0 additions and 51 deletions.
51 changes: 0 additions & 51 deletions swayfmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,3 @@ A tool for formatting Sway code according to style guidelines.

- To use `swayfmt`, install the [forc-fmt](../forc-plugins/forc-fmt/) plugin using [fuelup](https://github.com/FuelLabs/fuelup).
- To contribute to `swayfmt`, see [CONTRIBUTING](./CONTRIBUTING.md).

## Configuration with `swayfmt.toml`

Swayfmt _is_ meant to be configurable, however currently it only supports the default configuration options.

> **Note:** Not all `Config` options are guaranteed to work
> and most are not implemented. Configuration options are
> subject to change between versions without notice.
> If you would like to see a feature implemented, or
> implement a feature please refer to the [CONTRIBUTING guide](./CONTRIBUTING.md).
The default `swayfmt.toml`:

```toml
max_width = 100
hard_tabs = false
tab_spaces = 4
newline_style = Auto
indent_style = Block
newline_threshold = 1
group_imports = Preserve
imports_granularity = Preserve
imports_indent = Block
reorder_imports = true
reorder_modules = true
reorder_impl_items = false
item_brace_style = SameLineWhere
blank_lines_upper_bound = 1
blank_lines_lower_bound = 0
empty_item_single_line = true
format_strings = false
hex_literal_case = Preserve
expr_brace_style = AlwaysSameLine
trailing_semicolon = true
space_before_colon = false
space_after_colon = false
type_combinator_layout = Wide
spaces_around_ranges = false
match_block_trailing_comma = false
match_arm_leading_pipe = Never
force_multiline_blocks = false
fn_args_layout = Tall
fn_single_line = false
heuristics_pref = Scaled
use_small_heuristics = true
field_alignment = Off
small_structures_single_line = true
wrap_comments = false
comment_width = 80
normalize_comments = false
```

0 comments on commit 2de5daf

Please sign in to comment.