Skip to content

Интерфейс командной строки

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

oxfmt [-c=PATH] [PATH]...

Режимы:

  • --init — Инициализировать .oxfmtrc.json значениями по умолчанию
  • --migrate=SOURCE — Перенести конфигурацию в .oxfmtrc.json из указанного источника. Доступные источники: prettier, biome
  • --lsp — Запустить языковой сервер (LSP)
  • --stdin-filepath=PATH — Имя файла для выбора парсера при чтении из stdin

Параметры вывода:

  • --write — Отформатировать и записать файлы на месте (по умолчанию)
  • --check — Проверить форматирование и показать статистику
  • --list-different — Вывести список файлов, которые были бы изменены

Параметры конфигурации

  • -c, --config=PATH — Путь к файлу конфигурации (.json, .jsonc, .ts, .mts, .cts, .js, .mjs, .cjs)
  • --disable-nested-config — Не искать файлы конфигурации в подкаталогах

Параметры игнорирования

  • --ignore-path=PATH — Путь к файлу(ам) игнора. Можно указать несколько раз. Если не задано, используются .gitignore и .prettierignore в текущем каталоге.
  • --with-node-modules — Форматировать код в каталоге node_modules (по умолчанию пропускается)

Параметры времени выполнения

  • --no-error-on-unmatched-pattern — Не завершаться с ошибкой, если шаблону ничего не соответствует
  • --threads=INT — Число потоков. Установите 1, чтобы использовать одно ядро CPU.

Позиционные аргументы:

  • PATH — Один файл, каталог или список путей. Поддерживаются glob-шаблоны (заключайте в кавычки, иначе оболочка может развернуть их до передачи в программу). Поддерживаются исключающие шаблоны с префиксом !, например '!**/fixtures/*.js'. Если не указано, используется текущий рабочий каталог.

Общие опции:

  • -h, --help — Вывести справку
  • -V, --version — Вывести версию