serpl

Serpl

serpl est une application d'interface utilisateur de terminal (TUI) qui permet aux utilisateurs de rechercher et de remplacer des mots-clés dans un dossier entier, similaire à la fonctionnalité disponible dans VS Code.

serpl-demo.mp4

Table des matières

1. Caractéristiques
2. Installation
   • Conditions préalables
   • Mesures
   • Binaires
   • Installation spécifique au système d'exploitation
3. Usage
   • Commandes de base
   • Raccourcis de touches
   • Configuration
4. Volets
   • Entrée de recherche
   • Remplacer l'entrée
   • Volet des résultats de recherche
   • Volet d'aperçu
5. Conseils rapides
6. Intégration Neovim à l'aide de toggleterm
7. Licence
8. Contribuer
9. Remerciements
10. Projets similaires

Caractéristiques

• Recherchez des mots-clés dans l'ensemble d'un dossier de projet, avec des options de respect de la casse, AST Grep et bien plus encore.
• Remplacez les mots-clés par des options de préservation de la casse, AST Grep et plus encore.
• Aperçu interactif des résultats de recherche.
• Navigation au clavier pour un flux de travail efficace.
• Raccourcis de touches et modes de recherche configurables.

Installation et mise à jour

Conditions préalables

• ripgrep installé sur votre système.
• (Facultatif) ast-grep installé sur votre système, si vous souhaitez utiliser la fonctionnalité AST Grep.

Mesures

1. Installez l'application à l'aide de Cargo :

cargo install serpl

• Si vous souhaitez installer l'application avec la fonctionnalité AST Grep, vous pouvez utiliser la commande suivante :

  cargo install serpl --features ast_grep

2. Exécutez l'application :

serpl

Binaires

Consultez la page des versions pour les derniers binaires.

Installation spécifique au système d'exploitation

Brasser

serpl peut être installé en utilisant Homebrew :

brew install serpl

Arch Linux

serpl peut être installé à partir des dépôts officiels en utilisant pacman :

pacman -S serpl

Nix/NixOS

serpl est inclus dans nixpkgs depuis 24.11, et peut être installé via Nix de différentes manières :

Sur les configurations Nix autonomes :

nix profile install nixpkgs#serpl

Sur NixOS (via configuration.nix ou similaire) :

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

Sur Home-Manager :

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

Usage

Commandes de base

• Démarrez l'application dans le répertoire courant :

  serpl

• Démarrez l'application et fournissez le chemin racine du projet :

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

Raccourcis de touches

Les raccourcis clavier par défaut peuvent être personnalisés via le fichier config.json .

Liaisons de touches par défaut

Combinaison de touches	Action
Ctrl + c	Quitter
Ctrl + b	Aide
Tab	Basculer entre les onglets
Backtab	Passer aux onglets précédents
Ctrl + o	Processus de remplacement pour tous les fichiers
r	Processus de remplacement pour le fichier ou la ligne sélectionné
Ctrl + n	Basculer les modes de recherche et de remplacement
Enter	Exécuter la recherche (pour les gros dossiers)
g / Left / h	Aller en haut de la liste
G / Right / l	Aller en bas de la liste
j / Down	Passer à l'élément suivant
k / Up	Passer à l'élément précédent
/	Liste des résultats de recherche
d	Supprimer le fichier ou la ligne sélectionné
Esc	Quitter le volet ou la boîte de dialogue actuel
Enter (dans les boîtes de dialogue) / y	Confirmer l'action
Esc (dans les boîtes de dialogue) / n	Annuler l'action
h , l , Tab (dans les boîtes de dialogue)	Parcourir les options de la boîte de dialogue

Configuration

serpl utilise un fichier de configuration pour gérer les raccourcis clavier et autres paramètres. Par défaut, le chemin d'accès au fichier de configuration peut être trouvé en exécutant serpl --version . Vous pouvez utiliser différents formats de fichiers pour la configuration, tels que JSON, JSON5, YAML, TOML ou INI.

Exemples de configurations

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

Vous pouvez personnaliser les raccourcis clavier en modifiant le fichier de configuration au format de votre choix.

Volets

Entrée de recherche

• Champ de saisie pour saisir des mots-clés de recherche.
• Basculer les modes de recherche (Simple, Match Case, Match Whole Word, Match Case Whole Word, Regex, AST Grep).
  • Simple : recherchez toutes les occurrences du mot-clé.
  • Faire correspondre la casse : rechercher des occurrences ayant la même casse que le mot-clé.
  • Faire correspondre le mot entier : recherchez les occurrences qui correspondent exactement au mot-clé.
  • Faire correspondre le mot entier à la casse : recherchez les occurrences qui correspondent exactement au mot-clé avec la même casse.
  • Regex : recherchez des occurrences à l’aide d’une expression régulière.
  • AST Grep : recherchez des occurrences à l'aide d'AST Grep.

Conseil

Si le répertoire actuel est considérablement volumineux, vous devez cliquer sur Enter pour lancer la recherche.

Remplacer l'entrée

• Champ de saisie pour saisir le texte de remplacement.
• Basculer les modes de remplacement (Simple, Preserve Case, AST Grep).
  • Simple : remplacez toutes les occurrences du mot-clé.
  • Préserver la casse : remplacez les occurrences tout en préservant la casse du mot-clé.
  • AST Grep : remplacez les occurrences à l'aide de AST Grep.

Volet des résultats de recherche

• Liste des fichiers avec résultats de recherche.
• Navigation pour sélectionner et afficher les fichiers.
• Option pour supprimer des fichiers des résultats de recherche.
• Nombre de résultats de recherche et nombre de fichiers actuels.
• Possibilité de rechercher dans la liste à l'aide de la touche / .

Volet d'aperçu

• Affichage du fichier sélectionné avec les résultats de recherche en surbrillance et le contexte.
• Navigation pour afficher différentes correspondances dans le fichier.
• Option pour supprimer des lignes individuelles contenant des correspondances.

Conseils rapides

• Utilisez la combinaison de touches Ctrl + b pour afficher la boîte de dialogue d'aide.
• Utilisez la combinaison de touches Ctrl + o pour traiter le remplacement de tous les fichiers.
• Utilisez la touche r pour traiter le remplacement du fichier ou de la ligne sélectionné.
• Utilisez la combinaison de touches Ctrl + n pour basculer entre les modes de recherche et de remplacement.
• Utilisez les touches g , G , j et k pour parcourir les résultats de la recherche.
• Utilisez la touche d pour supprimer le fichier ou la ligne sélectionnée.

Intégration Neovim à l'aide de toggleterm

Découvrez le plugin toggleterm.nvim pour Neovim, qui fournit un terminal qui peut être basculé avec une liaison de clé. Ou vous pouvez utiliser la configuration suivante, si vous utilisez 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 " },
  },
}

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

Contribuer

(en-cours)

Remerciements

• Ce projet a été inspiré par la fonctionnalité de recherche et de remplacement de VS Code.
• Ce projet est construit à l'aide de l'impressionnante bibliothèque ratatui.rs et s'appuie sur leur modèle de composant.
• Merci au projet ripgrep pour fournir la fonctionnalité de recherche.
• Merci au projet ast-grep pour fournir la fonctionnalité AST Grep.

Projets similaires

• repgrep : un remplaçant interactif pour ripgrep qui facilite la recherche et le remplacement d'un fichier à l'autre sur la ligne de commande.