Быстрый старт

Рекомендуемая настройка и типовые сценарии.

Установка

Установите oxfmt как dev-зависимость:

npm

$ npm add -D oxfmt

pnpm

$ pnpm add -D oxfmt

yarn

$ yarn add -D oxfmt

bun

$ bun add -D oxfmt

Добавьте скрипты в package.json:

package.json

{
  "scripts": {
    "fmt": "oxfmt",
    "fmt:check": "oxfmt --check"
  }
}

Форматирование файлов:

npm

npm run fmt

pnpm

pnpm run fmt

yarn

yarn run fmt

bun

bun run fmt

Проверка форматирования без записи файлов:

npm

npm run fmt:check

pnpm

pnpm run fmt:check

yarn

yarn run fmt:check

bun

bun run fmt:check

Использование

oxfmt [OPTIONS] [PATH]...

Запуск oxfmt без аргументов форматирует текущий каталог (аналог prettier --write .).

Опции CLI вроде --no-semi не поддерживаются. Вместо этого используйте файл конфигурации, чтобы настройки были одинаковыми в CLI и в интеграциях с редакторами.

При использовании glob-путей в позиционных аргументах заключайте их в кавычки — иначе оболочка может или не может их развернуть в зависимости от окружения.

Полный список опций см. в справочнике CLI.

Типовые сценарии

Pre-commit с lint-staged

package.json

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

--no-error-on-unmatched-pattern предотвращает ошибку, когда ни один файл не подходит под шаблон.

Создать файл конфигурации

Инициализируйте .oxfmtrc.json значениями по умолчанию:

oxfmt --init

Миграция с Prettier

oxfmt --migrate prettier

Подробности см. в разделе миграция с Prettier.

Список отличающихся файлов

oxfmt --list-different

Удобно для настройки игнорируемых файлов.

Передача содержимого через pipe

echo 'const   x   =   1' | oxfmt --stdin-filepath test.ts

Вывод: const x = 1;

Node.js API

import { format, type FormatOptions } from "oxfmt";

const input = `let a=42;`;
const options: FormatOptions = {
  semi: false,
};

const { code } = await format("a.js", input, options);
console.log(code); // "let a = 42"

Дальнейшие шаги

• Изменить конфигурацию
• Настроить редакторы
• Настроить CI
• Дополнительные возможности: сортировка, встроенное форматирование
• Матрица совместимости
• Справочник CLI