serpl

Serpl

serpl é um aplicativo de interface de usuário de terminal (TUI) que permite aos usuários pesquisar e substituir palavras-chave em uma pasta inteira, semelhante à funcionalidade disponível no VS Code.

serpl-demo.mp4

Índice

1. Características
2. Instalação
   • Pré-requisitos
   • Passos
   • Binários
   • Instalação específica do sistema operacional
3. Uso
   • Comandos Básicos
   • Associações de teclas
   • Configuração
4. Painéis
   • Entrada de pesquisa
   • Substituir entrada
   • Painel de resultados de pesquisa
   • Painel de visualização
5. Dicas rápidas
6. Integração Neovim usando toggleterm
7. Licença
8. Contribuindo
9. Agradecimentos
10. Projetos semelhantes

Características

• Pesquise palavras-chave em toda a pasta do projeto, com opções de distinção entre maiúsculas e minúsculas, AST Grep e muito mais.
• Substitua palavras-chave por opções para preservar maiúsculas e minúsculas, AST Grep e muito mais.
• Visualização interativa dos resultados da pesquisa.
• Navegação pelo teclado para um fluxo de trabalho eficiente.
• Atalhos de teclas e modos de pesquisa configuráveis.

Instalação e atualização

Pré-requisitos

• ripgrep instalado em seu sistema.
• (Opcional) ast-grep instalado em seu sistema, se você quiser usar a funcionalidade AST Grep.

Passos

1. Instale o aplicativo usando Cargo:

cargo install serpl

• Se desejar instalar o aplicativo com a funcionalidade AST Grep, você pode usar o seguinte comando:

  cargo install serpl --features ast_grep

2. Execute o aplicativo:

serpl

Binários

Verifique a página de lançamentos para os binários mais recentes.

Instalação específica do sistema operacional

Preparar

serpl pode ser instalado usando Homebrew:

brew install serpl

Arco Linux

serpl pode ser instalado a partir dos repositórios oficiais usando pacman :

pacman -S serpl

Nix/NixOS

serpl está incluído no nixpkgs desde 24.11 e pode ser instalado via Nix de diferentes maneiras:

Em configurações autônomas do Nix :

nix profile install nixpkgs#serpl

No NixOS (via configuration.nix ou similar):

 { pkgs , ... } : {
  environment . systemPackages = [ pkgs . serpl ] ;
}

No Home-Manager :

 { pkgs , ... } : {
  home . packages = [ pkgs . serpl ] ;
} 

Uso

Comandos Básicos

• Inicie o aplicativo no diretório atual:

  serpl

• Inicie o aplicativo e forneça o caminho raiz do projeto:

  serpl --project-root /path/to/project

Associações de teclas

As combinações de teclas padrão podem ser personalizadas por meio do arquivo config.json .

Associações de teclas padrão

Combinação de teclas	Ação
Ctrl + c	Desistir
Ctrl + b	Ajuda
Tab	Alternar entre guias
Backtab	Alternar para guias anteriores
Ctrl + o	Substituição de processo para todos os arquivos
r	Substituição de processo para arquivo ou linha selecionada
Ctrl + n	Alternar modos de pesquisa e substituição
Enter	Executar pesquisa (para pastas grandes)
g / Left / h	Ir para o topo da lista
G / Right / l	Ir para o final da lista
j / Down	Passar para o próximo item
k / Up	Mover para o item anterior
/	Lista de resultados de pesquisa
d	Excluir arquivo ou linha selecionada
Esc	Sair do painel ou caixa de diálogo atual
Enter (nas caixas de diálogo) / y	Confirmar ação
Esc (em caixas de diálogo) / n	Cancelar ação
h , l , Tab (em caixas de diálogo)	Navegar pelas opções de diálogo

Configuração

serpl usa um arquivo de configuração para gerenciar combinações de teclas e outras configurações. Por padrão, o caminho para o arquivo de configuração pode ser encontrado executando serpl --version . Você pode usar vários formatos de arquivo para a configuração, como JSON, JSON5, YAML, TOML ou INI.

Exemplos de configurações

JSON

