fix: atualiza documentação de depuração com pacotes locais — substitui roteiro obsoleto de yarn link por instruções compatíveis com ESBuild (#118) - #131
Merged
leonelsanchesdasilva merged 2 commits intoJul 29, 2026
Conversation
…iro obsoleto de yarn link por instruções compatíveis com ESBuild (DesignLiquido#118)
leonelsanchesdasilva
merged commit Jul 29, 2026
8ae1238
into
DesignLiquido:principal
4 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolve #118
Descrição
Esta PR atualiza a documentação de contribuição, removendo instruções obsoletas para depuração com pacotes locais e substituindo-as por alternativas compatíveis com o pipeline atual baseado em ESBuild.
Além disso, foi atualizado o comentário correspondente no
tsconfig.json, direcionando contribuidores para a documentação revisada.Problema
O arquivo
CONTRIBUINDO.mdcontinha uma seção intitulada "Antiga forma de depuração usando pacotes linkados", destinada a explicar como depurar a extensão utilizandoyarn link.Entretanto, essa documentação apresentava diversos problemas:
yarn linkque não é compatível com o pipeline atual de build;Como consequência, a seção acabava gerando mais confusão do que auxílio.
Solução
A documentação foi reescrita para apresentar apenas alternativas compatíveis com a arquitetura atual da extensão.
CONTRIBUINDO.mdA antiga seção foi substituída por duas abordagens funcionais para depuração com pacotes locais.
Opção A —
npm pack(recomendada)Documenta o fluxo utilizando
npm pack, compatível com o ESBuild sem necessidade de configurações adicionais.Opção B —
yarn linkcom--externalDocumenta o uso de
yarn linkem conjunto com a configuração--externaldo ESBuild, permitindo a utilização de links simbólicos quando desejado.Além disso, a documentação passa a explicar de forma objetiva por que o uso isolado de
yarn linknão funciona com o pipeline atual, já que o ESBuild empacota as dependências durante o processo de build.tsconfig.jsonFoi atualizado o comentário relacionado à depuração com pacotes locais.
Antes, o comentário fazia referência direta ao procedimento de
yarn link.Agora, ele orienta o desenvolvedor a consultar a seção "Depuração com pacotes locais" presente no
CONTRIBUINDO.md, evitando duplicação de documentação e centralizando as instruções em um único local.Arquivos alterados
CONTRIBUINDO.mdtsconfig.jsonVerificação
Foram realizadas as seguintes verificações:
npx tsc --noEmitexecutado com sucesso, sem erros de compilação;CONTRIBUINDO.mdvalidada, mantendo links e formatação;tsconfig.jsonpermanece um arquivo JSONC válido e compatível com o TypeScript.Resultado
Com esta PR, a documentação de contribuição passa a refletir corretamente o fluxo atual de desenvolvimento da extensão, eliminando instruções obsoletas e fornecendo orientações compatíveis com o pipeline baseado em ESBuild.
Isso reduz a curva de aprendizado para novos contribuidores e evita problemas durante a configuração do ambiente de desenvolvimento.
Resolve #118