Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into no-dupe-keys
Browse files Browse the repository at this point in the history
* upstream/main:
  fix(website): fix grammar mistake (rome#3666)
  doc(website): Use `pnpm rome` and `yarn rome` instead of longer versions
  docs: change indent-style from tabs to tab (rome#3657)
  Revert "[website] Port docs to astro" (rome#3662)
  [website] Port docs to astro (rome#3659)
  • Loading branch information
jeysal committed Nov 11, 2022
2 parents fed78da + c8c6bfd commit 725d684
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions website/docs/src/formatter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ few options to avoid that debates over styles turn into debates over Rome option

The language agnostic options supported by Rome are:

- indent style (default: `tabs`): Use spaces or tabs for indention
- indent style (default: `tab`): Use spaces or tabs for indention
- tab width (default: `2`): The number of spaces per indention level
- line width (default: `80`): The column width at which Rome wraps code

Expand All @@ -36,7 +36,7 @@ USAGE:
OPTIONS:
--write Edit the files in place (beware!) instead of printing the diff to the console
--skip-errors Skip over files containing syntax errors instead of emitting an error diagnostic.
--indent-style <tabs|space> Change the indention character (default: tabs)
--indent-style <tab|space> Change the indention character (default: tab)
--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> Change how many characters the formatter is allowed to print in a single line (default: 80)
--quote-style <single|double> Changes the quotation character for strings (default: ")
Expand Down
18 changes: 9 additions & 9 deletions website/docs/src/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can now use `npx rome` to run Rome.
pnpm install --save-dev rome
```

You can now use `pnpm exec rome` to run Rome.
You can now use `pnpm rome` to run Rome.


#### yarn
Expand All @@ -42,7 +42,7 @@ You can now use `pnpm exec rome` to run Rome.
yarn add rome --save-dev
```

You can now use `yarn run rome` to run Rome.
You can now use `yarn rome` to run Rome.

## Configuration

Expand All @@ -54,10 +54,10 @@ To create the configuration, run the `init` command in the root folder of your p
npx rome init

# or
pnpm exec rome init
pnpm rome init

# or
yarn run rome init
yarn rome init
```

After running the `init` command, you'll have a `rome.json` configuration file in your directory.
Expand All @@ -76,7 +76,7 @@ After running the `init` command, you'll have a `rome.json` configuration file i

The `linter.enabled: true` enables the linter and `rules.recommended: true` enables the [recommended rules](/lint/rules/).

Formatting is enabled because the configuration doesn't explicitly [disables](/configuration/#formatterenabled) formatting with `formatter.enabled: false`.
Formatting is enabled because the configuration doesn't explicitly [disable](/configuration/#formatterenabled) formatting with `formatter.enabled: false`.

## Usage

Expand All @@ -86,10 +86,10 @@ You can lint any file or directory running:
npx rome check <files>

# or
pnpm exec rome check <files>
pnpm rome check <files>

# or
yarn run rome check <files>
yarn rome check <files>
```

or format your files and directories with:
Expand All @@ -99,10 +99,10 @@ or format your files and directories with:
npx rome format <files> --write

# or
pnpm exec rome format <files> --write
pnpm rome format <files> --write

# or
yarn run rome format <files> --write
yarn rome format <files> --write
```

<!-- Make sure to update the redirect in `static/_redirects` when changing the editors title -->
Expand Down

0 comments on commit 725d684

Please sign in to comment.