TidySmith

Por que o TidySmith

Recursos

• Ordenar membros de uma classe, de um arquivo ou dos arquivos selecionados no Gerenciador de Soluções — com uma visualização do que se move.
• Dicas no editor: pontos cinza onde algo pode ser arrumado, a correção na lâmpada (Ctrl+.).
• Regiões pelas suas regras: por grupo de membros, por acesso ou ambos, com seus nomes de região; ou nenhuma região.
• Comentários que cabem: comentários // e /// quebrados no seu comprimento de linha, linhas curtas unidas.
• Arrumar ao salvar: as etapas que você escolher são executadas quando um arquivo C# é salvo; desativado por padrão.
• Janela Structure: os membros do arquivo, tamanho e complexidade dos métodos, arrastar para reordenar.
• Pequenos utilitários: alternar para o arquivo relacionado, ordenar e unir linhas, localizar o arquivo no Gerenciador de Soluções, recolher ou expandir apenas as regiões.

Todos os comandos estão em Editar › TidySmith e no menu de contexto do editor de código (clique com o botão direito › TidySmith); Order Members também no menu de contexto de arquivos, pastas e projetos no Gerenciador de Soluções.

Ordenar membros

Order Members… ordena os membros de uma classe por tipo (constantes, campos, construtores, propriedades, métodos…), depois por acesso (public primeiro), estáticos antes dos de instância e, se você quiser, por nome — na ordem definida na página de opções ou no .editorconfig.

• Primeiro uma visualização: o diff do que se move; Aplicar é uma única edição, então um Desfazer reverte tudo. “Não perguntar novamente” desativa a visualização.
• Onde: a classe no cursor ou o arquivo inteiro (escolhido na visualização), ou todos os arquivos C# selecionados no Gerenciador de Soluções — arquivos, pastas, projetos.
• O que se move com um membro: seus comentários, documentação e atributos. As linhas em branco ficam como estavam; uma linha em branco vai entre os grupos.
• O que nunca é tocado: membros dentro de #if ou #region são ordenados apenas dentro do seu bloco; classes com um membro na linha de uma chave, dois membros em uma linha ou erros de sintaxe ficam como estão; arquivos gerados (*.g.cs, *.Designer.cs) são ignorados.

Predefinições para começar: TidySmith (sobrecargas e implementações de interface mantidas juntas), StyleCop (SA1201, SA1202, SA1204 — estritamente por acesso) e CodeMaid (o padrão do CodeMaid, para equipes que vêm dele).

Dicas no editor

Onde o TidySmith pode ajudar, o nome recebe três pontos cinza — do jeito que o Visual Studio marca as próprias sugestões. O ponteiro sobre eles diz o quê; Ctrl+. oferece a correção, com uma visualização da alteração.

Os pontos aparecem para uma classe fora de ordem, um comentário maior que o comprimento da linha e regiões que diferem das suas regras — nada mais. Os pontos e as ações da lâmpada têm chaves separadas; “Somente em arquivos que alterei” deixa o código antigo em paz.

Regiões pelas suas regras

Add Regions to This File… coloca linhas #region onde suas regras mandam, depois de uma visualização. Regiões são uma decisão da equipe, então o padrão é sem regiões: o comando abre as configurações até você escolher.

