Skip to content

Игнорируемые файлы

Oxfmt позволяет исключать файлы из форматирования несколькими способами.

Часть механизмов действует глобально, другие привязаны к файлу конфигурации:

МеханизмОбласть действия
Пути CLI с префиксом !Глобально
.prettierignore / --ignore-pathГлобально
ignorePatterns в конфигеОбласть этого конфига

При вложенной конфигурации ignorePatterns применяется только к файлам, для которых выбран именно этот конфиг. Глобальные механизмы действуют всегда, независимо от активного конфига.

ignorePatterns

Рекомендуемый способ игнорирования. Добавьте в конфиг Oxfmt:

json
{
  "ignorePatterns": ["dist/**", "*.min.js"]
}
ts
import { defineConfig } from "oxfmt";

export default defineConfig({
  ignorePatterns: ["dist/**", "*.min.js"],
});
  • Синтаксис как у .gitignore
  • Пути считаются относительно каталога с файлом конфигурации Oxfmt
  • Специфично для форматтера и не зависит от Git

Файлы, попадающие под ignorePatterns, нельзя отформатировать, даже если указать их явно.

.gitignore

Oxfmt учитывает .gitignore в дереве текущего каталога.

  • Глобальный gitignore и .gitignore в родительских каталогах не читаются
  • Каталог .git не обязателен

Файлы, игнорируемые .gitignore, можно отформатировать, если указать их явно.

Каталоги СКВ и node_modules

По умолчанию игнорируются: .git, .svn, .jj, node_modules

Чтобы включить node_modules, используйте --with-node-modules.

Файлы блокировок

package-lock.json, pnpm-lock.yaml и т.п. всегда игнорируются.

.prettierignore

Поддерживается для совместимости с Prettier. Синтаксис как у .gitignore.

Файлы из .prettierignore нельзя отформатировать, даже при явном указании.

Для новых проектов предпочтительнее ignorePatterns.