Extensão para VS Code
Inicie, pare e reinicie o servidor de desenvolvimento Jamdesk na barra de status do Visual Studio Code com controles de um clique e pré-visualização automática no navegador.
Visualize sua documentação sem sair do Visual Studio Code. A extensão Jamdesk adiciona um botão na barra de status que inicia o jamdesk dev. Ela monitora o servidor e abre o navegador quando o servidor estiver pronto.
Pré-requisitos
- CLI do Jamdesk instalada (
npm install -g jamdesk) - Um workspace contendo um arquivo
docs.json
Instalar a extensão
Pesquise por Jamdesk no painel de Extensões do VS Code (Cmd+Shift+X no macOS, Ctrl+Shift+X no Windows/Linux) e clique em Install. Ou instale pelo VS Code Marketplace.
A extensão é ativada em um workspace que contenha um arquivo docs.json. Um botão de play aparece na barra de status.
Iniciar o servidor de desenvolvimento
Clique no botão de play na barra de status. A extensão:
- Inicia o
jamdesk devcomo um processo filho - Monitora a saída para detectar quando o servidor está pronto
- Abre seu navegador na pré-visualização local (se a abertura automática estiver habilitada)
A barra de status mostra o estado atual do servidor: iniciando, em execução ou parado.
Comandos
Abra a Paleta de Comandos (Cmd+Shift+P / Ctrl+Shift+P) e digite "Jamdesk":
| Comando | Descrição |
|---|---|
| Jamdesk: Start Dev Server | Iniciar o servidor de desenvolvimento |
| Jamdesk: Stop Dev Server | Parar o servidor em execução |
| Jamdesk: Restart Dev Server | Reiniciar o servidor |
| Jamdesk: Show Output | Exibir o canal de saída da CLI |
Configurações
Configure a extensão nas configurações do VS Code (Cmd+, / Ctrl+,) em Jamdesk:
| Configuração | Padrão | Descrição |
|---|---|---|
jamdesk.port | 3000 | Porta preferida do servidor de desenvolvimento |
jamdesk.verbose | false | Habilitar saída detalhada da CLI |
jamdesk.clean | false | Limpar o cache de build na próxima inicialização |
jamdesk.browserMode | external | Onde abrir a pré-visualização: external (navegador do sistema) ou embedded (painel lateral do VS Code) |
jamdesk.autoOpenBrowser | true | Abrir o navegador quando o servidor estiver pronto |
Defina browserMode como embedded para abrir a pré-visualização da documentação em um painel lateral do VS Code. Edite e visualize lado a lado.
Gerenciamento inteligente de portas
A CLI passa para a próxima porta livre quando a porta preferida já está em uso. A extensão lê a porta a partir da saída da CLI. O navegador abre na URL correta.
Canal de saída
A extensão envia a saída da CLI para um canal de saída Jamdesk. Abra-o com o comando Jamdesk: Show Output ou pelo menu suspenso do painel Output.
Use-o para:
- Acompanhar o progresso do build
- Depurar problemas do servidor
- Visualizar logs detalhados (quando
jamdesk.verboseestiver habilitado)
