Skip to content

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 into
DesignLiquido:principalfrom
kunaaaalcodes:fix-118-yarn-link-docs
Jul 29, 2026

Conversation

@kunaaaalcodes

Copy link
Copy Markdown
Contributor

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.md continha uma seção intitulada "Antiga forma de depuração usando pacotes linkados", destinada a explicar como depurar a extensão utilizando yarn link.

Entretanto, essa documentação apresentava diversos problemas:

  • iniciava informando que o procedimento não funcionava corretamente com o ESBuild;
  • era mantida apenas por motivos históricos;
  • descrevia detalhadamente um fluxo baseado em yarn link que não é compatível com o pipeline atual de build;
  • induzia novos contribuidores a seguir um processo que resultava em erros durante a configuração do ambiente de desenvolvimento.

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.md

A 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 link com --external

Documenta o uso de yarn link em conjunto com a configuração --external do 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 link não funciona com o pipeline atual, já que o ESBuild empacota as dependências durante o processo de build.


tsconfig.json

Foi 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

Arquivo Descrição
CONTRIBUINDO.md Reescreve a seção de depuração com pacotes locais utilizando procedimentos compatíveis com o ESBuild
tsconfig.json Atualiza o comentário para referenciar a documentação revisada

Verificação

Foram realizadas as seguintes verificações:

  • npx tsc --noEmit executado com sucesso, sem erros de compilação;
  • estrutura Markdown do CONTRIBUINDO.md validada, mantendo links e formatação;
  • tsconfig.json permanece 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

…iro obsoleto de yarn link por instruções compatíveis com ESBuild (DesignLiquido#118)

@leonelsanchesdasilva leonelsanchesdasilva left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obrigado!

@leonelsanchesdasilva
leonelsanchesdasilva merged commit 8ae1238 into DesignLiquido:principal Jul 29, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentação de contribuição descreve roteiro de yarn link desatualizado

2 participants