🤖 Griddo Codemod

Este repositorio contiene una colección de _codemods_ para instancias de Griddo.

Los codemods son scripts que ayudan a automatizar el proceso de realizar cambios en la base de código. En este repositorio se encuentran un conjunto de _codemods_ diseñados específicamente para instancias de Griddo.

---

``bash


Muestra una lista de los codemods disponibles

npx griddo-codemods list

Aplica el codemod node20


npx griddo-codemods run node20
`

---

--

¿Cómo desarrollo un codemod en node?

En este caso no hay nada a tener en cuenta, se desarrolla el codemod en Node usando TypeScript. Un ejemplo de codemode en node es codemods/node-20.ts

¿Cómo desarrollo un codemod utilizando jscodeshift para analizar el código de la instancia con AST?

Para ello se utiliza como base, jscodeshift que es una biblioteca que provee una API para modiciar el código mediante AST.

El flujo consiste en un archivo /griddo-codemod.ts que inicialmente no requiere ser modificado. Esto funciona como una CLI a la que se deben pasar dos argumentos al ejecutarlo: El primer argumento es un archivo _transform_ donde se encuentra la lógica de transformación, y el segundo argumento es la ruta donde se encuentran los archivos que queremos modificar.

Ejemplo usando tsx para ejecutar griddo-codemod

`bash
npx tsx griddo-codemod my-transform.ts src/schemas


|---^------------| |---^---------| |---^-----|




"cli" transform target files, in this case every file inside src/schemas


`

> Probablemente queremos hacer algún tipo de verificación previa antes de lanzar el codemod en la instancia para ver si tiene sentido ejecutarlo: verificar la versión de Griddo, la existencia de ciertos archivos, etc.

El archivo que contendrá la lógica de transformación y donde haremos la mayor parte de nuestro trabajo debe seguir la estructura inicial siguiente.

`typescript
import { Transform } from "jscodeshift";

const transformer: Transform = (file, api) => {
// API
const j = api.jscodeshift;
// AST de cada archivo
const root = j(file.source);

// Transformación de root (AST) mediante la API de jscodeshift y javascript.
// ...

// Volvemos a guardar el archivo modificado
return root.toSource();
};

// Exportamos la función por defecto
export default transformer;
`

Cómo añadir un codemod al repo.

Después de desarrollar el codemod debe insertarse en el registro de codemods: src/codemods/register.ts que es un objeto con entradas del tipo CodemodEntry:

`typescript
const codemods = {
codemod_name: {
name: "Nice name",
description: "Nice description",
fn: addOpenSSLNode20, // función a la que llama este codemod
},
};
`

Una vez en el registro, estará disponible para ser ejecutado con npx griddo-codemods run codemod_name

¿Cómo utilizan las instancias un codemod?

Usando npx y el paquete de npm griddo-codemods desde el root del repositorio de la instancia.

`bash
npx griddo-codemods run
``