ocaml/dune

disable auto formatting for specific dune files

Aberta

#10.862 aberto em 30 de ago. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)OCaml (478 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (1.882 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 20h) (345 fundiu PRs em 30d)

Description

Desired Behavior

In a dune file, having a stanza (formatting disabled) would ensure that the file doesn't get touched when dune build @fmt runs.

We have dune files where the content written by hand is much more readable then when it's being auto formatted. Often because of what is explained in #10861, but not only. In those cases it would be nice to be able to preserve part of a dune file or a whole dune file.

Guia do colaborador

Direção de pesquisa
Identifique onde a lógica de formatação do dune está implementada (provavelmente no código fonte do dune) e adicione suporte para uma estrofe `(formatting disabled)` que impeça a formatação do arquivo.
Pilha de tecnologia
None
Domain
build system
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic knowledge of dune build system
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75