Migrating from Prettier to Oxfmt

If you currently use Prettier as your code formatter, you can follow this guide to migrate to Oxfmt.

Note that Oxfmt is in alpha, and may not be suitable for production use in complex setups. For the beta milestone, we may provide migration commands.

oxfmt: --migrate prettier · Issue #15849 · oxc-project/oxc
https://github.com/oxc-project/oxc/issues/15849

Caveats for migrating to Oxfmt

Before migrating, ensure that the current release of the Oxfmt alpha meets your project's needs. It is almost entirely compatible with Prettier v3.7 already for basic configurations, but less-common config options and other features are not yet implemented.

The Oxfmt alpha only supports formatting JavaScript and TypeScript files (including those with JSX syntax). If you need support for non-JSX frameworks like Vue or Ember, or other languages like JSON, YAML, or Markdown, you will likely want to wait.

Other important considerations when migrating from Prettier to Oxfmt:

• Oxfmt's formatting output is closest to Prettier v3.7. You will see more differences migrating from an older version of Prettier.
• Oxfmt uses a printWidth of 100 characters by default, whereas Prettier's default is 80. Make sure to set "printWidth": 80 in .oxfmtrc.jsonc to minimize differences if you use the Prettier default.
• Prettier plugins are not yet supported.
• Some Prettier options are not supported. See the oxfmt CLI documentation for the full list of currently-supported options.
• Oxfmt supports an --lsp flag to spin up a Language Server Protocol server, but editor/IDE integration is still being developed and has not been tested/documented yet for most editors.

Many of these limitations will be addressed in the future, with the Beta or Stable releases of Oxfmt.

See also the Oxfmt FAQ for any other potential caveats or limitations you may need to consider.

Step 1: Upgrade Prettier to v3.7 (Optional)

This step is optional, but will make it easier to determine which differences between Oxfmt and Prettier are "real".

To minimize the number of changes when migrating to Oxfmt, you should upgrade Prettier to version 3.7 first and reformat all JS/TS files with it, as it is the latest release of Prettier (from Nov 2025) and will be most similar to the output of Oxfmt.

Step 2: Install Oxfmt

Install Oxfmt as a development dependency with your package manager of choice:

npm

$ npm add -D oxfmt@latest

pnpm

$ pnpm add -D oxfmt@latest

yarn

$ yarn add -D oxfmt@latest

bun

$ bun add -D oxfmt@latest

deno

$ deno add -D npm:oxfmt@latest

Step 3: Migrate Prettier configuration file

.oxfmtrc.jsonc is the configuration file for Oxfmt. Only JSON files are supported.

A basic .oxfmtrc.jsonc file looks like this:

{
  "$schema": "./node_modules/oxfmt/configuration_schema.json",
  "printWidth": 80,
}

If you have a basic .prettierrc file, you can simply rename the file with mv .prettierrc .oxfmtrc.jsonc.

If you are using something other than JSON to configure Prettier, you will need to convert the configuration to JSON.

prettierrc.js

Here's an example of migrating a prettierrc.js file.

Before:

module.exports = {
  singleQuote: true,
  jsxSingleQuote: true,
};

After (.oxfmtrc.jsonc):

{
  "$schema": "./node_modules/oxfmt/configuration_schema.json",
  "singleQuote": true,
  "jsxSingleQuote": true,
  "printWidth": 80,
}

prettierrc.yaml

Here's an example of migrating a prettierrc.yaml file.

Before:

trailingComma: "es5"
tabWidth: 4
semi: false
singleQuote: true

After (.oxfmtrc.jsonc):

{
  "$schema": "./node_modules/oxfmt/configuration_schema.json",
  "trailingComma": "es5",
  "tabWidth": 4,
  "semi": false,
  "singleQuote": true,
  "printWidth": 80,
}

Step 4: Update Formatting Scripts

Update any formatting scripts you currently have, for example in package.json, shell scripts, or pre-commit scripts.

package.json scripts

{
  "scripts": {
-   "format": "prettier --write .",
+   "format": "oxfmt",
-   "format:check": "prettier --check ."
+   "format:check": "oxfmt --check"
  }
}

CI Workflows

Update any CI workflows that run Prettier, particularly prettier --check.

  - name: Check formatting
-   run: yarn prettier --check .
+   run: yarn oxfmt --check

Git Hooks (e.g. husky, lint-staged)

"lint-staged": {
- "*": "prettier --write --no-error-on-unmatched-pattern"
+ "*": "oxfmt --no-error-on-unmatched-pattern"
}

Step 5: Run formatter

Run Oxfmt on your codebase to check for any changes and ensure that the configuration was migrated correctly:

# Your script specified in Step 4
npm run format

If you no longer need Prettier, you can uninstall for now.

Done!

You have now migrated to Oxfmt 😃

Please see the section below for any additional, optional steps you may need to take.

These are only applicable for some setups, so skip them if they don't apply to you.

Update editor integrations

See the Formatter FAQ for details on editor/IDE integration with Oxfmt.

Update CONTRIBUTING.md and AGENTS.md/CLAUDE.md

If you have a CONTRIBUTING.md file that references Prettier, update those references to use Oxfmt.

If you use an AGENTS.md or CLAUDE.md file to help LLM tools understand your codebase, you should also check for references to Prettier in those files.

Update lint rules

If you have any lint rules that explicitly check for Prettier formatting (e.g. eslint-plugin-prettier), you should remove them.

While you're at it, you could also consider migrating to oxlint 😉

Create/update .git-blame-ignore-revs

If you want to avoid extra noise in your git blame history, you can add the commit SHA where you reformatted files using Oxfmt to your .git-blame-ignore-revs file. This will make git blame ignore that commit when showing blame information. This file is supported natively by git, and by both GitHub and GitLab.