gritql

Aire de jeux | Tutoriel | Documents

---

GritQL est un langage de requête déclaratif permettant de rechercher et de modifier le code source.

• Commencez simplement sans apprendre les détails de l'AST : tout extrait de code est une requête GritQL valide
• ⚡️ Utilisez Rust et l'optimisation des requêtes pour évoluer jusqu'à plus de 10 millions de référentiels de lignes
• ? Utilisez le système de modules intégré de Grit pour réutiliser plus de 200 modèles standards ou partager les vôtres
• ♻️ Une fois que vous avez appris GritQL, vous pouvez l'utiliser pour réécrire n'importe quel langage cible : JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go ou SQL.
• ? GritQL facilite l'inclusion de règles de correction automatique pour une correction plus rapide

Commencer

Lisez la documentation, le didacticiel interactif ou exécutez grit --help .

Installation

Installez la CLI Grit :

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

Usage

Recherchez tous vos appels console.log en mettant le modèle souhaité entre les backticks :

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

Remplacez console.log par winston.log , en utilisant => pour créer des réécritures :

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

Enregistrez le modèle dans un fichier grit.yaml et excluez les cas de test dans une clause Where :

 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

Exécutez grit check pour appliquer vos modèles en tant que charpies personnalisées.

 grit check

Exemples

Supprimez tous les appels console.log , sauf s'ils se trouvent dans un bloc try-catch

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

Remplacer un appel de méthode par un nouvel appel de méthode

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

Plus d'exemples

De nombreux autres exemples peuvent être trouvés dans la bibliothèque standard GritQL.

Les modèles peuvent être combinés pour créer des requêtes complexes, y compris de grands refactors.

Pourquoi GritQL ?

GritQL est issu de nos expériences en matière de refactorisations et de migrations à grande échelle.

Habituellement, les migrations commencent par un travail exploratoire visant à déterminer l'étendue du problème, souvent à l'aide de simples recherches grep. Il est facile de démarrer ces opérations, mais la plupart des migrations finissent par accumuler des exigences supplémentaires, comme s'assurer que les bons packages sont importés et exclure les cas qui ne disposent pas d'un chemin de migration viable.

Finalement, toute migration complexe finit par être un programme codemod complet écrit avec un outil comme jscodeshift. Cela vient avec ses propres problèmes :

• La plupart du travail exploratoire doit être abandonné pendant que vous découvrez comment représenter votre recherche d'expression régulière originale en tant qu'AST.
• Lire/écrire un codemod nécessite de traduire mentalement les noms AST en ce à quoi ressemble réellement le code source.
• La plupart des frameworks ne sont pas composables, vous êtes donc obligé de copier des modèles d'avant en arrière.
• Les performances sont souvent une réflexion après coup, donc itérer sur un gros codemod peut être extrêmement lent.
• Les frameworks Codemod sont spécifiques à la langue, donc si vous passez d'une langue à l'autre ou si vous essayez de migrer une API partagée, vous devez apprendre différents frameworks.

GritQL est notre tentative de développer un terrain d'entente puissant :

• L'analyse exploratoire est simple : il suffit de mettre un extrait de code dans des backticks et d'utiliser $metavariables pour les trous que vous souhaitez représenter.
• Ajoutez progressivement de la complexité en introduisant des conditions secondaires avec les clauses Where.
• Réutilisez les modèles nommés pour éviter de reconstruire les requêtes et utilisez les modèles partagés de notre bibliothèque standard pour les tâches courantes, comme garantir l'importation des modules.
• Écrit en Rust pour des performances maximales : réécrivez des millions de lignes de code en quelques secondes.

Remerciements

GritQL utilise Tree-Sitter pour tous les analyseurs de langage et bénéficie grandement de l'écosystème Rust.

GritQL est publié sous licence MIT.

Contribuer

Les contributions sont les bienvenues. Pour commencer, consultez les directives de contribution .

Vous pouvez également nous rejoindre sur Discord .