Correction des erreurs de lint

Il est recommandé d’utiliser un linter pour vérifier votre code pour détecter les erreurs potentielles, les violations de style ou les écarts des meilleures pratiques. Les Linters peuvent vous aider à intercepter les bogues tôt, à améliorer la lisibilité de votre code et à garantir la cohérence et la maintenance de votre code.

Exemple de scénario

Vous avez exécuté un linter sur votre code et il a identifié des problèmes qui doivent être corrigés. Plutôt que de les corriger manuellement, vous pouvez demander à Copilot Chat de les corriger pour vous.

Exemples d’invites

• Sélectionnez tout le code dans l'éditeur, puis tapez :

  Fix the lint errors

• Vous pouvez spécifier un ensemble particulier de directives de codage pour un langage, comme PEP8 pour Python :

  Use PEP8 to fix the lint errors

• Si vous avez un fichier local qui définit vos conventions et règles de codage, vous pouvez faire glisser le fichier dans la fenêtre de conversation pour l’ajouter en tant que pièce jointe, puis tapez :

  Use the attached style guide to fix the lint errors

• Vous pouvez également demander à Copilot Chat de corriger uniquement un type spécifique d’erreur de lint :

  Make sure all functions use snake_case naming style

Exemple de réponse

Copilot vous indique ce qui doit être modifié, puis vous donne le code corrigé. Vous devez examiner attentivement le code suggéré avant de l’utiliser. Le code suggéré par Copilot peut ne pas résoudre tous les problèmes identifiés par votre analyseur, c'est pourquoi vous devez toujours réexécuter l'analyseur si vous choisissez d'utiliser le code suggéré.

Les problèmes de linting que Copilot peut vous aider à résoudre sont les suivants :

• Ajout d’importations nécessaires manquantes.
• Suppression des importations qui ne sont pas utilisées dans le code.
• Fractionnement des instructions d’importation en lignes distinctes.
• Utiliser des noms de méthodes et de fonctions qui respectent les règles de style.
• Ajout d’espaces autour des opérateurs.
• Garantir une mise en retrait cohérente.
• Suppression des espaces blancs à la fin du texte.
• Fractionnement de plusieurs instructions qui se trouvent sur une seule ligne en lignes distinctes.
• Rupture d’une longue ligne en plusieurs lignes.
• Suppression des variables inutilisées.
• Ajout ou suppression de lignes vides pour respecter les instructions de style.
• Ajout de docstrings à des fonctions, des classes et des modules.
• Suppression du code qui ne sera jamais exécuté.
• S'assurer que tous les énoncés de retour d'une fonction renvoient une valeur ou n'en renvoient aucune.
• Réduire ou éliminer l'utilisation de variables globales.
• Veiller à ce que les fonctions soient appelées avec le bon nombre et le bon type d'arguments.
• S’assurer que les commentaires sont placés correctement et qu’ils sont significatifs.
• Remplacement des instructions d’impression par une journalisation appropriée.

Pour aller plus loin

• Prompt engineering for GitHub Copilot Chat
• Meilleures pratiques pour l’utilisation de GitHub Copilot