Premiers pas pour créer un plugin utilisable dans un IDE Jetbrains (IntelliJ, Webstorm, Rider etc..)

Introduction

Vous utilisez un IDE Jetbrains et des fonctionnalités vous manquent par exemple:

• des raccourcis bien pratiques
• des fenêtres d’information
• le support des formats de fichiers avec lesquels vous travaillez

etc..

Alors vous vous demandez peut-être comment les rajouter vous-même via l’écriture d’un plugin.

Dans cet article, on va voir pas à pas comment se lancer en utilisant le SDK “IntelliJ Platform Plugin SDK” . La marche à suivre va être la même pour tous les IDE Jetbrains.

I. Set up

Pour commencer, vous ne partirez pas de 0 car un template est mis à disposition. Allez sur https://github.com/JetBrains/intellij-platform-plugin-template et suivez le “Getting started”.

C’est très rapide, en gros vous aurez à cloner le projet et à spécifier un SDK Java 17.

II. Aperçu de notre premier plugin

Spécifier l’IDE de test (facultatif)

Ouvrez le template puis allez dans gradle.properties pour choisir quel IDE on va lancer pour tester notre plugin. Remplacez “IC” (IntelliJ Community) par le code de l’IDE cible.  

platformType = IC

Si je veux que ça soit Rider qui se lance, je devrais mettre:

platformType = RD

Le code des IDE est disponible ici: 

https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#intellij-extension-type

Choisissez ensuite une version, par exemple:

platformVersion = 2024.1.1

Voilà, on sait quel IDE va nous permettre de lancer notre plugin.

Note: c’est dans le fichier gradle.properties qu’on va spécifier les infos de notre plugin (son nom, sa version, les versions supportées etc..)

Lancer le plugin

Par défaut, le template permet d’avoir un bouton qui génère un nombre aléatoire dans un panel, c’est ce qu’on va vouloir voir.

Dans la liste de « run configurations » pré-installées, cliquez sur “Run Plugin” et exécutez la. La première exécution prend pas mal de temps, c’est normal (ça ira bien plus vite après 😉)

Si tout se passe bien, l’IDE se lancera (IntelliJ community si vous n’avez rien changé ou l’IDE spécifié précédemment).

Ouvrez un projet, vous devriez voir “My tool Windows”  à gauche

Cliquez dessus, vous aurez alors un bouton permettant de générer un nombre aléatoire:

Si vous alliez dans « Settings > Plugins », vous verriez votre plugin de développement installé:

Voilà, vous savez comment lancer votre plugin ! A noter que le débug pas à pas fonctionne également.

Note: Pour le partager à des personnes avant de publier votre plugin sur la marketplace, vous pouvez lancer la task gradle “build”.

Vous aurez alors un zip permettant d’installer manuellement votre plugin.

Il faudra simplement importer ce fichier via “Install Plugin from Disk”.

Le code du panel est disponible ici si jamais vous voulez le modifier:

La documentation du SDK est ici: https://plugins.jetbrains.com/docs/intellij/welcome.html

Avec ça, vous devriez avoir toutes les clefs pour commencer à écrire votre plugin. Dans les prochains articles on se plongera dans le concret et on verra comment:

• Créer une action qui se déclenche via un raccourcis  
• Appeler des actions via un popup

etc..