VS Code Extension
Guias
Extensão do VS Code
Escaneie seu workspace de dentro do VS Code. Os achados aparecem no editor, no painel Problems e na barra lateral da Scanverra, e seu código nunca sai da sua máquina.
Instalação
A extensão está publicada no Visual Studio Marketplace com o nome Scanverra.
- Abra a visualização de Extensões (Ctrl+Shift+X, ou Cmd+Shift+X no macOS).
- Procure Scanverra e clique em Instalar.
- Um ícone de escudo aparece na barra de atividades. Essa é a visualização Scanverra.
Ou cole isto no Quick Open (Ctrl+P, ou Cmd+P no macOS)
ext install scanverra.scanverra-vscode
Login
Os escaneamentos precisam de uma chave de API da Scanverra. Crie uma no seu painel, em API Keys.
- Abra a visualização Scanverra. Se você não estiver logado, ela mostra um cartão de login.
- Cole sua chave de API e clique em Save API key. A chave é verificada com a Scanverra antes de ser salva.
- Você também pode executar Scanverra: Log In with API Key pela paleta de comandos.
A extensão e a CLI da Scanverra usam o mesmo login salvo. Se você já executou scanverra login, a extensão também está logada, e fazer login pelo VS Code também faz login na CLI.
Clique em Log out na visualização Scanverra ou execute Scanverra: Log Out. Isso remove a chave salva da extensão e da CLI nesta máquina.
Escaneie seu workspace
- Abra uma pasta no VS Code.
- Clique em Scan Workspace na visualização Scanverra, no escudo da barra de status, ou execute Scanverra: Scan Workspace.
- Os achados aparecem sublinhados no editor e no painel Problems, e agrupados por arquivo na barra lateral.
- Use os filtros de severidade e a busca para reduzir a lista, depois clique em View para ir até um achado ou em Fix para ler a correção sugerida.
- Clique em Clear para limpar os resultados.
Como funciona
Diagnósticos no código
Cada achado aparece na sua linha do editor e é listado no painel Problems.
Barra lateral de triagem
Pontuação, quality gate, filtros de severidade, achados por arquivo e vulnerabilidades de dependências em uma aba separada.
Escaneia localmente
O mesmo motor da CLI. Os arquivos são lidos e verificados na sua própria máquina.
Lembra o último escaneamento
Os resultados ficam salvos por workspace, então continuam lá depois de reiniciar o VS Code.
Comandos
Todos os comandos estão disponíveis na paleta de comandos (Ctrl+Shift+P, ou Cmd+Shift+P no macOS).
| Comando | Descrição |
|---|---|
Scanverra: Scan Workspace | Escaneia a pasta aberta e mostra os resultados |
Scanverra: Clear Scan Results | Remove os achados do editor e da barra lateral |
Scanverra: Open Full View | Abre os resultados em uma aba completa do editor |
Scanverra: Log In with API Key | Cola e verifica uma chave de API |
Scanverra: Get an API Key | Abre a página de API Keys no navegador |
Scanverra: Log Out | Remove a chave de API salva |
O que sai da sua máquina
A extensão baixa as regras assinadas do scanner na Scanverra, verifica essas regras e roda cada verificação na sua máquina. Ela nunca envia seus arquivos, as linhas de código encontradas nem um relatório. Só a chave de API é enviada, para verificar sua conta e seu plano.
Limitações atuais
- Os escaneamentos rodam quando você pede. Ainda não há escaneamento ao salvar.
- Os achados são destacados na linha inteira, não em uma coluna específica.
- Em um workspace com várias raízes, só a primeira pasta é escaneada.
Solução de problemas
| Mensagem | O que fazer |
|---|---|
Log in to Scanverra | Cole uma chave de API na visualização Scanverra ou execute Scanverra: Log In with API Key |
That API key was rejected | A chave está errada ou foi revogada. Crie uma nova em API Keys |
Your saved API key was rejected | A chave salva não funciona mais. Cole uma nova no cartão de login |
Requires a Pro, Team or Enterprise plan | Faça upgrade do seu plano e escaneie de novo |
Open a folder to scan | Abra uma pasta em Arquivo > Abrir Pasta e depois escaneie |
No scannable files found | Verifique a pasta e seu .gitignore ou .scanverraignore |
Pronto para escanear pelo editor?
Crie uma chave de API, instale a extensão e rode seu primeiro escaneamento.