Verstehen der Syntax für die GitHub-Codesuche

Informationen zur Struktur von Codesuchabfragen

Die Suchsyntax in diesem Artikel gilt nur für die Codesuche mit der GitHub-Codesuche. Beachte, dass die Syntax und die Qualifizierer für die Suche nach codefremden Inhalten wie Issues, Benutzern und Diskussionen nicht mit der Syntax der Codesuche identisch sind. Weitere Informationen zur Suche nach codefremden Inhalten findest du unter Informationen zur Suche auf GitHub und Suchen auf GitHub.

Suchabfragen bestehen aus Suchbegriffen, die Text enthalten, nach dem Sie suchen möchten, sowie aus Qualifizierern, die die Suche einschränken.

Ein reiner Begriff ohne Qualifizierer entspricht entweder dem Inhalt einer Datei oder dem Pfad der Datei.

Die folgende Abfrage ist beispielsweise:

http-push

Die obige Abfrage ermittelt die Datei , auch wenn sie nicht den Begriff enthält. Sie ermittelt außerdem eine Datei namens , wenn sie den Begriff enthält.

Sie können mehrere Begriffe durch Leerzeichen getrennt eingeben, um nach Dokumenten zu suchen, die beide Begriffe enthalten.

Die folgende Abfrage ist beispielsweise:

sparse index

Die Suchergebnisse beinhalten alle Dokumente, die die beiden Begriffe und in beliebiger Reihenfolge enthalten. Ein Beispiel wäre eine Datei, die entspricht, eine Datei mit dem Ausdruck und sogar eine Datei, die heißt und den Begriff enthält.

Die Suche nach mehreren Begriffen, die durch Leerzeichen getrennt sind, entspricht der Suche nach . Andere boolesche Vorgänge, z. B , werden ebenfalls unterstützt. Weitere Informationen zu booleschen Vorgängen findest du unter Verwenden boolescher Vorgänge.

Die Codesuche unterstützt auch die Suche nach einer genauen Zeichenfolge, einschließlich Leerraumzeichen. Weitere Informationen findest du unter Abfragen einer genauen Übereinstimmung.

Sie können die Codesuche mit spezialisierten Qualifizierern wie , und einschränken. Weitere Informationen zu den Qualifizierern, die du in der Codesuche verwenden kannst, findest du unter Verwenden von Qualifizierern.

Sie können auch reguläre Ausdrücke in Ihren Suchvorgängen verwenden, indem Sie den Ausdruck in Schrägstriche einschließen. Weitere Informationen zur Verwendung regulärer Ausdrücke findest du unter Verwendung regulärer Ausdrücke.

Abfrage nach einer genauen Übereinstimmung

Um nach einer genauen Zeichenfolge zu suchen, einschließlich Leerzeichen, können Sie die Zeichenfolge in Anführungszeichen setzen. Zum Beispiel:

"sparse index"

Sie können auch Zeichenfolgen in Anführungszeichen in Qualifizierern verwenden, z. B.:

path:git language:"protocol buffers"

Suchen nach Anführungszeichen und umgekehrten Schrägstrichen

Um nach einem Code zu suchen, der ein Anführungszeichen enthält, können Sie das Anführungszeichen mit einem umgekehrten Schrägstrich als Escapezeichen versehen. Wenn Sie beispielsweise die genaue Zeichenfolge finden möchten, können Sie wie folgt suchen:

"name = \"tensorflow\""

Um nach Code zu suchen, der einen umgekehrten Schrägstrich enthält, verwenden Sie einen doppelten umgekehrten Schrägstrich.

Die beiden Escapesequenzen und können auch außerhalb von Anführungszeichen verwendet werden. Es werden jedoch keine anderen Escapesequenzen erkannt. Ein Backslash, auf den in der Suche weder noch folgt, bleibt unverändert.

Zusätzliche Escapesequenzen wie z. B. zum Abgleichen eines Zeilenvorschubzeichen, werden in regulären Ausdrücken unterstützt. Weitere Informationen findest du unter Verwendung regulärer Ausdrücke.

