Skip to content

feat(#116): adiciona walkthrough interativo "Criando uma aplicação web em Líquido" - #133

Open
kunaaaalcodes wants to merge 1 commit into
DesignLiquido:principalfrom
kunaaaalcodes:fix-116-walkthrough-liquido
Open

feat(#116): adiciona walkthrough interativo "Criando uma aplicação web em Líquido"#133
kunaaaalcodes wants to merge 1 commit into
DesignLiquido:principalfrom
kunaaaalcodes:fix-116-walkthrough-liquido

Conversation

@kunaaaalcodes

Copy link
Copy Markdown

Resolve #116

Descrição

Esta PR adiciona um walkthrough interativo para o framework Líquido na tela de boas-vindas do VS Code, oferecendo uma experiência guiada para novos usuários semelhante ao walkthrough já existente para Pituguês.

O novo walkthrough conduz o usuário desde a criação de um projeto até a execução de uma aplicação web funcional, utilizando recursos já disponíveis na extensão.


Problema

Embora a extensão já oferecesse suporte ao framework Líquido, novos usuários não possuíam um fluxo guiado de aprendizado equivalente ao existente para Pituguês.

Como consequência:

  • o processo inicial de criação de uma aplicação dependia da documentação externa;
  • recursos como snippets, autocompletar, hover e comandos da extensão não eram facilmente descobertos;
  • a experiência de onboarding era inconsistente entre as linguagens suportadas.

Solução

Foi adicionado um novo walkthrough registrado em package.json através de contributes.walkthroughs.

O walkthrough possui o identificador:

liquido

e o título:

Criando uma aplicação web em Líquido

O fluxo é composto por seis etapas que conduzem o usuário desde a criação do projeto até a exploração dos recursos disponíveis na extensão.


Etapas do walkthrough

Passo Descrição
1 Criar um projeto Líquido
2 Configurar o arquivo .delprops
3 Criar uma rota
4 Criar visões utilizando LMHT e FolEs
5 Iniciar o servidor de desenvolvimento
6 Continuar explorando os recursos da extensão

Arquivos criados

Arquivo Descrição
recursos/passos-a-passos/liquido/liquido-passo-01.md Criação de projeto
recursos/passos-a-passos/liquido/liquido-passo-02.md Configuração do arquivo .delprops
recursos/passos-a-passos/liquido/liquido-passo-03.md Criação de rotas
recursos/passos-a-passos/liquido/liquido-passo-04.md Desenvolvimento de visões com LMHT e FolEs
recursos/passos-a-passos/liquido/liquido-passo-05.md Inicialização do servidor de desenvolvimento

Arquivos alterados

Arquivo Descrição
package.json Registro do novo walkthrough em contributes.walkthroughs

Decisões de implementação

Durante o desenvolvimento foram adotadas as seguintes decisões:

  • utilização de Markdown nos cinco primeiros passos, reduzindo o custo de manutenção e evitando dependência de capturas de tela;
  • reutilização da imagem explorar-img.png, já utilizada pelo walkthrough de Pituguês, para o passo final;
  • inclusão de botões de comando nos passos de criação do projeto e inicialização do servidor, permitindo executar as ações diretamente pelo walkthrough;
  • aproveitamento dos recursos já existentes da extensão, como:
    • snippets;
    • autocompletar;
    • documentação contextual (hover);
    • destaque de sintaxe para arquivos .delegua, .lmht, .foles e .delprops.

Verificação

Foram realizadas as seguintes verificações:

npx tsc --noEmit

Resultado:

0 erros

Também foi executado:

npx jest

Resultado:

1059 testes executados com sucesso

Resultado

Com esta PR, a extensão passa a oferecer um walkthrough completo para o framework Líquido, proporcionando uma experiência de onboarding integrada ao VS Code e facilitando a descoberta dos principais recursos disponíveis para o desenvolvimento de aplicações web.


**Resolve #116 **

- Registra novo walkthrough 'Criando uma aplicação web em Líquido'
  em package.json (contributes.walkthroughs), ao lado do existente
  walkthrough de Pituguês
- 6 steps: criar projeto (liquido.novo), configurar .delprops,
  criar rota (liquido.rota*), criar visões (LMHT + FolEs),
  iniciar servidor (liquido.servidor), continuar explorando
- Usa markdown em vez de imagens para os 5 primeiros steps
  (mais leve, fácil de manter, sem screenshots)
- Reusa explorar-img.png do Pituguês no último step
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.

Walkthrough de boas-vindas cobre só Pituguês, falta trilha de app web em Liquido

1 participant