其他

migrate-oxfmt

oxc-project/oxc

Guide for migrating a project from Prettier or Biome to Oxfmt. Use when asked to migrate, convert, or switch a project's formatter from Prettier or Biome to Oxfmt.

  • 4244 次安装
  • 2.3万 星标
  • 收录于

安装命令

npx skills add https://github.com/oxc-project/oxc --skill migrate-oxfmt

SKILL.md

This skill guides you through migrating a project from Prettier or Biome to Oxfmt.

Overview

Oxfmt is a high-performance, Prettier-compatible code formatter. Most Prettier options are supported directly.

An automated migration tool is built into Oxfmt, supporting both Prettier and Biome as migration sources.

Step 1: Run Automated Migration

First, decide whether the automated tool fits:

  • Static config (JSON, or a JS/TS config that just exports a plain object): use --migrate below.
  • Dynamic JS/TS config (logic such as environment branches or computed values): --migrate writes only a resolved snapshot of the values, and the logic does not survive (a warning is printed). Port the logic to oxfmt.config.ts manually with the option mappings in this guide.
  • Nested per-directory configs: --migrate only handles the config in the current directory. Run it again in each nested directory (see "Nested Config" in Step 2).

From Prettier

This skill guides you through migrating a project from Prettier or Biome to Oxfmt.

Overview

Oxfmt is a high-performance, Prettier-compatible code formatter. Most Prettier options are supported directly.

An automated migration tool is built into Oxfmt, supporting both Prettier and Biome as migration sources.

Step 1: Run Automated Migration

First, decide whether the automated tool fits:

  • Static config (JSON, or a JS/TS config that just exports a plain object): use --migrate below.
  • Dynamic JS/TS config (logic such as environment branches or computed values): --migrate writes only a resolved snapshot of the values, and the logic does not survive (a warning is printed). Port the logic to oxfmt.config.ts manually with the option mappings in this guide.
  • Nested per-directory configs: --migrate only handles the config in the current directory. Run it again in each nested directory (see "Nested Config" in Step 2).

From Prettier