{
  "keybindings" : {
    "<Ctrl-d>" : " Quit " ,
    "<Ctrl-c>" : " Quit " ,
    "<Tab>" : " LoopOverTabs " ,
    "<Backtab>" : " BackLoopOverTabs " ,
    "<Ctrl-o>" : " ProcessReplace " ,
    "<Ctrl-b>" : " ShowHelp "
  }
}

JSON5

 {
  keybindings : {
    "<Ctrl-d>" : "Quit" ,
    "<Ctrl-c>" : "Quit" ,
    "<Tab>" : "LoopOverTabs" ,
    "<Backtab>" : "BackLoopOverTabs" ,
    "<Ctrl-o>" : "ProcessReplace" ,
    "<Ctrl-b>" : "ShowHelp" ,
  } ,
}

YAML

 keybindings :
  " <Ctrl-d> " : " Quit "
  " <Ctrl-c> " : " Quit "
  " <Tab> " : " LoopOverTabs "
  " <Backtab> " : " BackLoopOverTabs "
  " <Ctrl-o> " : " ProcessReplace "
  " <Ctrl-b> " : " ShowHelp "

TOML

[ keybindings ]
"<Ctrl-d>" = " Quit "
"<Ctrl-c>" = " Quit "
"<Tab>" = " LoopOverTabs "
"<Backtab>" = " BackLoopOverTabs "
"<Ctrl-o>" = " ProcessReplace "
"<Ctrl-b>" = " ShowHelp "

INI

 [keybindings]
<Ctrl-d> = Quit
<Ctrl-c> = Quit
<Tab> = LoopOverTabs
<Backtab> = BackLoopOverTabs
<Ctrl-o> = ProcessReplace
<Ctrl-b> = ShowHelp

Você pode personalizar as combinações de teclas modificando o arquivo de configuração no formato de sua preferência.

Painéis

Entrada de pesquisa

• Campo de entrada para inserir palavras-chave de pesquisa.
• Alternar modos de pesquisa (Simples, Match Case, Match Whole Word, Match Whole Word, Regex, AST Grep).
  • Simples: pesquise todas as ocorrências da palavra-chave.
  • Match Case: pesquise ocorrências com o mesmo caso da palavra-chave.
  • Corresponder palavra inteira: pesquise ocorrências que correspondam exatamente à palavra-chave.
  • Corresponder palavra inteira de maiúsculas e minúsculas: pesquise ocorrências que correspondam à palavra-chave exatamente com o mesmo caso.
  • Regex: pesquise ocorrências usando uma expressão regular.
  • AST Grep: pesquise ocorrências usando AST Grep.

Dica

Se o diretório atual for consideravelmente grande, você deverá clicar em Enter para iniciar a pesquisa.

Substituir entrada

• Campo de entrada para inserir texto de substituição.
• Alternar os modos de substituição (Simple, Preserve Case, AST Grep).
  • Simples: substitua todas as ocorrências da palavra-chave.
  • Preservar maiúsculas e minúsculas: Substitua ocorrências preservando as maiúsculas e minúsculas da palavra-chave.
  • AST Grep: Substitua ocorrências usando AST Grep.

Painel de resultados de pesquisa

• Lista de arquivos com resultados de pesquisa.
• Navegação para selecionar e visualizar arquivos.
• Opção para excluir arquivos dos resultados da pesquisa.
• Contagem de resultados de pesquisa e contagem de arquivos atuais.
• Capacidade de pesquisar a lista usando a tecla / .

Painel de visualização

• Exibição do arquivo selecionado com resultados de pesquisa destacados e contexto.
• Navegação para visualizar diferentes correspondências dentro do arquivo.
• Opção para excluir linhas individuais contendo correspondências.

Dicas rápidas

• Use a combinação de teclas Ctrl + b para exibir a caixa de diálogo de ajuda.
• Use a combinação de teclas Ctrl + o para processar a substituição de todos os arquivos.
• Use a tecla r para processar a substituição do arquivo ou linha selecionado.
• Use a combinação de teclas Ctrl + n para alternar entre os modos de pesquisa e substituição.
• Use as teclas g , G , j e k para navegar pelos resultados da pesquisa.
• Use a tecla d para excluir o arquivo ou linha selecionada.

