CatSuite Studio para VS Code

O CatSuite Studio é a extensão oficial do CatSuite para o Visual Studio Code. Com ela você escreve plugins JavaScript, comandos e fluxos para o aplicativo CatSuite sem sair do editor: sugestões do SDK ao digitar cat., modelos prontos, validação do projeto, prévia local com fixtures e geração de pacotes .catplug assinados. Esta página explica como instalar, configurar e usar cada recurso da extensão.

O que é o CatSuite Studio e para que serve #

O CatSuite Studio é uma bancada de desenvolvimento para as extensões do CatSuite. Ele reúne, no VS Code, o ciclo completo de um plugin: escrever o código com ajuda do SDK, conferir manifesto e permissões, observar o comportamento em uma prévia isolada e gerar o pacote assinado que você importa no aplicativo.

É a alternativa instalável à IDE web de extensões. As duas falam o mesmo contrato da API v1 e produzem pacotes .catplug; a escolha depende de onde você prefere trabalhar.

Instalação #

Pelo Marketplace #

1. Abra a página do CatSuite Studio no Visual Studio Marketplace.
2. Clique em Install e permita que o navegador abra o VS Code.
3. Confirme a instalação no editor.

Pela visão Extensões do VS Code #

1. Abra a visão Extensões na barra lateral do VS Code.
2. Busque por CatSuite Studio.
3. Confira se o publicador é a NetCatTest e clique em Instalar.

Pela linha de comando #

code --install-extension NetCatTest.catsuite-studio

Requisitos #

• Visual Studio Code 1.100.0 ou superior.
• Um workspace confiável: criar projetos, executar a prévia, assinar e exportar exigem que a pasta aberta esteja marcada como confiável no VS Code.
• Um aplicativo CatSuite compatível com extensões para instalar e executar os pacotes exportados.

Primeiros passos #

1. Abra uma pasta no Visual Studio Code.
2. Abra a paleta de comandos e execute CatSuite: Criar extensão.
3. Escolha um modelo e abra o script JavaScript de entrada.
4. Digite cat. para explorar o SDK e depois execute CatSuite: Validar projeto.
5. Execute CatSuite: Testar com fixture local para conferir a prévia.
6. Com o projeto pronto, execute CatSuite: Gerar .catplug assinado e importe o pacote em uma versão do CatSuite que suporte extensões.

Para um script rápido, sem projeto, execute CatSuite: Novo script CatPlug, ou crie um arquivo .catjs ou um .catplug textual vazio e digite catplug.

A interface do CatSuite Studio #

Depois da instalação, um ícone do CatSuite aparece na barra de atividades do VS Code. Ele abre duas visões:

• Projetos — os projetos CatSuite do workspace aberto.
• Recursos do SDK — os recursos do SDK disponíveis para inserir no código.

O comando CatSuite: Ateliê CatSuite abre o painel principal da extensão, o ponto de partida para criar, validar, testar e empacotar.

Escrever com o SDK #

• Sugestões ao digitar cat.. O editor lista as APIs do SDK com ajuda contextual, a partir dos tipos catsuite.d.ts. Por padrão as sugestões aparecem em qualquer linguagem; você pode limitá-las a projetos CatSuite nas configurações.
• Modelo catplug. Digite catplug para inserir um modelo de script pronto.
• Inserir recurso do SDK. O comando CatSuite: Inserir recurso do SDK adiciona trechos dos recursos do SDK no ponto do cursor.
• Arquivos textuais. Os arquivos .catplug e .catjs textuais têm edição JavaScript, realce de sintaxe, trechos e diagnósticos. Pacotes compilados abrem em um inspetor separado.

Consulte o contrato completo na Referência da API JavaScript.

Criar projetos e fluxos #

O comando CatSuite: Criar extensão abre um assistente com modelos para:

• painéis e comandos;
• análise de tráfego;
• alteração de headers;
• etapas de fluxo;
• parsers.

O comando CatSuite: Criar fluxo de exemplo gera um arquivo .catflow de exemplo para os fluxos visuais.

Validar o projeto #

O CatSuite Studio confere o projeto enquanto você trabalha:

• manifesto — identidade, script de entrada, permissões, destinos e hashes (veja Manifesto do pacote .catplug);
• permissões e uso do SDK — se o código usa capacidades que o manifesto declara;
• hashes dos arquivos — se os hashes do manifesto batem com os arquivos;
• conexões do fluxo — se as etapas de um .catflow estão ligadas corretamente.

