Skip to content

Update formatter.md #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
Merged

Update formatter.md #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions src/docs/guide/usage/formatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,23 @@ Also you can specify your ignore file by `--ignore-path your.ignore` flag.

VCS directories like `.git` and `.svn` are always ignored. Also global and nested ignores are not respected.

In addition, `.oxfmtrc.json(c)` also supports `ignorePatterns` field.

## Notable limitations

These will (or will not) be implemented in the future.

- Only JS and TS files are supported
- Embedded parts like css-in-js are partially supported
- Embedded parts like css-in-js are partially supported, but disabled by default
- Stdin and stdout are not supported
- Configuration is not supported for
- You need `oxc_language_server` via `oxlint` to get editor support for now
- Configuration NOT supported for:
- `prettier` field in `package.json`
- Extensions other than `.json(c)`
- File formats other than `.json(c)`
- Nested configs in sub directories
- Respect `.editorconfig`
- Inline CLI flags like `--no-semi`
- `experimentalTernaries` option
- Globs in positional paths are not expanded
- But it works in `!` prefixed exclude paths
- Plugins are not supported
Expand Down