Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Commit

Permalink
docs(website): update formatter options (#2389)
Browse files Browse the repository at this point in the history
* docs(website): update formatter options

* chore(rome, vscode): update versions

* chore: revert version changes
  • Loading branch information
ematipico authored Apr 27, 2022
1 parent 41634a0 commit 3c55310
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Rome changelog

## 0.5.0

- BREAKING CHANGES: the `format` command doesn't write on disk by default. Now the command prints on terminal.

**Migration**: add the `--write` argument when calling `rome format`

```shell
rome format --write
```

- Added a new option called `--quote-style` to the formatter. This option is also available on VSCode.

## 0.4.0

Rome has been [rewritten in Rust](https://rome.tools/blog/2021/09/21/rome-will-be-rewritten-in-rust)!
Expand Down
12 changes: 7 additions & 5 deletions website/src/_includes/docs/formatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,13 @@ USAGE:
INPUTS can be one or more filesystem path, each pointing to a single file or an entire directory to be searched recursively for supported files

OPTIONS:
--ci Enable CI mode, lock files and exit with an error if the formatter would modify them
--skip-errors Skip over files containing syntax errors instead of returning an error
--indent-style <tabs|space> Determine whether the formatter should use tabs or spaces for indentation (default: tabs)
--indent-size <number> If the indentation style is set to spaces, determine how many spaces should be used for indentation (default: 2)

--write Write the output of the formatter to the files instead of printing the diff to the console
--ci Enable CI mode, lock files and exit with an error if the formatter would modify them
--skip-errors Skip over files containing syntax errors instead of returning an error
--indent-style <tabs|space> Determine whether the formatter should use tabs or spaces for indentation (default: tabs)
--indent-size <number> If the indentation style is set to spaces, determine how many spaces should be used for indentation (default: 2)
--line-width <number> Determine how many characters the formatter is allowed to print in a single line (default: 80)
--quote-style <single|double> Determine whether the formatter should use single or double quotes for strings (default: double)
```
### Suppression
Expand Down

0 comments on commit 3c55310

Please sign in to comment.