¿Qué es Sensei?

El plugin Sensei ofrece una forma sencilla de encontrar patrones de código específicos en tu código fuente y aplicar reglas de reescritura para modificar el código coincidente. Todo dentro del IDE IntelliJ y en tiempo real.

‍

‍

Por ejemplo, podrías crear una regla que detecte anotaciones `@Disabled` de JUnit que no tengan un motivo; Sensei te informaría del problema resaltando el código en el IDE.

Además, al presionar `alt+enter`, puedes tener la opción de `Add a todo comment parameter`.

Al seleccionarla, el código se modificaría para añadir un motivo predeterminado que luego puedes editar; si no lo haces, aparecerá en tu panel de TODO.

p. ej., `@Disabled` se convertiría en `@Disabled("TODO: add a description here")`

Sensei combina la funcionalidad de un escáner de análisis estático de código con un motor de reescritura de código.

Acciones de intención de IntelliJ

Basándose en la descripción anterior, la alternativa obvia (si no estuvieras usando Sensei) es utilizar la funcionalidad de Acciones de intención de IntelliJ.

Sensei se diferencia de las Acciones de intención de IntelliJ porque su objetivo es proporcionar una forma de crear buscadores de coincidencias y reescritores que sean específicos para un proyecto, o incluso locales para un desarrollador individual.

Hemos intentado crear una interfaz gráfica que facilite tanto la escritura como la experimentación con las reglas de coincidencia y reescritura.

¿Cómo puede ayudarme a mejorar personalmente?

Cuando aprendo una biblioteca nueva, me lleva tiempo desarrollar la memoria muscular necesaria para los métodos y el formato. Por eso, podría optar por crear recetas personales que

• enlacen a la documentación oficial o a páginas de tutoriales
• tengan plantillas predeterminadas que sean más efectivas
• corrijan malas prácticas de codificación
• añadan código predeterminado para ayudar a usar una biblioteca

Puedo usar Sensei para crear recetas temporales que me recuerden las prácticas que he decidido seguir y me ayuden a desarrollar hábitos efectivos. Y las recetas son temporales porque puedo eliminarlas cuando ya no las necesite.

¿Cómo puede ayudar a mi equipo a mejorar?

De la misma manera, podemos ayudar a los equipos a desarrollar memoria muscular en torno a los estándares de codificación acordados.

Creando libros de recetas que aplicamos cuando encontramos los mismos comentarios en las revisiones de solicitudes de extracción (pull requests). Dado que los libros de recetas se almacenan en el control de versiones junto con el proyecto, están disponibles para todos los miembros del equipo. Y podemos desactivarlos cuando ya no necesitemos los recordatorios.

Sensei ayuda a proporcionar comentarios de forma temprana

Con Sensei, hemos intentado crear una forma de obtener comentarios que nos ayuden a mejorar, junto con recordatorios de acciones correctivas, lo antes posible en el proceso de programación.

En lugar de esperar a

• los resultados de un analizador estático
• los comentarios de una revisión de código

Podemos ver los comentarios sobre los estándares personalizados que queremos aplicar mientras programamos.

Y disponemos de recordatorios o reglas de reescritura para ayudarnos a escribir código que cumpla con dichos estándares.

Sensei es flexible

En ese sentido, Sensei es una combinación, ya que es:

• parte analizador estático
• tutor de programación
• motor de reescritura

Sensei es lo suficientemente flexible como para que definir qué es resulte un poco más difícil.

Sensei cubre un vacío en el flujo de trabajo de programación

Hemos intentado que Sensei sea la pieza que faltaba en el flujo de trabajo del programador, ayudándole a mejorar elementos específicos de su estilo de codificación o del uso de librerías en los que usted y su equipo trabajan actualmente.

Esta flexibilidad implica que requiere un poco más de tiempo familiarizarse con Sensei que con una herramienta de análisis estático o las intenciones integradas de IntelliJ. Aun así, al dedicar tiempo a experimentar, obtendrá una nueva forma de acelerar su aprendizaje.

¿Cómo experimentar?

Una vez que haya descargado e instalado Sensei desde el [Intellij Marketplace]

La forma más sencilla de hacer que Sensei trabaje para usted es observar su proceso de programación y considerar:

• ¿Qué documentación consulta constantemente?
  -- Podría añadir recetas de Sensei que enlacen a esa documentación.
• ¿Qué errores simples comete con frecuencia?
  -- Podría codificar temporalmente ese patrón erróneo como un buscador y escribir una corrección rápida que modifique el código según lo que realmente desea escribir.
• ¿Qué código repetitivo escribe para usar una librería?
  -- Podría crear una regla de corrección rápida para que escriba el código por usted.

Dado que Sensei está diseñado para funcionar junto con cualquier herramienta de análisis estático que utilice, si observa que el análisis estático reporta las mismas infracciones, puede replicar la condición en una receta de Sensei. Luego, puede añadir una corrección rápida para entrenarse, no solo para identificar el error, sino también para aprender a escribir el código correcto rápidamente.