serpl

serpl

serpl es una aplicación de interfaz de usuario de terminal (TUI) que permite a los usuarios buscar y reemplazar palabras clave en una carpeta completa, similar a la funcionalidad disponible en VS Code.

serpl-demo.mp4

Tabla de contenido

1. Características
2. Instalación
   • Requisitos previos
   • Pasos
   • binarios
   • Instalación específica del sistema operativo
3. Uso
   • Comandos básicos
   • Atajos de teclas
   • Configuración
4. Paneles
   • Entrada de búsqueda
   • Reemplazar entrada
   • Panel de resultados de búsqueda
   • Panel de vista previa
5. Consejos rápidos
6. Integración de Neovim usando toggleterm
7. Licencia
8. Contribuyendo
9. Expresiones de gratitud
10. Proyectos similares

Características

• Busque palabras clave en toda una carpeta de proyecto, con opciones para distinguir entre mayúsculas y minúsculas, AST Grep y más.
• Reemplace las palabras clave con opciones para conservar mayúsculas y minúsculas, AST Grep y más.
• Vista previa interactiva de los resultados de búsqueda.
• Navegación por teclado para un flujo de trabajo eficiente.
• Combinaciones de teclas configurables y modos de búsqueda.

Instalación y actualización

Requisitos previos

• ripgrep instalado en su sistema.
• (Opcional) ast-grep instalado en su sistema, si desea utilizar la funcionalidad AST Grep.

Pasos

1. Instale la aplicación usando Cargo:

cargo install serpl

• Si desea instalar la aplicación con la funcionalidad AST Grep, puede utilizar el siguiente comando:

  cargo install serpl --features ast_grep

2. Ejecute la aplicación:

serpl

binarios

Consulte la página de lanzamientos para conocer los archivos binarios más recientes.

Instalación específica del sistema operativo

Elaborar cerveza

serpl se puede instalar usando Homebrew:

brew install serpl

Arco Linux

serpl se puede instalar desde los repositorios oficiales usando pacman :

pacman -S serpl

Nix/NixOS

serpl está incluido en nixpkgs desde 24.11 y se puede instalar a través de Nix de diferentes maneras:

En configuraciones Nix independientes :

nix profile install nixpkgs#serpl

En NixOS (a través de configuration.nix o similar):

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

En Home-Manager :

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

Uso

Comandos básicos

• Inicie la aplicación en el directorio actual:

  serpl

• Inicie la aplicación y proporcione la ruta raíz del proyecto:

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

Atajos de teclas

Las combinaciones de teclas predeterminadas se pueden personalizar a través del archivo config.json .

Combinaciones de teclas predeterminadas

Combinación de teclas	Acción
Ctrl + c	Abandonar
Ctrl + b	Ayuda
Tab	Cambiar entre pestañas
Backtab	Cambiar a pestañas anteriores
Ctrl + o	Procesar reemplazo para todos los archivos
r	Procesar reemplazo para el archivo o línea seleccionados
Ctrl + n	Alternar modos de búsqueda y reemplazo
Enter	Ejecutar búsqueda (para carpetas grandes)
g / Left / h	Ir al principio de la lista
G / Right / l	Ir al final de la lista
j / Down	Pasar al siguiente elemento
k / Up	Ir al elemento anterior
/	Lista de resultados de búsqueda
d	Eliminar archivo o línea seleccionada
Esc	Salir del panel o cuadro de diálogo actual
Enter (en cuadros de diálogo) / y	Confirmar acción
Esc (en cuadros de diálogo) / n	Cancelar acción
h , l , Tab (en cuadros de diálogo)	Navegar por las opciones de diálogo

Configuración

serpl utiliza un archivo de configuración para administrar combinaciones de teclas y otras configuraciones. De forma predeterminada, la ruta al archivo de configuración se puede encontrar ejecutando serpl --version . Puede utilizar varios formatos de archivo para la configuración, como JSON, JSON5, YAML, TOML o INI.

Configuraciones de ejemplo

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

Puede personalizar las combinaciones de teclas modificando el archivo de configuración en el formato que elija.

Paneles

Entrada de búsqueda

• Campo de entrada para ingresar palabras clave de búsqueda.
• Alternar modos de búsqueda (Simple, Coincidir con mayúsculas y minúsculas, Coincidir con palabra completa, Coincidir con mayúsculas y minúsculas, palabra completa, Regex, AST Grep).
  • Simple: busque todas las apariciones de la palabra clave.
  • Coincidencia de mayúsculas y minúsculas: busca apariciones con el mismo caso que la palabra clave.
  • Coincidir con toda la palabra: busque apariciones que coincidan exactamente con la palabra clave.
  • Coincidir con mayúsculas y minúsculas: busque ocurrencias que coincidan exactamente con la palabra clave con el mismo caso.
  • Regex: busca ocurrencias usando una expresión regular.
  • AST Grep: busque ocurrencias usando AST Grep.

Consejo

Si el directorio actual es considerablemente grande, debe hacer clic Enter para iniciar la búsqueda.

Reemplazar entrada

• Campo de entrada para ingresar texto de reemplazo.
• Alternar modos de reemplazo (Simple, Preservar mayúsculas y minúsculas, AST Grep).
  • Simple: reemplace todas las apariciones de la palabra clave.
  • Conservar mayúsculas y minúsculas: reemplaza las apariciones conservando las mayúsculas y minúsculas de la palabra clave.
  • AST Grep: reemplace las ocurrencias usando AST Grep.

Panel de resultados de búsqueda

• Lista de archivos con resultados de búsqueda.
• Navegación para seleccionar y ver archivos.
• Opción para eliminar archivos de los resultados de búsqueda.
• Recuento de resultados de búsqueda y recuento de archivos actuales.
• Posibilidad de buscar en la lista usando la tecla / .

Panel de vista previa

• Visualización del archivo seleccionado con resultados de búsqueda resaltados y contexto.
• Navegación para ver diferentes coincidencias dentro del archivo.
• Opción para eliminar líneas individuales que contengan coincidencias.

Consejos rápidos

• Utilice la combinación de teclas Ctrl + b para mostrar el cuadro de diálogo de ayuda.
• Utilice la combinación de teclas Ctrl + o para procesar el reemplazo de todos los archivos.
• Utilice la tecla r para procesar el reemplazo del archivo o línea seleccionado.
• Utilice la combinación de teclas Ctrl + n para alternar entre los modos de búsqueda y reemplazo.
• Utilice las teclas g , G , j y k para navegar por los resultados de la búsqueda.
• Utilice la tecla d para eliminar el archivo o línea seleccionada.

Integración de Neovim usando toggleterm

Consulte el complemento toggleterm.nvim para Neovim, que proporciona un terminal que se puede alternar con una combinación de teclas. O puede utilizar la siguiente configuración, si está utilizando 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 " },
  },
}

Licencia

Este proyecto está bajo la licencia MIT. Consulte el archivo de LICENCIA para obtener más detalles.

Contribuyendo

(WIP)

Expresiones de gratitud

• Este proyecto se inspiró en la funcionalidad de búsqueda y reemplazo de VS Code.
• Este proyecto se creó utilizando la increíble biblioteca ratatui.rs y se basa en su plantilla de componentes.
• Gracias al proyecto ripgrep por proporcionar la funcionalidad de búsqueda.
• Gracias al proyecto ast-grep por proporcionar la funcionalidad AST Grep.

Proyectos similares

• repgrep: un sustituto interactivo de ripgrep que facilita la búsqueda y el reemplazo de archivos en la línea de comandos.