VANTOR ORM - VS Code Extension
Extensão oficial do VS Code para suporte à linguagem VANTOR ORM.
Recursos
- Syntax Highlighting: Destaque de sintaxe para arquivos
.schema e .vantor
- Snippets: Code snippets para acelerar o desenvolvimento
- Temas: Temas claro e escuro para melhor experiência visual
- Auto-completion: Suporte a autocomplete para schemas VANTOR
- Configurações: Opções personalizáveis no VS Code
Instalação
Via VS Code Marketplace
- Abra o VS Code
- Vá para Extensions (Ctrl+Shift+X / Cmd+Shift+X)
- Pesquise por "VANTOR ORM"
- Clique em Install
Via VSIX (Desenvolvimento)
# Instale o vsce se ainda não tiver
npm install -g @vscode/vsce
# Compile a extensão
cd vantor-vscode
vsce package
# Instale o arquivo .vsix gerado
code --install-extension vantor-*.vsix
Como Usar
Extensões de Arquivo
A extensão reconhece automaticamente arquivos com extensões:
Snippets Disponíveis
| Snippet |
Descrição |
model |
Cria um novo modelo |
field |
Adiciona um campo ao modelo |
relation |
Cria uma relação entre modelos |
enum |
Cria um enum |
Exemplo de Schema
model User {
id Int @id @default(autoincrement())
email String @unique
name String
posts Post[] @relation("UserPosts")
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User @relation("UserPosts", fields: [authorId], references: [id])
authorId Int
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
Configurações
Acesse File > Preferences > Settings e procure por "VANTOR":
| Configuração |
Tipo |
Padrão |
Descrição |
vantor.enableAutoComplete |
boolean |
true |
Habilita autocomplete |
vantor.defaultDriver |
string |
postgres |
Driver padrão |
vantor.formatOnSave |
boolean |
true |
Formatar ao salvar |
Temas
A extensão inclui dois temas:
- VANTOR Dark: Tema escuro
- VANTOR Light: Tema claro
Para ativar, vá em File > Preferences > Theme > Color Theme e selecione.
Publicação
Pré-requisitos
Passos para Publicar
Prepare a extensão:
cd vantor-vscode
Atualize o package.json:
- Verifique a versão em
"version"
- Atualize o
"publisher" com seu nome de publisher
Faça login:
vsce login <publisher-name>
Você precisará do seu token de acesso pessoal (PAT).
Publique:
vsce publish
Comandos do vsce
# Criar pacote .vsix
vsce package
# Publicar nova versão
vsce publish
# Publicar versão específica
vsce publish 1.0.0
# Listar extensões publicadas
vsce list
Obter Token de Acesso Pessoal (PAT)
- Acesse Azure DevOps
- Clique em seu perfil > Security
- New Token
- Defina:
- Organization: Marketplace (ou All accessible organizations)
- Scopes: Custom defined
- Marketplace: Manage
- Copie o token gerado
Desenvolvimento
Executar em Desenvolvimento
- Abra a pasta
vantor-vscode no VS Code
- Pressione F5 para iniciar o Debug Mode
- Uma nova janela do VS Code será aberta com a extensão instalada
Estrutura dos Arquivos
vantor-vscode/
├── package.json # Configuração da extensão
├── language-configuration.json # Configuração da linguagem
├── syntaxes/
│ └── vantor.tmLanguage.json # Grammar para syntax highlighting
├── snippets/
│ └── vantor.json # Code snippets
├── themes/
│ ├── vantor-dark.json # Tema escuro
│ └── vantor-light.json # Tema claro
└── README.md
Problemas?
Se encontrar problemas, por favor, abra uma issue em:
https://github.com/vantor/vscode-vantor/issues
Licença
MIT License - see LICENSE file for details.