Meilleures pratiques Github Copilot : de bon à excellent

DEV - 28/01
Table des matières Introduction Partie 1 : Fondamentaux 1.1 Le contexte est tout 1.2...

Table des matières

  • Introduction
  • Partie 1 : Fondamentaux
    • 1.1 Le contexte est primordial
    • 1.2 Éléments essentiels de l'ingénierie rapide
    • 1.3 Chat et complétions en ligne
  • Partie 2 : Optimisation du flux de travail quotidien
    • 2.1 Raccourcis et astuces rapides
    • 2.2 Instructions personnalisées
  • Partie 3 : Sécurité et qualité
    • 3.1 Ne comptez pas trop
    • 3.2 Toujours examiner les requêtes paramétrées
    • 3.3 Vérifier que la validation d'entrée existe
    • 3.4 Assurer une gestion appropriée des erreurs
    • 3.5 Vérifier que les secrets proviennent de variables d'environnement
    • 3.6 Mauvaise gestion du contexte
  • Résumé

Introduction

Ce guide suppose que vous connaissez déjà les bases : vous avez installé Copilot, comprenez l'onglet pour accepter et vous avez vu les complétions en ligne en action. Il est maintenant temps de passer au niveau supérieur. Nous explorerons les techniques qui transforment Copilot d'un simple outil de saisie semi-automatique en un partenaire de programmation en binôme utile. Nous examinerons quelques exemples de code pour démontrer les fonctionnalités. Clonez le référentiel git suivant et ouvrez-le dans n'importe quel IDE pris en charge par copilot.

git clone [email protected]:anjithp/ai-code-assistant-demo.git
Entrer en mode plein écran Quitter le mode plein écran

Partie 1 : Fondamentaux

1.1 Le contexte est primordial

Le facteur le plus important pour obtenir des suggestions de qualité de Copilot ne sont pas vos invites : c'est votre contexte. Copilot peut traiter tous les fichiers ouverts dans votre IDE pour comprendre vos modèles de base de code.

Ce que cela signifie en pratique :

Lorsque vous travaillez sur une fonctionnalité, ouvrez tous les fichiers pertinents. Par exemple, si vous créez un nouveau composant React qui récupère les tâches d'une API, ouvrez :

  • Le fichier de composant que vous créez
  • Le fichier du service API
  • Le fichier de types TypeScript
  • Un composant similaire existant comme référence

Que fermer :

Fermez les fichiers qui ne sont pas pertinents pour votre tâche actuelle. Si vous avez 20 onglets ouverts lors de la session de débogage d'hier, l'attention de Copilot est diluée dans un contexte non pertinent. Chaque fichier ouvert consomme la fenêtre contextuelle limitée de Copilot.

Exemple : Création d'un service de tâches

Disons que vous devez créer une nouvelle méthode de service dans notre exemple de projet. Voici comment le contexte change le résultat :

Mauvais contexte (seulementtâcheService.tsouvrir):

// Copilot peut suggérer un export de code CRUD générique const getTaskById = async (id: number) => { // Suggestion générique sans vos modèles }
Entrer en mode plein écran Quitter le mode plein écran

Contexte riche (ouverttâcheService.ts,Tâche.tsmodèle,Catégorie.tsmodèle et service similaire existant) :

// Copilot suggère du code correspondant à vos modèles exacts export const getTaskById = async (id: number) => { return wait Task.findByPk(id, { include: [ { model: Category, as: 'category', attributs: ['id', 'name', 'color'] } ] }); } ;
Entrer en mode plein écran Quitter le mode plein écran

La deuxième suggestion correspond aux modèles Sequelize de votre projet, inclut la relation que vous chargez toujours et suit vos conventions de dénomination : tout cela parce que Copilot avait le bon contexte.

1.2 Éléments essentiels de l'ingénierie rapide

Après le contexte, la deuxième chose la plus importante pour obtenir de bons résultats sont les invites. ...
[Courte citation de 8% de l'article original]