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

# miyajan/prettier

Prettier is an opinionated formatter https://github.com/prettier/prettier
Check files that are different from Prettier formatting in your repository.
https://github.com/miyajan/prettier-orb


## Commands

### prettier_list_different

Run prettier --list-different over files in the repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `ignore_path` | string | ./.prettierignore | https://prettier.io/docs/en/cli.html#ignore-path
Path to a file containing patterns that describe files to ignore.
By default, prettier looks for ./.prettierignore
 |
| `extension` | string |  | Files that have this extension are checked by prettier.
To specify multiple extensions, use comma separated string. (e.g. yml,yaml)
 |

## Jobs

### check-javascript

Run prettier --list-different over any JavaScript files in the repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `ignore_path` | string | ./.prettierignore | https://prettier.io/docs/en/cli.html#ignore-path
Path to a file containing patterns that describe files to ignore.
By default, prettier looks for ./.prettierignore
 |

### check-typescript

Run prettier --list-different over any TypeScript files in the repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `ignore_path` | string | ./.prettierignore | https://prettier.io/docs/en/cli.html#ignore-path
Path to a file containing patterns that describe files to ignore.
By default, prettier looks for ./.prettierignore
 |

### check-markdown

Run prettier --list-different over any Markdown files in the repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `ignore_path` | string | ./.prettierignore | https://prettier.io/docs/en/cli.html#ignore-path
Path to a file containing patterns that describe files to ignore.
By default, prettier looks for ./.prettierignore
 |

### check-yaml

Run prettier --list-different over any YAML files in the repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `ignore_path` | string | ./.prettierignore | https://prettier.io/docs/en/cli.html#ignore-path
Path to a file containing patterns that describe files to ignore.
By default, prettier looks for ./.prettierignore
 |

## Executors

### prettier