Com a opção validação contínua ligada (padrão), os problemas aparecem no editor enquanto você digita. Para rodar a verificação completa, use CatSuite: Validar projeto. Depois de alterar arquivos, CatSuite: Atualizar hashes do manifesto recalcula os hashes.

Os arquivos manifest.json, catsuite.projeto.json, .catflow e .catdata também recebem validação por esquema JSON, com sugestões de campos.

Prévia local com fixtures #

O comando CatSuite: Testar com fixture local executa o script em uma prévia QuickJS isolada, com fixtures locais e APIs do host simuladas. Na prévia você inspeciona:

• as abas registradas;
• os achados gerados;
• as alterações em requests;
• os artefatos emitidos.

Empacotar e assinar #

O comando CatSuite: Gerar .catplug assinado cria o pacote final do plugin com a sua identidade de assinatura. O script de origem passa pelo empacotamento do projeto antes de ir para o aplicativo, e o CatSuite instalado precisa suportar o formato do pacote e a versão do SDK pedida pelo plugin.

A identidade de assinatura é gerenciada por três comandos:

Inspecionar pacotes e reconhecer autores #

O comando CatSuite: Inspecionar arquivo CatSuite abre pacotes compilados e mostra a integridade do pacote e a impressão digital do autor. A inspeção distingue duas coisas:

• assinatura válida — o pacote não foi alterado depois de assinado;
• autor reconhecido — você já confirmou que aquela impressão digital pertence a um autor confiável.

Use CatSuite: Reconhecer autor deste pacote depois de conferir a impressão digital com o autor por um canal confiável, e CatSuite: Remover autor reconhecido para desfazer. O inspetor também abre pacotes protegidos por senha.

Para editar um plugin existente sem mexer no original, use CatSuite: Criar cópia editável do pacote: a extensão transforma o pacote em uma cópia de projeto e preserva o pacote original e as informações de origem.

Arquivos que o CatSuite Studio entende #

Todos os comandos #

Abra a paleta de comandos (Ctrl+Shift+P no Windows e no Linux, Cmd+Shift+P no macOS) e digite CatSuite para ver a lista.

Configurações #

Abra CatSuite: Abrir opções do CatSuite Studio ou procure por catsuite nas configurações do VS Code.

{
  "catsuite.idioma": "pt-BR",
  "catsuite.validacaoContinua": true,
  "catsuite.estiloPainel": "catsuite",
  "catsuite.autor": "Equipe do Laboratório",
  "catsuite.sugestoesGlobais": false
}

Temas, ícones e idioma #

O CatSuite Studio traz dois temas de cores e um tema de ícones:

• CatSuite Cyber — o visual preto e amarelo do aplicativo;
• CatSuite Conforto — uma alternativa de cores para quem prefere menos contraste;
• ícones CatSuite — ícones dedicados para os arquivos do ecossistema.

Use CatSuite: Aplicar estilo CatSuite e CatSuite: Aplicar ícones CatSuite para ativá-los, e CatSuite: Restaurar estilo anterior para voltar ao seu tema. Os painéis funcionam em português do Brasil e inglês: escolha em CatSuite: Escolher idioma ou deixe seguir o idioma do editor.

CatSuite Studio ou IDE web? #

Problemas comuns #

As sugestões de cat. não aparecem. Confira se a opção catsuite.sugestoesGlobais está ligada ou se o arquivo está dentro de um projeto CatSuite.

Não consigo criar o projeto, testar ou assinar. Essas ações exigem um workspace confiável. Marque a pasta como confiável no VS Code e tente de novo.

O aplicativo recusou o pacote. Verifique se a sua versão do CatSuite suporta extensões e a versão do SDK pedida pelo plugin, rode CatSuite: Validar projeto e gere o pacote de novo.

A validação acusa hashes diferentes. Execute CatSuite: Atualizar hashes do manifesto depois de alterar os arquivos do projeto.

Troquei de computador e perdi a identidade. Restaure com CatSuite: Restaurar identidade de backup, usando o backup protegido exportado antes.

Continue #

• IDE web de extensões
• Referência da API JavaScript
• Manifesto do pacote .catplug
• Downloads e SDK