cleanEditor
Extensão do VS Code que esconde a linha do comentário JSDoc acima de propriedades
(membros de enum, campos de interface/classe, propriedades de objeto) e mostra o texto
do comentário em cinza, pequeno, no fim da linha da propriedade — no estilo do blame do GitLens.
// no arquivo
export enum EventEvidenceState {
NO_EVIDENCE_OR_HAS_COMPLETE_EVIDENCE = 4,
/** Original evidence complete, additional videos still arriving */
HAS_ADDITIONAL_EVIDENCE_LOADING = 5
}
// no editor
export enum EventEvidenceState {
NO_EVIDENCE_OR_HAS_COMPLETE_EVIDENCE = 4, ⋯
HAS_ADDITIONAL_EVIDENCE_LOADING = 5 Original evidence complete, additional videos still arriving
}
O arquivo não é alterado e o IntelliSense continua mostrando o JSDoc no hover.
Como funciona
- Esconder a linha: a API do VS Code não permite remover linhas, então o comentário é dobrado
com um folding range manual que começa na linha de cima (a mesma coisa que
"Create Folding Range from Selection"). Por isso aparece o
⋯ no fim da linha anterior.
- Texto à direita: uma decoration no fim da linha da propriedade. Ela só aparece enquanto o
comentário está escondido; se ele for expandido, o texto à direita some.
- Colocar o cursor dentro do comentário (ou clicar no
⋯) expande a dobra, como qualquer fold.
Limitações
- O comentário do primeiro membro de um bloco (logo depois da linha com
{) não é escondido:
essa linha já é o início da dobra do bloco inteiro e o VS Code não permite duas dobras começando na mesma linha.
- Só comentários
/** ... */ imediatamente acima da propriedade (sem linha em branco no meio).
Comentários // e JSDoc de funções, métodos, classes e tipos não são tocados.
- Show Property Comments remove as dobras manuais que começam nessas linhas, inclusive alguma que você tenha criado à mão ali.
Comandos
| Comando |
O que faz |
cleanEditor: Toggle |
Liga/desliga a extensão (cleanEditor.enabled) |
cleanEditor: Hide Property Comments |
Esconde os comentários do arquivo atual |
cleanEditor: Show Property Comments |
Mostra de volta os comentários do arquivo atual |
Configurações
| Configuração |
Padrão |
Descrição |
cleanEditor.enabled |
true |
Liga/desliga |
cleanEditor.languages |
ts, tsx, js, jsx |
Linguagens onde funciona |
cleanEditor.foldOnOpen |
true |
Esconde os comentários sempre que um arquivo é aberto ou a aba dele fica ativa (menos o comentário onde está o cursor) |
cleanEditor.foldOnSave |
true |
Esconde de novo ao salvar (menos o comentário onde está o cursor) |
cleanEditor.maxLength |
120 |
Tamanho máximo do texto à direita |
cleanEditor.fontSize |
0.85em |
Tamanho da fonte do texto à direita |
cleanEditor.fontStyle |
italic |
normal ou italic |
A cor é a cleanEditor.commentForeground, que pode ser trocada em workbench.colorCustomizations.
Desenvolvimento
.claude/scripts/npm-run.sh cleanEditor run build # compila para out/
.claude/scripts/npm-run.sh cleanEditor test # testes do scanner (node:test)
.claude/scripts/npm-run.sh cleanEditor run package # gera clean-editor.vsix
code --install-extension cleanEditor/clean-editor.vsix
Para depurar, abra a pasta cleanEditor no VS Code e use F5 (Run cleanEditor).
Licença
MIT © André Felipe Silveira Avelar (AngrySoft) — pode baixar, usar, modificar e redistribuir à vontade. Texto completo no arquivo LICENSE.