Verwenden boolescher Vorgänge

Die Codesuche unterstützt boolesche Ausdrücke. Sie können die Operatoren , und verwenden, um Suchbegriffe zu kombinieren.

Standardmäßig sind benachbarte Begriffe, die durch Leerzeichen getrennt sind, gleichbedeutend mit der Verwendung des -Operators. Die Suchabfrage ist beispielsweise identisch mit . Das bedeutet, dass die Suchergebnisse alle Dokumente beinhalten, die sowohl den Begriff als auch den Begriff in beliebiger Reihenfolge enthalten.

Um nach Dokumenten zu suchen, die entweder den einen oder den anderen Ausdruck enthalten, können Sie den -Operator verwenden. Die folgende Abfrage findet z. B. Dokumente, die entweder oder enthalten:

sparse OR index

Um Dateien aus den Suchergebnissen auszuschließen, können Sie den -Operator verwenden. Zum Ausschließen von Dateien im Verzeichnis können Sie etwa wie folgt suchen:

"fatal error" NOT path:__testing__

Sie können Klammern verwenden, um komplexere boolesche Ausdrücke auszudrücken. Zum Beispiel:

(language:ruby OR language:python) AND NOT path:"/tests/"

Verwenden von Qualifizierern

Sie können spezielle Schlüsselwörter verwenden, um Ihre Suche zu qualifizieren.

• Qualifizierer für Repositories
• Qualifizierer für Organisationen und Benutzer
• Enterprise-Qualifizierer
• Sprachqualifikator
• Pfadqualifizierer
• Symbolqualifizierer
• Inhaltskategorisierer
• Is-Qualifizierer

Qualifizierer für Repositorys

Verwende für die Suche in einem Repository den Qualifizierer . Sie müssen den vollständigen Repositorynamen angeben, einschließlich des Besitzers. Zum Beispiel:

repo:github-linguist/linguist

Um in mehreren Repositorys zu suchen, können Sie mehrere -Qualifizierer mit dem booleschen Operator kombinieren. Zum Beispiel:

repo:github-linguist/linguist OR repo:tree-sitter/tree-sitter

Qualifizierer für Organisationen und Benutzer

Verwende den Qualifizierer , um nach Dateien innerhalb einer Organisation zu suchen. Zum Beispiel:

org:github

Verwende den Qualifizierer , um nach Dateien innerhalb eines persönlichen Kontos zu suchen. Zum Beispiel:

user:octocat

Enterprise-Qualifizierer

Verwenden Sie den Qualifizierer, um nach Dateien in einem Unternehmen zu suchen. Zum Beispiel:

enterprise:octocorp

Dies durchsucht Repositorys, die im Besitz von Organisationen im Unternehmen sind. Benutzereigene Repositorys sind nicht enthalten.

Qualifizierer für Sprachen

Verwenden Sie den Qualifizierer, um sich auf eine bestimmte Sprache einzugrenzen. Zum Beispiel:

language:ruby OR language:cpp OR language:csharp

Eine vollständige Liste der unterstützten Sprachnamen finden Sie in languages.yaml unter github-linguist/linguist. Wenn Ihre bevorzugte Sprache nicht in der Liste enthalten ist, können Sie einen Pull Request öffnen, um sie hinzuzufügen.

Pfadqualifizierer

Verwende den Qualifizierer , um innerhalb von Dateipfaden zu suchen. Dadurch werden Dateien gefunden, die den Begriff irgendwo im Dateipfad enthalten. Um beispielsweise Dateien zu suchen, die den Begriff in ihrem Pfad enthalten, verwende Folgendes:

path:unit_tests

Die obige Abfrage ermittelt sowohl als auch, da beide an einer beliebigen Stelle in ihrem Pfad enthalten.

Um nur einen bestimmten Dateinamen (und nicht ein Teil des Pfads) abzugleichen, können Sie einen regulären Ausdruck verwenden:

path:/(^|\/)README\.md$/

Beachte, dass im Dateinamen mit Escapezeichen versehen ist, da für reguläre Ausdrücke eine besondere Bedeutung hat. Weitere Informationen zur Verwendung regulärer Ausdrücke findest du unter Verwendung regulärer Ausdrücke.

