Qu'est-ce que Sensei ?

Le plugin Sensei offre un moyen simple de trouver des modèles de code spécifiques dans votre code source, puis d'appliquer des règles de réécriture pour modifier le code correspondant. Le tout au sein de l'IDE IntelliJ, et en temps réel.

‍

‍

Par exemple, vous pourriez créer une règle qui détecte les annotations JUnit `@Disabled` sans motif ; Sensei vous signalerait alors le problème en mettant le code en surbrillance dans l'IDE.

De plus, en utilisant `alt+enter`, vous avez la possibilité d'ajouter un paramètre de commentaire TODO.

Une fois sélectionnée, cette option modifiera le code pour ajouter un motif standard, que vous pourrez ensuite personnaliser ; si vous ne le faites pas, il apparaîtra dans votre panneau TODO.

Par exemple, `@Disabled` deviendrait `@Disabled("TODO: ajoutez une description ici")`

Sensei combine les fonctionnalités d'un scanner d'analyse statique de code et d'un moteur de réécriture de code.

Actions d'intention IntelliJ

D'après la description ci-dessus, l'alternative évidente (si vous n'utilisiez pas Sensei) serait d'utiliser la fonctionnalité des actions d'intention d'IntelliJ.

Sensei se distingue des actions d'intention d'IntelliJ car son objectif est de permettre la création de correspondances et de règles de réécriture spécifiques à un projet, voire propres à un développeur individuel.

Nous avons conçu une interface graphique qui facilite l'écriture et l'expérimentation des règles de correspondance et de réécriture.

Comment cela peut-il m'aider personnellement à progresser ?

Lorsque j'apprends une nouvelle bibliothèque, il me faut du temps pour acquérir les automatismes concernant les méthodes et le formatage. Je pourrais donc choisir de créer des recettes personnelles qui

• renvoient vers la documentation officielle ou des tutoriels
• contiennent des modèles standards les plus efficaces
• corrigent les mauvaises pratiques de codage
• ajoutent du code standard pour faciliter l'utilisation d'une bibliothèque

Je peux utiliser Sensei pour créer des recettes temporaires qui me rappellent les pratiques que j'ai choisi d'adopter et m'aident à prendre de bonnes habitudes. Ces recettes sont temporaires car je peux les supprimer une fois qu'elles ne me sont plus utiles.

Comment cela peut-il aider mon équipe à progresser ?

De la même manière, nous pouvons aider les équipes à acquérir des automatismes autour de normes de codage convenues.

En créant des recueils de recettes que nous appliquons lorsque nous retrouvons les mêmes remarques lors des revues de pull requests. Comme ces recueils sont stockés dans le contrôle de version du projet, ils sont accessibles à tous les membres de l'équipe. Et nous pouvons les désactiver lorsque nous n'avons plus besoin de ces rappels.

Sensei permet de fournir un retour rapide

Avec Sensei, nous avons cherché à intégrer le plus tôt possible dans le processus de développement les retours qui nous aident à progresser et les rappels sur les actions correctives.

Plutôt que d'attendre

• les résultats d'une analyse statique
• les commentaires d'une revue de code

Nous pouvons désormais visualiser les retours sur les normes personnalisées que nous souhaitons appliquer, directement pendant que nous codons.

Nous disposons de rappels ou de règles de réécriture concrètes pour nous aider à produire un code conforme à ces normes.

Sensei est flexible

À ce titre, Sensei est un outil hybride, car il est à la fois :

• un analyseur statique
• un tuteur de programmation
• un moteur de réécriture

La flexibilité de Sensei rend la question « Qu'est-ce que Sensei ? » un peu plus difficile à définir.

Sensei comble une lacune dans le flux de travail de programmation

Nous avons conçu Sensei comme l'élément manquant du flux de travail des développeurs, vous aidant à améliorer des aspects précis de votre style de codage ou de l'utilisation des bibliothèques au sein de votre équipe.

Cette flexibilité demande un temps d'adaptation légèrement supérieur à celui d'un outil d'analyse statique ou des intentions intégrées d'IntelliJ. Cependant, en prenant le temps d'expérimenter, vous découvrirez une nouvelle façon d'accélérer votre apprentissage.

Comment expérimenter ?

Une fois Sensei téléchargé et installé depuis le [Intellij Marketplace]

La meilleure façon de tirer parti de Sensei est d'examiner votre processus de codage et de vous demander :

• Quelle documentation consultez-vous sans cesse ?
  -- Vous pourriez ajouter des recettes Sensei renvoyant à cette documentation.
• Quelles erreurs simples commettez-vous régulièrement ?
  -- Vous pourriez temporairement codifier ce mauvais modèle sous forme de matcher et créer une correction rapide pour modifier le code selon vos attentes.
• Quel code répétitif écrivez-vous pour utiliser une bibliothèque ?
  -- Vous pourriez créer une règle de correction rapide pour générer ce code automatiquement.

Conçu pour compléter vos outils d'analyse statique, Sensei vous permet de reproduire les violations signalées dans une recette. Vous pouvez alors ajouter une correction rapide pour apprendre non seulement à identifier l'erreur, mais aussi à écrire immédiatement le code correct.