Qu'est-ce que Sensei?

Le plugin Sensei offre un moyen facile 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 dans l'IDE Intellij, et en temps réel.

‍

‍

Par exemple, vous pourriez créer une règle qui s'applique aux annotations JUnit `@Disabled` qui n'ont pas de raison, Sensei vous indiquerait alors le problème en surlignant le code dans l'IDE.

De plus, lorsque vous `alt+enter`, vous pouvez avoir l'option `Ajouter un paramètre de commentaire à la tâche`.

Si vous sélectionnez cette option, le code sera modifié afin d'ajouter une raison type, que vous pourrez ensuite modifier, et si vous ne le faites pas, elle s'affichera dans votre panneau TODO.

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

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

Actions d'intention IntelliJ

Sur la base de la description ci-dessus, l'alternative évidente (si vous n'utilisez pas Sensei) est d'utiliser la fonctionnalité IntelliJ Intention Actions.

Sensei diffère des actions d'intention d'IntelliJ car l'objectif de Sensei est de fournir un moyen de créer des outils de mise en correspondance et de réécriture spécifiques à un projet, ou même locaux pour un développeur particulier.

Nous avons essayé de mettre en place 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 à m'améliorer personnellement ?

Lorsque j'apprends à utiliser une nouvelle bibliothèque, il me faut du temps pour développer une mémoire musculaire autour des méthodes et du formatage. Je peux donc choisir de créer des recettes personnelles qui

• créer un lien vers la documentation officielle ou les pages de tutoriel
• disposent de modèles types qui sont les plus efficaces
• corriger les mauvaises pratiques de codage
• ajouter du code de base pour faciliter l'utilisation d'une bibliothèque

Je peux utiliser Sensei pour créer des recettes temporaires qui m'incitent à utiliser les pratiques courantes que j'ai choisies et m'aident à créer des habitudes efficaces. Ces recettes sont temporaires, car je peux les supprimer lorsqu'elles ne sont plus adaptées à mes besoins.

Comment peut-il aider mon équipe à s'améliorer ?

De la même manière, nous pouvons aider les équipes à développer une mémoire musculaire autour de normes de codage convenues.

Créer des livres de recettes que nous appliquons lorsque nous trouvons les mêmes commentaires dans les revues de demandes d'extraction. Comme les livres de recettes sont stockés dans le contrôle de version avec le projet, ils sont disponibles pour tout le monde sur le projet. Et nous pouvons les désactiver lorsque nous n'avons plus besoin d'être guidés.

Sensei permet de fournir un retour d'information précoce

Ce que nous avons essayé de construire avec Sensei , c'est un moyen de tirer le retour d'information qui nous aide à nous améliorer, et des rappels d'actions correctives, aussi tôt que possible dans le processus de codage.

Plutôt que d'attendre

• les résultats d'un analyseur statique
• les commentaires d'un examen de code

Au lieu de cela, nous pouvons voir le retour d'information, pour les normes personnalisées que nous voulons mettre en œuvre, au fur et à mesure que nous codons.

Et nous disposons soit de rappels, soit de règles de réécriture, pour nous aider à écrire du code conforme aux normes.

Sensei est flexible

En ce sens, Sensei est un peu un mélange, puisqu'il s'agit de.. :

• partie Analyseur statique
• tuteur de codage
• moteur de réécriture

Sensei est suffisamment flexible pour rendre la tâche de dire "Qu'est-ce que Sensei?" un peu plus difficile.

Sensei comble une lacune dans le flux de travail de la programmation

Nous avons essayé de faire de Sensei la pièce manquante du flux de travail du programmeur qui vous aide à améliorer des éléments spécifiques de votre style de codage, ou de l'utilisation de la bibliothèque, avec laquelle vous et votre équipe travaillez actuellement.

Cette flexibilité signifie qu'il faut un peu plus de temps pour se familiariser avec Sensei qu'avec un outil d'analyse statique ou les intentions intégrées d'IntelliJ. Néanmoins, en prenant le temps d'expérimenter, vous découvrirez une nouvelle façon d'accélérer votre apprentissage dans le cadre de votre processus de développement personnel.

Comment expérimenter ?

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

Le moyen le plus simple de mettre Sensei à votre service est d'examiner votre processus de codage et d'y réfléchir :

• Quelle est la documentation que vous recherchez en permanence ?
  -- Vous pourriez ajouter des recettes Sensei qui renvoient à cette documentation.
• Quelles sont les erreurs simples que vous continuez à commettre ?
  -- Vous pourriez codifier temporairement ce mauvais modèle de codage en tant que matcher, et écrire une réécriture rapide qui modifie le code pour qu'il corresponde à ce que vous voulez vraiment écrire.
• Quel code type écrivez-vous pour utiliser une bibliothèque ?
  -- Vous pouvez créer une règle Quick Fix pour écrire le code à votre place.

Puisque Sensei est conçu pour fonctionner en parallèle avec n'importe quel outil d'analyse statique que vous utilisez, si vous constatez que les mêmes violations sont signalées par l'analyse statique, vous pouvez reproduire la condition dans une recette Sensei . Vous pouvez ensuite ajouter une correction rapide pour vous aider à vous entraîner, non seulement à identifier l'erreur, mais aussi à passer rapidement à l'écriture du code correct