gritql

Spielplatz | Anleitung | Dokumente

---

GritQL ist eine deklarative Abfragesprache zum Suchen und Ändern von Quellcode.

• Beginnen Sie einfach, ohne sich mit den AST-Details vertraut zu machen: Jedes Code-Snippet ist eine gültige GritQL-Abfrage
• ⚡️ Verwenden Sie Rust und Abfrageoptimierung, um bis zu 10 Millionen Zeilen-Repositorys zu skalieren
• ? Nutzen Sie das integrierte Modulsystem von Grit, um mehr als 200 Standardmuster wiederzuverwenden oder Ihre eigenen zu teilen
• ♻️ Sobald Sie GritQL gelernt haben, können Sie damit jede Zielsprache umschreiben: JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go oder SQL
• ? Mit GritQL können Sie ganz einfach automatische Korrekturregeln einbinden, um die Behebung zu beschleunigen

Erste Schritte

Lesen Sie die Dokumentation, das interaktive Tutorial oder führen Sie grit --help aus.

Installation

Installieren Sie die Grit-CLI:

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

Verwendung

Suchen Sie nach allen Ihren console.log Aufrufen, indem Sie das gewünschte Muster in Backticks einfügen:

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

Ersetzen Sie console.log durch winston.log und verwenden Sie => , um Umschreibungen zu erstellen:

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

Speichern Sie das Muster in einer grit.yaml Datei und schließen Sie Testfälle in einer where-Klausel aus:

 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

Führen Sie grit check durch, um Ihre Muster als benutzerdefinierte Flusen durchzusetzen.

 grit check

Beispiele

Entfernen Sie alle console.log Aufrufe, es sei denn, sie befinden sich innerhalb eines Try-Catch-Blocks

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

Ersetzen Sie einen Methodenaufruf durch einen neuen Methodenaufruf

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

Weitere Beispiele

Viele weitere Beispiele finden Sie in der GritQL-Standardbibliothek.

Muster können kombiniert werden, um komplexe Abfragen zu erstellen, einschließlich großer Refaktoren.

Warum GritQL?

GritQL basiert auf unseren Erfahrungen mit der Durchführung groß angelegter Refaktoren und Migrationen.

Normalerweise beginnen Migrationen mit Sondierungsarbeiten, um den Umfang des Problems herauszufinden – oft mithilfe einfacher Grep-Suchen. Der Einstieg ist einfach, aber bei den meisten Migrationen häufen sich zusätzliche Anforderungen an, z. B. die Sicherstellung, dass die richtigen Pakete importiert werden, und das Ausschließen von Fällen, für die es keinen praktikablen Migrationspfad gibt.

Letztendlich ist jede komplexe Migration ein vollständiges Codemod-Programm, das mit einem Tool wie jscodeshift geschrieben wurde. Dies bringt seine eigenen Probleme mit sich:

• Der größte Teil der Erkundungsarbeit muss aufgegeben werden, wenn Sie herausfinden, wie Sie Ihre ursprüngliche Regex-Suche als AST darstellen können.
• Das Lesen/Schreiben eines Codemods erfordert eine mentale Übersetzung der AST-Namen zurück in das tatsächliche Aussehen des Quellcodes.
• Die meisten Frameworks sind nicht zusammensetzbar, sodass Sie beim Hin- und Herkopieren von Mustern stecken bleiben.
• Leistung ist oft ein nachträglicher Gedanke, daher kann die Iteration auf einem großen Codemod schmerzhaft langsam sein.
• Codemod-Frameworks sind sprachspezifisch. Wenn Sie also zwischen mehreren Sprachen wechseln oder versuchen, eine gemeinsam genutzte API zu migrieren, müssen Sie verschiedene Frameworks erlernen.

GritQL ist unser Versuch, einen leistungsstarken Mittelweg zu entwickeln:

• Die explorative Analyse ist einfach: Fügen Sie einfach einen Codeausschnitt in Backticks ein und verwenden Sie $metavariables für Löcher, die Sie darstellen möchten.
• Erhöhen Sie die Komplexität schrittweise, indem Sie Nebenbedingungen mit Where-Klauseln einführen.
• Verwenden Sie benannte Muster wieder, um das erneute Erstellen von Abfragen zu vermeiden, und verwenden Sie gemeinsame Muster aus unserer Standardbibliothek für allgemeine Aufgaben, wie z. B. das Sicherstellen, dass Module importiert werden.
• Für maximale Leistung in Rust geschrieben: Schreiben Sie Millionen von Codezeilen in Sekunden neu.

Danksagungen

GritQL verwendet Tree-Sitter für alle Sprachparser und profitiert stark vom Rust-Ökosystem.

GritQL wird unter der MIT-Lizenz veröffentlicht.

Mitwirken

Beiträge sind willkommen. Sehen Sie sich zunächst die Beitragsrichtlinien an.

Sie können uns auch auf Discord beitreten.