Sie können auch einige eingeschränkte Glob-Ausdrücke im Qualifizierer verwenden.

Um beispielsweise nach Dateien mit der Erweiterung zu suchen, können Sie Folgendes verwenden:

path:*.txt

Um in einem Verzeichnis vom Typ nach JavaScript-Dateien zu suchen, können Sie Folgendes verwenden:

path:src/*.js

• Standardmäßig sind Glob-Ausdrücke nicht am Anfang des Pfads verankert, sodass der obige Ausdruck weiterhin einem Pfad wie entspricht. Wenn Sie dem Ausdruck jedoch das Präfix voranstellen, erfolgt die Verankerung am Anfang. Zum Beispiel:

  path:/src/*.js
  

• Beachte, dass nicht dem Zeichen entspricht, sodass im obigen Beispiel alle Ergebnisse direkte Nachfolger des Verzeichnisses sind. Zum Abgleich innerhalb von Unterverzeichnissen können Sie verwenden, damit die Ergebnisse tief geschachtelte Dateien wie enthalten. Zum Beispiel:

  path:/src/**/*.js
  

Sie können auch das globale Zeichen verwenden. Zum Abgleich des Pfads oder können Sie beispielsweise Folgendes verwenden:

path:*.a?c

Um nach einem Dateinamen zu suchen, der ein Sonderzeichen wie oder enthält, verwende einfach eine Zeichenfolge in Anführungszeichen:

path:"file?"

Glob-Ausdrücke sind für Zeichenfolgen in Anführungszeichen deaktiviert, deshalb gleicht die obige Abfrage nur Pfade ab, die die Literalzeichenfolge enthalten.

Symbol-Qualifizierer

Sie können mit dem Qualifizierer nach Symboldefinitionen im Code suchen, z. B. nach Funktions- oder Klassendefinitionen. Die Symbolsuche basiert auf der Analyse Ihres Codes mithilfe des Open Source Tree-sitter Parser-Ökosystems, sodass keine zusätzliche Einrichtungs- oder Buildtoolintegration erforderlich ist.

So suchen Sie beispielsweise nach einem Symbol namens :

language:go symbol:WithContext

In einigen Sprachen können Sie mithilfe eines Präfixes (z. B. einem Präfix ihres Klassennamens) nach Symbolen suchen. Beispielsweise können Sie für die Methode in einer Struktur vom Typ nach suchen, wenn Sie Go verwenden. In Rust können Sie nach suchen.

Sie können auch reguläre Ausdrücke mit dem Symbolqualifizierer verwenden. Die folgende Abfrage findet z. B. Konvertierungen, die Personen in Rust für den Typ implementiert haben:

language:rust symbol:/^String::to_.*/

Beachte, dass mit diesem Qualifizierer nur nach Definitionen und nicht nach Verweisen gesucht wird und noch nicht alle Symboltypen und Sprachen vollständig unterstützt werden. Die Symbolextraktion wird für die folgenden Sprachen unterstützt:

• Bash
• C
• C#
• C++
• CodeQL
• Elixir
• Go
• JSX
• Java
• JavaScript
• Lua
• PHP
• Protokollpuffer
• Python
• R
• Ruby
• Rust
• Scala
• Starlark
• Swift
• Typescript

Wir arbeiten daran, Unterstützung für weitere Sprachen hinzuzufügen. Wenn Sie zu diesem Aufwand beitragen möchten, können Sie Unterstützung für Ihre Sprache im Open Source Tree-sitter Parser-Ökosystem hinzufügen, auf dem die Symbolsuche basiert.

Inhaltsqualifikator

Standardmäßig durchsuchen reine Begriffe sowohl Pfade als auch Dateiinhalte. Verwende den Qualifizierer , um eine Suche so einzuschränken, dass sie dem Inhalt einer Datei und nicht den Dateipfaden entspricht. Zum Beispiel:

content:README.md

Diese Abfrage würde nur Dateien ermitteln, die den Begriff enthalten, und nicht Dateien namens .

