gritql

Zona de juegos | Tutoría | Documentos

---

GritQL es un lenguaje de consulta declarativo para buscar y modificar código fuente.

• Comience simplemente sin conocer los detalles de AST: cualquier fragmento de código es una consulta GritQL válida
• ⚡️ Utilice Rust y optimización de consultas para escalar hasta más de 10 millones de repositorios de líneas
• ? Utilice el sistema de módulos integrado de Grit para reutilizar más de 200 patrones estándar o comparta el suyo propio
• ♻️ Una vez que aprenda GritQL, podrá usarlo para reescribir cualquier lenguaje de destino: JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go o SQL.
• ? GritQL facilita la inclusión de reglas de reparación automática para una solución más rápida

Empezando

Lea la documentación, el tutorial interactivo o ejecute grit --help .

Instalación

Instale la CLI de Grit:

 curl -fsSL https://docs.grit.io/install | bash

Uso

Busque todas sus llamadas console.log poniendo el patrón deseado entre comillas invertidas:

 grit apply '`console.log($_)`'

Reemplace console.log con winston.log , usando => para crear reescrituras:

 grit apply '`console.log($msg)` => `winston.log($msg)`'

Guarde el patrón en un archivo grit.yaml y excluya los casos de prueba en una cláusula donde:

 cat << 'EOF' > .grit/grit.yaml
patterns:
  - name: use_winston
    level: error
    body: |
      `console.log($msg)` => `winston.log($msg)` where {
        $msg <: not within or { `it($_, $_)`, `test($_, $_)`, `describe($_, $_)` }
      }
EOF
grit apply use_winston

Ejecute grit check para hacer cumplir sus patrones como pelusas personalizadas.

 grit check

Ejemplos

Elimine todas las llamadas console.log , a menos que estén dentro de un bloque try-catch

 `console.log($log)` => . where {
  $log <: not within `try { $_ } catch { $_ }`
}

Reemplazar una llamada a un método con una nueva llamada a un método

 `$instance.oldMethod($args)` => `$instance.newMethod($args)` where {
  $program <: contains `$instance = new TargetClass($_)`
}

Más ejemplos

Se pueden encontrar muchos más ejemplos en la biblioteca estándar GritQL.

Los patrones se pueden combinar para crear consultas complejas, incluidos grandes refactores.

¿Por qué GritQL?

GritQL proviene de nuestra experiencia en la realización de migraciones y refactorizaciones a gran escala.

Por lo general, las migraciones comienzan con un trabajo exploratorio para determinar el alcance del problema, a menudo mediante búsquedas grep simples. Es fácil empezar con ellos, pero la mayoría de las migraciones terminan acumulando requisitos adicionales, como garantizar que se importen los paquetes correctos y excluir los casos que no tienen una ruta de migración viable.

Al final, cualquier migración compleja termina siendo un programa codemod completo escrito con una herramienta como jscodeshift. Esto viene con sus propios problemas:

• La mayor parte del trabajo exploratorio debe abandonarse mientras descubre cómo representar su búsqueda de expresiones regulares original como un AST.
• Leer/escribir un codemod requiere traducir mentalmente los nombres AST a cómo se ve realmente el código fuente.
• La mayoría de los marcos no son componibles, por lo que estás atascado copiando patrones de un lado a otro.
• El rendimiento suele ser una ocurrencia tardía, por lo que iterar en un codemod grande puede ser terriblemente lento.
• Los marcos Codemod son específicos del idioma, por lo que si estás saltando entre varios idiomas (o intentando migrar una API compartida) debes aprender diferentes marcos.

GritQL es nuestro intento de desarrollar un punto medio poderoso:

• El análisis exploratorio es fácil: simplemente coloque un fragmento de código entre comillas invertidas y use $metavariables para los agujeros que desee representar.
• Agregue complejidad incrementalmente introduciendo condiciones secundarias con cláusulas Where.
• Reutilice patrones con nombre para evitar reconstruir consultas y utilice patrones compartidos de nuestra biblioteca estándar para tareas comunes como garantizar la importación de módulos.
• Escrito en Rust para obtener el máximo rendimiento: reescribe millones de líneas de código en segundos.

Expresiones de gratitud

GritQL utiliza tree-sitter para todos los analizadores de idiomas y se beneficia enormemente del ecosistema Rust.

GritQL se publica bajo la licencia MIT.

Contribuyendo

Las contribuciones son bienvenidas. Para comenzar, consulte las pautas de contribución .

También puedes unirte a nosotros en Discord .