Plugin Jetbrains – créer une action et la déclencher via un raccourcis

On va créer pas-à-pas un raccourci qui nous permettra de générer un IBAN et de l’insérer à l’endroit où se trouve notre curseur. Si vous n’avez pas fait le setup pour développer un plugin Jetbrains, je vous invite à lire notre article sur le sujet.

I. Créer l’action

Une action est une fonctionnalité qui va être déclenchée par l’utilisateur. Dans le code, une action est une classe qui étend la classe abstraite AnAction() et implémente la méthode “actionPerformed”. 

Comme son nom l’indique, c’est la méthode qui sera appelée au déclenchement de l’action. On aura alors:

internal class GenerateIbanAction : AnAction() {
     override fun actionPerformed(e: AnActionEvent) {
       TODO("Not yet implemented")
     }
}         

On va ensuite ajouter la logique:

override fun actionPerformed(e: AnActionEvent) {

   val editor = e.getRequiredData(CommonDataKeys.EDITOR)
   val project = e.getRequiredData(CommonDataKeys.PROJECT)
   val document = editor.document
   val caretModel = editor.caretModel

   val iban = FrenchIban.create()

   WriteCommandAction.runWriteCommandAction(project) {
     
       document.insertString(editor.caretModel.offset, iban.getValue())
       caretModel.moveToOffset(caretModel.offset + iban.getValue().length)
       

   }

}

La logique est très simple ici: on récupère le document courant et on insère l’iban (généré via la méthode FrenchIban.create()) au niveau de notre curseur.

La dernière ligne permet au curseur de se déplacer à la fin de l’IBAN pour plus de praticité.

On a dû utiliser WriteCommandAction.runWriteCommandAction(project) car on écrit dans un document.

II. Enregistrer l’action

Pour que l’action soit disponible dans la liste des actions, il faut aller dans le fichier plugin.xml et ajouter les lignes suivantes:

<actions>
   <action
           id="com.github.maximedezette.ibangenerator.actions.GenerateIbanAction"
           class="com.github.maximedezette.ibangenerator.actions.GenerateIbanAction"
           text="Generate a random french IBAN"
   />
</actions>

Chaque action de notre plugin sera à déclarer dans le bloc <actions> </actions>.

Si on lance notre plugin et qu’on liste les actions, on peut déjà voir que l’action est disponible.

Note: pour lister les actions, le raccourci par défaut est ctrl + shift + A.

Enfin, on va lier notre action à un raccourcis (j’ai choisi alt + I pour l’exemple)

<actions>
   <action
           id="com.github.maximedezette.ibangenerator.actions.GenerateIbanAction"
           class="com.github.maximedezette.ibangenerator.actions.GenerateIbanAction"
           text="Generate a random french IBAN"
   >
       <keyboard-shortcut
               keymap="$default"
               first-keystroke="alt I"
       />
   </action>
</actions>

Nos utilisateurs vont bien évidemment pouvoir modifier ce raccourcis à leur convenance:

Conclusion

Dans cet article, on a vu un exemple simple de raccourcis actionnable par nos utilisateurs. Vous pouvez retrouver toutes les sources ici: https://github.com/maximedezette/IBAN-Generator 

Sources

https://plugins.jetbrains.com/docs/intellij/plugin-actions.html

https://plugins.jetbrains.com/docs/intellij/working-with-text.html#safely-replacing-selected-text-in-the-document