> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# kbravh/rome

An orb to run Rome commands


## Commands

### check

Runs rome check command. https://romefrontend.dev/#rome-check


| Parameter | Type | Default | Description |
|---|---|---|---|
| `app-dir` | string | . | Path to the directory containing your package.json file. Not needed if package.json lives in the root.
 |
| `options` | string |  | Other options to pass to the Rome check command. https://romefrontend.dev/#global-flags
 |
| `paths` | string |  | The files or directories to check, if you don't want to check the entire project.
 |
| `pkg-manager` | enum | npm | The package manager to use to install the project dependencies.
 |
| `skip-install` | boolean | false | This will skip the step for installing dependencies.
 |

## Examples

### rome_lint

Linting a yarn project with Rome.


```yaml
version: '2.1'
orbs:
  node: circleci/node@4.0.1
  rome: kbravh/rome@dev:alpha
jobs:
  lint:
    executor: node/default
    steps:
      - rome/check:
          pkg-manager: yarn
workflows: null
```