# Présentation de la syntaxe de recherche de code GitHub Vous pouvez créer des requêtes de recherche pour les résultats souhaités à l’aide de qualificateurs de code spécialisés, d’expressions régulières et d’opérations booléennes. ## À propos de la structure des requêtes de la recherche de code La syntaxe de recherche de cet article s’applique uniquement à la recherche de code avec la recherche de code GitHub. Notez que la syntaxe et les qualificateurs pour rechercher du contenu autre que du code, comme les problèmes, les utilisateurs et les discussions, est différente de la syntaxe pour rechercher du code. Pour plus d’informations sur la recherche sans code, consultez [À propos de la recherche sur GitHub](/fr/search-github/getting-started-with-searching-on-github/about-searching-on-github) et [Recherche sur GitHub](/fr/search-github/searching-on-github). Les requêtes de recherche se composent de termes de recherche, notamment du texte à rechercher et de qualificateurs, qui permettent d’affiner la recherche. Un terme utilisé en l’état, sans qualificateur, est recherché dans le contenu ou le chemin d’un fichier. Par exemple, dans la requête qui suit : ```text http-push ``` La requête ci-dessus va rechercher le fichier `docs/http-push.txt`, même s’il ne contient pas le terme `http-push`. Elle va également rechercher un fichier nommé `example.txt`, s’il contient le terme `http-push`. Vous pouvez entrer plusieurs termes séparés par des espaces blancs pour rechercher les documents qui correspondent aux deux termes. Par exemple, dans la requête qui suit : ```text sparse index ``` Les résultats de la recherche incluent tous les documents contenant les termes `sparse` et `index`, dans n’importe quel ordre. Par exemple, la requête va rechercher un fichier contenant `SparseIndexVector`, un fichier avec l’expression `index for sparse trees` et même un fichier nommé `index.txt` contenant le terme `sparse`. La recherche de plusieurs termes séparés par des espaces blancs équivaut à la recherche `hello AND world`. D’autres opérations booléennes, comme `hello OR world`, sont également prises en charge. Pour plus d’informations sur les opérations booléennes, consultez [Utilisation des opérations booléennes](#using-boolean-operations). La recherche de code prend également en charge la recherche d’une chaîne exacte ainsi que les espaces blancs. Pour plus d’informations, consultez [Rechercher une correspondance exacte](#query-for-an-exact-match). Vous pouvez affiner votre recherche de code à l’aide de qualificateurs spécialisés, par exemple `repo:`, `language:` et `path:`. Pour plus d’informations sur les qualificateurs que vous pouvez utiliser dans la recherche de code, consultez [Utilisation de qualificateurs](#using-qualifiers). Vous pouvez également utiliser des expressions régulières dans vos recherches en plaçant ces expressions entre barres obliques. Pour plus d’informations sur l’utilisation des expressions régulières, consultez [Utilisation d’expressions régulières](#using-regular-expressions). ## Rechercher une correspondance exacte Pour rechercher une chaîne exacte, notamment des espaces blancs, vous pouvez placer la chaîne entre guillemets. Voici un exemple : ```text "sparse index" ``` Vous pouvez également utiliser des chaînes entre guillemets dans les qualificateurs, par exemple : ```text path:git language:"protocol buffers" ``` ## Recherche de guillemets et de barres obliques inverses Pour rechercher du code contenant un guillemet, vous pouvez utiliser la barre oblique inverse en tant que caractère d’échappement devant le guillemet. Par exemple, pour trouver la chaîne exacte `name = "tensorflow"`, vous pouvez effectuer la recherche suivante : ```text "name = \"tensorflow\"" ``` Pour rechercher du code contenant une barre oblique inverse, `\`, utilisez une double barre oblique inverse, `\\`. Les deux séquences d’échappement `\\` et `\"` peuvent également être utilisées en dehors des guillemets. Cependant, aucune autre séquence d’échappement n’est reconnue. Une barre oblique inverse qui n’est pas suivie de `"` ou de `\` est incluse dans la recherche, sans modification. Des séquences d’échappement supplémentaires, telles que `\n` qui correspond à un caractère de nouvelle ligne, sont prises en charge dans les expressions régulières. Voir [Utilisation des expressions régulières](#using-regular-expressions) ## Utilisation d’opérations booléennes La recherche de code prend en charge les expressions booléennes. Vous pouvez utiliser les opérateurs `AND`, `OR` et `NOT` pour combiner les termes de recherche. Par défaut, les termes adjacents séparés par des espaces blancs équivalent à l’utilisation de l’opérateur `AND`. Par exemple, la requête de recherche `sparse index` est identique à `sparse AND index`, ce qui signifie que les résultats de la recherche vont inclure tous les documents contenant les termes `sparse` et `index`, dans n’importe quel ordre. Pour rechercher des documents contenant l’un ou l’autre de ces termes, vous pouvez utiliser l’opérateur `OR`. Par exemple, la requête suivante recherche les documents contenant `sparse` ou `index` : ```text sparse OR index ``` Pour exclure des fichiers des résultats de la recherche, vous pouvez utiliser l’opérateur `NOT`. Par exemple, pour exclure des fichiers du répertoire `__testing__`, vous pouvez effectuer la recherche suivante : ```text "fatal error" NOT path:__testing__ ``` Vous pouvez utiliser des parenthèses pour exprimer des expressions booléennes plus complexes. Voici un exemple : ```text (language:ruby OR language:python) AND NOT path:"/tests/" ``` ## Utilisation de qualificateurs Vous pouvez utiliser des mots clés spécialisés pour qualifier votre recherche. * [Qualificateur de dépôt](#repository-qualifier) * [Qualificateurs d’organisation et d’utilisateur](#organization-and-user-qualifiers) * [Identifiant d’entreprise](#enterprise-qualifier) * [Qualificateur de langage](#language-qualifier) * ``` [Qualificateur de licence](#license-qualifier) ``` * [Qualificateur de chemin](#path-qualifier) * [Qualificateur de symbole](#symbol-qualifier) * [Qualificateur de contenu](#content-qualifier) * [Qualificateur is](#is-qualifier) ### Qualificateur de dépôt Pour effectuer une recherche dans un dépôt, utilisez le qualificateur `repo:`. Vous devez fournir le nom complet du dépôt en indiquant également son propriétaire. Voici un exemple : ```text repo:github-linguist/linguist ``` Pour effectuer une recherche dans un ensemble de dépôts, vous pouvez combiner plusieurs qualificateurs `repo:` avec l’opérateur booléen `OR`. Voici un exemple : ```text repo:github-linguist/linguist OR repo:tree-sitter/tree-sitter ``` > \[!NOTE] > La recherche de code ne prend pas en charge les expressions régulières ou la correspondance partielle pour les noms de dépôts. Vous devez donc taper le nom complet du dépôt (en indiquant également le préfixe utilisateur) pour que le qualificateur `repo:` fonctionne. ### Qualificateurs d’organisation et d’utilisateur Pour rechercher des fichiers dans une organisation, utilisez le qualificateur `org:`. Voici un exemple : ```text org:github ``` Pour rechercher des fichiers dans un compte personnel, utilisez le qualificateur `user:`. Voici un exemple : ```text user:octocat ``` > \[!NOTE] > La recherche de code ne prend pas en charge les expressions régulières ou la correspondance partielle pour les noms d’organisations ou d’utilisateurs. Vous devez donc taper le nom d’organisation ou le nom d’utilisateur complet pour que le qualificateur fonctionne. ### Identifiant d’entreprise Pour rechercher des fichiers au sein d’une entreprise, utilisez le `enterprise:` qualificateur. Voici un exemple : ```text enterprise:octocorp ``` Cette opération recherche les référentiels appartenant aux organisations de l’entreprise `octocorp` . Les référentiels appartenant à l’utilisateur ne sont pas inclus. ### Qualificateur de langage Pour limiter à une langue spécifique, utilisez le `language:` qualificateur. Voici un exemple : ```text language:ruby OR language:cpp OR language:csharp ``` Pour obtenir la liste complète des noms de langages pris en charge, consultez [languages.yaml](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml) dans [github-linguist/linguist](https://github.com/github-linguist/linguist). Si le langage souhaité ne figure pas dans la liste, vous pouvez ouvrir une demande de tirage (pull request) pour l’ajouter. ### Qualificateur de licence Pour filtrer les référentiels en fonction de leur licence ou de leur famille de licences, utilisez le qualificateur et le `license:` mot clé de licence exact, par exemple `Apache-2.0`, . `CC``MIT` ```text license:MIT ``` Consultez [Gestion des licences d’un référentiel](/fr/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type) pour obtenir la liste des mots clés de licence. ### Qualificateur de chemin Pour effectuer une recherche dans les chemins de fichiers, utilisez le qualificateur `path:`. Cela permet de rechercher les fichiers contenant le terme n’importe où dans leur chemin. Par exemple, pour rechercher les fichiers contenant le terme `unit_tests` dans leur chemin, utilisez : ```text path:unit_tests ``` La requête ci-dessus trouve `src/unit_tests/my_test.py` et `src/docs/unit_tests.md`, car ils contiennent tous les deux `unit_test` dans leur chemin. Pour chercher uniquement un nom de fichier spécifique (et non une partie du chemin), vous pouvez utiliser une expression régulière : ```text path:/(^|\/)README\.md$/ ``` Notez que le `.` dans le nom de fichier fait l’objet d’une séquence d’échappement, car `.` a une signification particulière pour les expressions régulières. Pour plus d’informations sur l’utilisation des expressions régulières, consultez [Utilisation d’expressions régulières](#using-regular-expressions).
Vous pouvez également utiliser certaines expressions Glob limitées dans le qualificateur `path:`. Par exemple, pour rechercher des fichiers ayant l’extension `txt`, vous pouvez utiliser : ```text path:*.txt ```
Pour rechercher des fichiers JavaScript dans un répertoire `src`, vous pouvez utiliser : ```text path:src/*.js ``` * Par défaut, les expressions Glob ne sont pas ancrées au début du chemin. Ainsi, l’expression ci-dessus recherche toujours un chemin tel que `app/src/main.js`. Toutefois, si vous faites précéder l’expression de `/`, elle est ancrée au début. Voici un exemple : ```text path:/src/*.js ``` * Notez que `*` ne correspond pas au caractère `/`. Ainsi, pour l’exemple ci-dessus, tous les résultats sont des descendants directs du répertoire `src`. Pour rechercher des correspondances dans des sous-répertoires, afin que les résultats incluent des fichiers profondément imbriqués tels que `/src/app/testing/utils/example.js`, vous pouvez utiliser `**`. Voici un exemple : ```text path:/src/**/*.js ```
Vous pouvez également utiliser le caractère global `?`. Par exemple, pour rechercher le chemin `file.aac` ou `file.abc`, vous pouvez utiliser : ```text path:*.a?c ```
Pour rechercher un nom de fichier qui contient un caractère spécial tel que `*` ou `?`, utilisez simplement une chaîne entre guillemets : ```text path:"file?" ``` Les expressions Glob sont désactivées pour les chaînes entre guillemets, la requête ci-dessus recherche donc uniquement les chemins contenant la chaîne littérale `file?`. ### Qualificateur de symbole Vous pouvez rechercher des définitions de symboles dans le code, par exemple des définitions de fonctions ou de classes, à l’aide du qualificateur `symbol:`. La recherche de symboles est basée sur l’analyse de votre code à l’aide de l’écosystème open source [Tree-sitter](https://github.com/tree-sitter) de l’analyseur. Par conséquent, aucune installation supplémentaire ni intégration de l’outil de génération n’est requise. Par exemple, pour rechercher un symbole appelé `WithContext` : ```text language:go symbol:WithContext ``` Dans certains langages, vous pouvez rechercher des symboles à l’aide d’un préfixe (par exemple le préfixe de leur nom de classe). Par exemple, pour une méthode `deleteRows` sur un struct `Maint`, vous pouvez rechercher `symbol:Maint.deleteRows` en Go, ou `symbol:Maint::deleteRows` en Rust. Vous pouvez également utiliser des expressions régulières avec le qualificateur de symbole. Par exemple, la requête suivante permet de trouver les conversions que des utilisateurs ont implémentées en Rust pour le type `String` : ```text language:rust symbol:/^String::to_.*/ ``` Notez que ce qualificateur recherche uniquement les définitions et non les références. De plus, tous les types de symbole et tous les langages ne sont pas encore complètement pris en charge. L’extraction de symboles est prise en charge pour les langages suivants : * Bash * C * C# * C++ * CodeQL * Elixir * Go * JSX * Java * JavaScript * Lua * PHP * Mémoires tampon de protocole * Python * R * Ruby * Rust * Scala * Starlark * Swift * Typescript Nous travaillons à la prise en charge d’un plus grand nombre de langages. Si vous souhaitez contribuer à cet effort, vous pouvez ajouter la prise en charge de votre langue dans le open source [Tree-sitter](https://github.com/tree-sitter) écosystème d’analyseur, sur lequel la recherche de symboles est basée. ### Qualificateur de contenu Par défaut, les termes utilisés en l’état sont recherchés à la fois dans les chemins et les contenus des fichiers. Pour restreindre une recherche afin qu’elle corresponde strictement au contenu d’un fichier et non aux chemins de fichiers, utilisez le qualificateur `content:`. Voici un exemple : ```text content:README.md ``` Cette requête recherche uniquement les fichiers contenant le terme `README.md` et non les fichiers nommés `README.md`. ### Qualificateur is Pour effectuer un filtrage en fonction des propriétés du dépôt, vous pouvez utiliser le qualificateur `is:`. `is:` prend en charge les valeurs suivantes : * `archived` : restreint la recherche aux dépôts archivés. * `fork` : restreint la recherche aux dépôts dupliqués. * `vendored` : restreint la recherche au contenu détecté comme fourni. * `generated` : restreint la recherche au contenu détecté comme généré. Voici un exemple : ```text path:/^MIT.txt$/ is:archived ``` Notez que le qualificateur `is:` peut être inversé par rapport à l’opérateur `NOT`. Pour rechercher des dépôts non archivés, vous pouvez effectuer la recherche suivante : ```text log4j NOT is:archived ``` Pour exclure les duplications de vos résultats, vous pouvez rechercher : ```text log4j NOT is:fork ``` ## Utilisation d’expressions régulières La recherche de code prend en charge les expressions régulières pour la recherche de modèles dans votre code. Vous pouvez employer des expressions régulières dans les termes de recherche utilisés en l’état ainsi que dans de nombreux qualificateurs, en plaçant ces regex entre barres obliques. Par exemple, pour rechercher l’expression régulière `sparse.*index`, vous devez utiliser : ```text /sparse.*index/ ``` Notez que les barres obliques utilisées de manière littérale doivent faire l’objet de séquences d’échappement au sein de l’expression régulière. Par exemple, pour rechercher des fichiers dans le répertoire `App/src`, vous devez utiliser : ```text /^App\/src\// ``` À l’intérieur d’une expression régulière, `\n` représente un caractère de nouvelle ligne, `\t` représente une tabulation et `\x{hhhh}` peut être utilisé pour échapper n’importe quel caractère Unicode. Cela signifie que vous pouvez utiliser des expressions régulières pour rechercher des chaînes exactes qui contiennent des caractères que vous ne pouvez pas saisir dans la barre de recherche. Les fonctionnalités les plus courantes des expressions régulières fonctionnent dans la recherche de code. Toutefois, les assertions « look-around » ne sont pas prises en charge. ## Séparation des termes de recherche Toutes les parties d’une recherche, telles que les termes de recherche, les chaînes exactes, les expressions régulières, les qualificateurs, les parenthèses et les mot clé booléens `AND`, `OR` et `NOT`, doivent être séparées les unes des autres par des espaces. La seule exception concerne les éléments entre parenthèses, `(``)`, qui n’ont pas besoin d’être séparés des parenthèses. Si votre recherche contient plusieurs composants qui ne sont pas séparés par des espaces ou d’autre texte qui ne suit pas les règles énumérées ci-dessus, la recherche de code essaie de deviner ce que vous voulez dire. Elle se contente souvent de traiter ce composant de votre requête comme s'il s'agissait du texte exact à rechercher. Par exemple, dans la requête qui suit : ```text printf("hello world\n"); ``` La recherche de code renoncera à interpréter les parenthèses et les guillemets comme des caractères spéciaux et recherchera plutôt les fichiers contenant ce code exact. Si la recherche de code est incorrecte, vous pouvez toujours effectuer la recherche souhaitée en utilisant des guillemets et des espaces pour en clarifier le sens. ## Sensibilité à la casse Par défaut, la recherche de code ne respecte pas la casse et les résultats incluront dont à la fois les majuscules et les minuscules. Vous pouvez effectuer des recherches sensibles à la casse à l’aide d’une expression régulière en désactivant le non-respect de la casse. Par exemple, pour rechercher la chaîne « True », vous devez utiliser : ```text /(?-i)True/ ```