Is-Qualifizierer

Zum Filtern basierend auf Repositoryeigenschaften können Sie den Qualifizierer verwenden. unterstützt die folgenden Werte:

• : beschränkt die Suche auf archivierte Repositorys.
• : beschränkt die Suche auf geforkte Repositories.
• : beschränkt die Suche auf Inhalte, die als Vendor-Inhalte erkannt wurden.
• : beschränkt die Suche auf Inhalte, die als generiert erkannt wurden.

Zum Beispiel:

path:/^MIT.txt$/ is:archived

Beachte, dass der Qualifizierer mit dem -Operator umgekehrt werden kann. Für die Suche nach nicht archivierten Repositorys können Sie Folgendes verwenden:

log4j NOT is:archived

Um Forks aus Ihren Ergebnissen auszuschließen, können Sie folgendermaßen suchen:

log4j NOT is:fork

Verwendung regulärer Ausdrücke

Die Codesuche unterstützt reguläre Ausdrücke, um nach Mustern im Code zu suchen. Sie können reguläre Ausdrücke sowohl in reinen Suchbegriffen als auch in vielen Qualifizierern verwenden, indem Sie den regulären Ausdruck in Schrägstriche setzen.

Um beispielsweise nach dem regulären Ausdruck zu suchen, verwenden Sie Folgendes:

/sparse.*index/

Beachten Sie, dass Sie alle Schrägstriche innerhalb des regulären Ausdrucks mit Escapezeichen versehen müssen. Um beispielsweise nach Dateien im Verzeichnis zu suchen, verwenden Sie Folgendes:

/^App\/src\//

Innerhalb eines regulären Ausdrucks steht für ein Zeilenvorschubzeichen, für eine Registerkarte und kann verwendet werden, um jedes Unicode-Zeichen zu escapen. Dies bedeutet, dass Sie reguläre Ausdrücke verwenden können, um nach exakten Zeichenfolgen zu suchen, die Zeichen enthalten, die Sie nicht in die Suchleiste eingeben können.

Die meisten gängigen Features regulärer Ausdrücke funktionieren in der Codesuche. „Look-around“-Assertionen werden dabei jedoch nicht unterstützt.

Trennen von Suchbegriffen

Alle Teile einer Suche, z. B. Suchbegriffe, genaue Zeichenfolgen, reguläre Ausdrücke, Qualifizierer, Klammern und die booleschen Schlüsselwörter , und , müssen durch Leerzeichen voneinander getrennt werden. Die einzige Ausnahme besteht darin, dass in Klammern gesetzte Elemente, , nicht von den Klammern getrennt werden müssen.

Wenn Ihre Suche mehrere Komponenten enthält, die nicht durch Leerzeichen getrennt sind, oder anderen Text, der nicht den oben aufgeführten Regeln entspricht, versucht die Codesuche zu erraten, was Sie meinen. Sie greift dabei oft darauf zurück, diese Komponente Ihrer Abfrage als den genauen Text zu behandeln, nach dem gesucht werden soll. Die folgende Abfrage ist beispielsweise:

printf("hello world\n");

Bei der Codesuche werden die Klammern und Anführungszeichen nicht als Sonderzeichen interpretiert; stattdessen wird nach Dateien gesucht, die diesen genauen Code enthalten.

Wenn von der Codesuche der falsche Code erraten wird, können Sie immer noch Anführungszeichen und Leerzeichen einsetzen, um die Bedeutung deutlich zu machen.

Groß-/Kleinschreibung

Standardmäßig wird bei der Codesuche die Groß-/Kleinschreibung nicht beachtet, und die Ergebnisse enthalten sowohl Groß- als auch Kleinbuchstaben. Du kannst eine die Groß-/Kleinschreibung beachtende Suche durchführen, indem du einen regulären Ausdruck verwendest und die Nichtbeachtung der Groß-/Kleinschreibung deaktivierst. Um beispielsweise nach der Zeichenfolge „True“ zu suchen, würdest du Folgendes verwenden:

/(?-i)True/