Skip to content

Command-line Interface

Uso

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

Opções de modo

  • --init — Inicializar .oxfmtrc.json com valores padrão
  • --migrate=SOURCE — Migrar configuração para .oxfmtrc.json a partir da fonte indicada. Fontes disponíveis: prettier, biome
  • --lsp — Iniciar servidor do Language Server Protocol (LSP)
  • --stdin-filepath=PATH — Nome do arquivo usado para inferir qual parser usar

Opções de saída

  • --write — Formatar e gravar arquivos no lugar (padrão)
  • --check — Verificar se os arquivos estão formatados e exibir estatísticas
  • --list-different — Listar arquivos que seriam alterados

Opções de configuração

  • -c, --config=PATH — Caminho do arquivo de configuração (.json, .jsonc, .ts, .mts, .cts, .js, .mjs, .cjs)
  • --disable-nested-config — Não procurar arquivos de configuração em subdiretórios

Opções de ignorar

  • --ignore-path=PATH — Caminho do(s) arquivo(s) de ignore. Pode ser repetido. Se omitido, usam-se .gitignore e .prettierignore no diretório atual.
  • --with-node-modules — Formatar código em node_modules (ignorado por padrão)

Opções de tempo de execução

  • --no-error-on-unmatched-pattern — Não sair com erro quando o padrão não corresponder a nada
  • --threads=INT — Número de threads. Use 1 para um único núcleo de CPU.

Argumentos posicionais

  • PATH — Um arquivo, diretório ou lista de caminhos. Há suporte a padrões glob (coloque entre aspas para o shell não expandir). Também há suporte a padrões de exclusão com prefixo !, por exemplo '!**/fixtures/*.js'. Se omitido, usa-se o diretório de trabalho atual.

Opções gerais

  • -h, --help — Exibir ajuda
  • -V, --version — Exibir a versão