Início rápido

Configuração recomendada e fluxos do dia a dia.

Instalar

Instale oxfmt como dependência de desenvolvimento:

npm

$ npm add -D oxfmt

pnpm

$ pnpm add -D oxfmt

yarn

$ yarn add -D oxfmt

bun

$ bun add -D oxfmt

Adicione scripts ao package.json:

package.json

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

Formate arquivos:

npm

npm run fmt

pnpm

pnpm run fmt

yarn

yarn run fmt

bun

bun run fmt

Verifique sem gravar:

npm

npm run fmt:check

pnpm

pnpm run fmt:check

yarn

yarn run fmt:check

bun

bun run fmt:check

Uso

oxfmt [OPÇÕES] [CAMINHO]...

Sem argumentos, formata o diretório atual (equivalente a prettier --write .).

Flags no estilo --no-semi não existem: use o arquivo de config para manter consistência entre CLI e editores.

Ao usar globs nos caminhos posicionais, coloque entre aspas; caso contrário o shell pode expandir de forma inconsistente.

Lista completa em referência do CLI.

Fluxos comuns

Pré-commit com lint-staged

package.json

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

--no-error-on-unmatched-pattern evita erro quando nenhum arquivo casa com o padrão.

Criar arquivo de config

Inicie .oxfmtrc.json com padrões:

oxfmt --init

Migrar do Prettier

oxfmt --migrate prettier

Veja migrar do Prettier.

Listar arquivos diferentes

oxfmt --list-different

Útil para configurar arquivos a ignorar.

Pipe de conteúdo

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

Imprime const x = 1;

API Node.js

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"

Próximos passos

• Alterar configuração
• Editores
• CI
• Recursos avançados: ordenação, formatação embutida
• Matriz de compatibilidade
• Consulte a referência do CLI