Skip to content

setup.md

Latest commit

 

History

History
153 lines (103 loc) · 7 KB

setup.md

File metadata and controls

153 lines (103 loc) · 7 KB
Raw

Setup — Guia de Instalação

Guia completo para instalar e configurar o ~/.vim_runtime em uma máquina nova.

Pré-requisitos

Dependência Obrigatório? macOS Linux (apt) Pra quê
Vim 9.1+ sim brew install vim apt install vim o editor
Node.js sim brew install node apt install nodejs npm CoC (LSP) não carrega sem ele
git sim brew install git apt install git submodules, fugitive, gv
ripgrep (rg) sim brew install ripgrep apt install ripgrep busca fzf/Ack
curl sim já vem por padrão apt install curl vim-ai-autocomplete chama as APIs Gemini/Claude via curl
psql / mysql opcional brew install postgresql / brew install mysql apt install postgresql-client / apt install mysql-client vim-dadbod (DB UI)

Provider Claude do ,pr: precisa de ANTHROPIC_API_KEY (~/.config/anthropic/vim-ai-autocomplete.env, ver docs/keybindings.md seção 26) — billing por API, separado da assinatura Claude Pro/Max. Chegamos a cogitar rotear via ant CLI (OAuth) achando que usaria o credito incluso da assinatura, mas confirmamos (2026-07-20) que ant messages create cobra do mesmo credito de API pago por token — sem vantagem nenhuma sobre a key estática pra esse uso, entao foi removido do plugin.

Instalação

# Recomendado (sem erros vermelhos no clone)
git clone https://github.com/albertosca/vim-runtime.git ~/.vim_runtime
bash ~/.vim_runtime/install.sh

# Alternativa com --recursive (submodules estão saudáveis)
git clone --recursive https://github.com/albertosca/vim-runtime.git ~/.vim_runtime
bash ~/.vim_runtime/install.sh

O install.sh faz tudo de forma automatizada e idempotente:

  • Inicializa os submodules um a um de forma resiliente (falhas individuais não abortam a instalação)
  • Cria o symlink ~/.vimrc → vimrc_example
  • Linka ~/.vim/coc-settings.json para o arquivo do repo
  • Faz backup automático de qualquer arquivo existente que seria sobrescrito

Primeiro run

Ao abrir vim pela primeira vez após a instalação, o CoC detecta a lista de extensões em g:coc_global_extensions e inicia o download e instalação automática de todas as 25 extensões. Esse processo leva ~1–2 minutos na primeira vez e exige Node.js instalado e acesso à internet.

Para acompanhar o progresso:

  • :CocList extensions — status de cada extensão (instalando, pronto, erro)
  • :messages — log detalhado com mensagens do CoC

As extensões instaladas automaticamente são:

coc-browser, coc-css, coc-docker, coc-elixir, coc-emmet, coc-eslint,
coc-git, coc-go, coc-html, coc-json, coc-markdown-preview-enhanced,
coc-markdownlint, coc-prettier, coc-pyright, coc-sh, coc-snippets,
coc-sql, coc-stylelint, coc-stylelintplus, coc-tailwindcss, coc-tsserver,
coc-webview, coc-xml, coc-yaml, coc-yank

Verificar que está funcionando

Sinal mais simples de tudo: abra vim (ou nvim) sem nenhum argumento — deve aparecer uma tela de boas-vindas com uma mini cheatsheet de atalhos (conteúdo adaptado por editor). Se aparecer, o configs.vim carregou corretamente.

Depois, rode estes checks:

  • :CocInfo — mostra a versão do CoC, o Node detectado e qualquer problema de configuração
  • :checkhealth — diagnóstico geral do Vim e dos plugins carregados

Para confirmar que o LSP está ativo:

  1. Abra um arquivo .ex, .ts ou .py
  2. Posicione o cursor sobre um símbolo e pressione K — deve aparecer o hover doc
  3. Pressione gd sobre um símbolo — deve navegar para a definição

Se K e gd respondem, o CoC está funcionando corretamente.

LSP por linguagem

Linguagem Extensão CoC Já auto-instala? Servidor externo a instalar
Elixir coc-elixir sim ElixirLS — baixar release em https://github.com/elixir-lsp/elixir-ls/releases e colocar em ~/.elixir-ls/release/language_server.sh
JS/TS/React coc-tsserver sim nenhum (tsserver vem na extensão)
Python coc-pyright sim nenhum (pyright vem na extensão)
Go coc-go sim gopls (a extensão instala automaticamente; precisa do toolchain Go)
Ruby/Rails — não :CocInstall coc-solargraph + gem install solargraph
Rust — não :CocInstall coc-rust-analyzer + rustup component add rust-analyzer

Nota: Ruby (coc-solargraph) e Rust (coc-rust-analyzer) não estão na lista de extensões auto-instaladas. Para usá-los, rode o :CocInstall acima após a instalação.

Troubleshooting

CoC não inicia / "Coc requires Node" Node ausente ou versão menor que 16. Rode node --version para verificar. Instale ou atualize via brew install node (macOS) ou apt install nodejs (Linux) e reabra o Vim.

Extensão CoC não instala Sem internet na primeira abertura, ou processo do Node travado. Verifique o estado com :CocList extensions; reinicie o CoC com :CocCommand workspace.restart; confira o log em :messages.

fzf sem binário / :Files não abre O binário do fzf não foi compilado. Rode:

~/.vim_runtime/plugins/fzf/install --bin

Plugin ausente após clone Submodule não foi inicializado. Rode:

git -C ~/.vim_runtime submodule update --init plugins/NOME

Substitua NOME pelo nome do diretório do plugin faltante.

Ícones quadrados ou faltando (vim-devicons) Falta uma Nerd Font no terminal. Instale uma (ex: "FiraCode Nerd Font" em https://www.nerdfonts.com) e selecione-a nas configurações do seu emulador de terminal. Depois reabra o Vim.

Ruby/Rust sem autocomplete Esses LSPs não vêm por padrão — ver tabela "LSP por linguagem" acima para o procedimento de instalação manual.

Neovim (opcional, dual-boot)

Este mesmo repo funciona também no Neovim — nenhum arquivo é duplicado, nvim/init.vim (dentro do próprio ~/.vim_runtime, symlinkado em ~/.config/nvim pelo install.sh) reaproveita configs.vim/vimrcs/*.vim inteiros. Arquitetura completa, inventário de plugins e bugs já resolvidos em neovim.md.

Instalação:

brew install neovim tree-sitter-cli go ruby
  • tree-sitter-cli: compila os parsers do treesitter — não vem junto do brew install neovim.
  • go: precisa pro gopls/sqls/debugger de Go.
  • ruby: é keg-only (não sobrescreve o Ruby do sistema) — precisa adicionar ao PATH manualmente, ver neovim.md.

Primeiro run: abrir nvim dispara o bootstrap do lazy.nvim (clona os plugins) e do mason.nvim (baixa os LSP servers/DAP adapters/formatters). Leva alguns minutos na primeira vez, precisa de internet.

Verificar que está funcionando: :checkhealth (diagnóstico geral) e :Mason (status de cada servidor/ferramenta).

Ver também

  • keybindings.md — cheatsheet completo de atalhos (Vim e Neovim)
  • neovim.md — arquitetura, inventário de plugins e bugs resolvidos do lado Neovim
  • updating-plugins.md — como atualizar plugins com segurança