Integração Neovim usando toggleterm

Confira o plugin toggleterm.nvim para Neovim, que fornece um terminal que pode ser alternado com uma ligação de tecla. Ou você pode usar a seguinte configuração, se estiver usando AstroNvim:

 return {
  " akinsho/toggleterm.nvim " ,
  cmd = { " ToggleTerm " , " TermExec " },
  dependencies = {
    {
      " AstroNvim/astrocore " ,
      opts = function ( _ , opts )
        local maps = opts . mappings
        local astro = require " astrocore "
        maps . n [ " <Leader>t " ] = vim . tbl_get ( opts , " _map_sections " , " t " )

        local serpl = {
          callback = function ()
            astro . toggle_term_cmd " serpl "
          end ,
          desc = " ToggleTerm serpl " ,
        }
        maps . n [ " <Leader>sr " ] = { serpl . callback , desc = serpl . desc }

        maps . n [ " <Leader>tf " ] = { " <Cmd>ToggleTerm direction=float<CR> " , desc = " ToggleTerm float " }
        maps . n [ " <Leader>th " ] = { " <Cmd>ToggleTerm size=10 direction=horizontal<CR> " , desc = " ToggleTerm horizontal split " }
        maps . n [ " <Leader>tv " ] = { " <Cmd>ToggleTerm size=80 direction=vertical<CR> " , desc = " ToggleTerm vertical split " }
        maps . n [ " <F7> " ] = { ' <Cmd>execute v:count . "ToggleTerm"<CR> ' , desc = " Toggle terminal " }
        maps . t [ " <F7> " ] = { " <Cmd>ToggleTerm<CR> " , desc = " Toggle terminal " }
        maps . i [ " <F7> " ] = { " <Esc><Cmd>ToggleTerm<CR> " , desc = " Toggle terminal " }
        maps . n [ " <C-'> " ] = { ' <Cmd>execute v:count . "ToggleTerm"<CR> ' , desc = " Toggle terminal " }
        maps . t [ " <C-'> " ] = { " <Cmd>ToggleTerm<CR> " , desc = " Toggle terminal " }
        maps . i [ " <C-'> " ] = { " <Esc><Cmd>ToggleTerm<CR> " , desc = " Toggle terminal " }
      end ,
    },
  },
  opts = {
    highlights = {
      Normal = { link = " Normal " },
      NormalNC = { link = " NormalNC " },
      NormalFloat = { link = " NormalFloat " },
      FloatBorder = { link = " FloatBorder " },
      StatusLine = { link = " StatusLine " },
      StatusLineNC = { link = " StatusLineNC " },
      WinBar = { link = " WinBar " },
      WinBarNC = { link = " WinBarNC " },
    },
    size = 10 ,
    --- @param t Terminal
    on_create = function ( t )
      vim . opt_local . foldcolumn = " 0 "
      vim . opt_local . signcolumn = " no "
      if t . hidden then
        local toggle = function () t : toggle () end
        vim . keymap . set ({ " n " , " t " , " i " }, " <C-'> " , toggle , { desc = " Toggle terminal " , buffer = t . bufnr })
        vim . keymap . set ({ " n " , " t " , " i " }, " <F7> " , toggle , { desc = " Toggle terminal " , buffer = t . bufnr })
      end
    end ,
    shading_factor = 2 ,
    direction = " float " ,
    float_opts = { border = " rounded " },
  },
}

Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo LICENSE para obter detalhes.

Contribuindo

(WIP)

Agradecimentos

• Este projeto foi inspirado na funcionalidade de pesquisa e substituição do VS Code.
• Este projeto é construído usando a incrível biblioteca ratui.rs e construído sobre seu modelo de componente.
• Obrigado ao projeto ripgrep por fornecer a funcionalidade de pesquisa.
• Obrigado ao projeto ast-grep por fornecer a funcionalidade AST Grep.

Projetos semelhantes

• repgrep: Um substituto interativo para ripgrep que facilita a localização e substituição de arquivos na linha de comando.