• Como dividir: uma região por grupo de membros (Fields, Methods…), por acesso (Public, Private…) ou ambos (Public methods).
• Seus nomes: cada grupo tem seu nome de região; grupos com o mesmo nome compartilham uma região, um grupo desativado fica fora das regiões. Implementações de interface podem ganhar uma região com o nome da interface (IDisposable).
• Sem ruído: menos membros que o mínimo (2 por padrão) não recebem região; uma região em volta de um único construtor não ajuda ninguém.
• Execute de novo quando quiser: as regiões dentro das classes são reconstruídas, não aninhadas. Os membros são ordenados primeiro, então cada grupo fica em um só bloco.
• À mão: Add Region Around Selection (o cursor espera o nome depois de #region), Remove Region at Caret, Remove Regions in This File — só as linhas #region e #endregion saem, o código fica.

A regra SA1124 do StyleCop proíbe regiões; é por isso que o padrão é sem regiões — e por isso arrumar ao salvar as remove com essa configuração.

Comentários que cabem

Format Comment quebra o comentário // ou /// no cursor (ou todos os comentários do arquivo) no seu comprimento de linha — max_line_length do .editorconfig, ou 120. Linhas longas são quebradas, curtas são unidas, um <summary> longo ganha linhas próprias. Exemplos de código (<code>), listas, linhas separadoras e código comentado ficam como estão.

Arrumar ao salvar

Quando um arquivo C# é salvo, o TidySmith pode ordenar seus membros, colocar regiões conforme as regras, quebrar comentários e remover espaços à direita e linhas em branco extras — cada etapa tem sua própria chave. Somente o arquivo que está sendo salvo, nunca arquivos gerados; a barra de status informa o que mudou, e Ctrl+Z desfaz. Tidy This File executa as mesmas etapas sob demanda.

Desativado por padrão. Ative quando Order Members der o resultado que sua equipe quer — senão o primeiro salvamento de um arquivo antigo reordena tudo.

Janela Structure

Exibir › Outras Janelas › TidySmith Structure: os tipos e membros do arquivo C# ativo. Ela acompanha o cursor, um clique leva ao membro, a pesquisa filtra, e um membro arrastado sobre outro se move para lá — o mesmo movimento seguro de Order Members. Os métodos mostram seu comprimento e complexidade ciclomática; além dos limites da página de opções, ficam laranja.

Pequenos utilitários

Os comandos de que as pessoas sentiam falta no CodeMaid, em Editar › TidySmith e no menu de contexto do editor.

Switch File

Abre o arquivo que pertence ao atual — a marcação e seu código, um arquivo de recursos e seu designer, o código e seus testes — sem procurá-lo no Gerenciador de Soluções.

O menu mostra o destino (“Switch to OrderServiceTests.cs”) e fica desativado quando não há para onde ir. Brilha com uma tecla só sua — veja abaixo.

Sort Selected Lines

Ordena usings, membros de enum ou os itens de uma lista; as vírgulas ficam onde a lista precisa delas. Só uma lista simples é ordenada — um item por linha, mesmo recuo, sem linhas em branco, sem instruções — então um método ou um arquivo inteiro selecionado por engano nunca é embaralhado; a barra de status diz por quê.

Join Lines

Une as linhas selecionadas em uma só, ou a linha do cursor com a seguinte.

Find This File in Solution Explorer

Seleciona no Gerenciador de Soluções o arquivo aberto no editor.

Collapse e Expand All Regions

Recolhe ou expande apenas os blocos #region; os métodos ficam como estão. Diferente de Ctrl+M, Ctrl+O (que recolhe também os métodos) e Ctrl+M, Ctrl+L (tudo).

Nenhum atalho é ocupado por padrão — as teclas do Visual Studio ficam como estão. Associe qualquer comando em Ferramentas › Opções › Ambiente › Teclado: digite TidySmith. em “Mostrar comandos contendo”.

Configurações

Ferramentas → Opções → SmithWorks → TidySmith. Cada opção tem uma descrição.

Opção	Padrão
Ações do TidySmith na lâmpada (Ctrl+.)	ativado
Pontos cinza onde algo pode ser arrumado	ativado
Ordem dos membros	predefinição TidySmith
Visualização antes de ordenar	ativado
Regiões	sem regiões
Comprimento da linha dos comentários	120
Arrumar ao salvar	desativado
Método longo (linhas) · método complexo	60 · 10
Pedir uma avaliação no Marketplace	ativado

As configurações são armazenadas em %LocalAppData%\TidySmith; o .editorconfig prevalece onde tem um valor.

Por repositório: .editorconfig

Coloque as regras junto do código, e toda a equipe terá o mesmo resultado; um valor no .editorconfig prevalece sobre a página de opções (a menos que “Usar a ordem do .editorconfig” esteja desativado).

[*.cs]
tidysmith_member_order = stylecop
tidysmith_regions = kind
tidysmith_region_min = 2
max_line_length = 120

Perguntas frequentes

Histórico de alterações

1.0.2

• Um pedido único de avaliação no Marketplace, depois que a extensão tiver sido útil — com Mais tarde e Não perguntar novamente, e uma opção para desativá-lo.

1.0.1

• Order Members e a janela Structure na barra de ferramentas SmithWorks, compartilhada com as outras extensões SmithWorks (Exibir › Barras de Ferramentas › SmithWorks).

1.0.0

• Primeira versão pública.