Comment réusiner le code dans des langages modernes grâce à GitLab Duo alimenté par l'IA

S'il vous incombe de moderniser le code base ou le framework en passant à un nouveau langage de programmation, ou si vous avez besoin d'en savoir plus sur les nouvelles fonctionnalités de ce langage, GitLab Duo alimenté par l'IA peut vous prêter main forte. Apprenez à aborder les défis posés par le réusinage du code en adoptant de bonnes pratiques grâce à des exemples tirés des 20 dernières années de ma carrière de codeur.

Les prompts et les exemples de cet article sont illustrés dans différents IDE : VS Code et JetBrains (IntelliJ IDEA, PyCharm et CLion), sur lesquels sont installés les extensions/plugins de GitLab Duo. L'environnement de développement utilise GitLab.com, y compris les mises à jour vers le grand modèle de langage (LLM) Claude 3.5 d'Anthropic pour les suggestions de code de GitLab Duo et GitLab Chat. Pour faire bref : on gagne en puissance et en efficacité.

Vous pouvez lire l'article dans son intégralité ou accéder directement à une section spécifique. Le code source et des Challenges, accompagnés d'exercices, sont également fournis à des fins d'auto-apprentissage.

• Réusiner le code aux normes d'un langage de programmation moderne
  • Générer en Java 7 et réusiner en Java 8
  • Réusiner pour répondre à différentes normes C++
    • Migration : réusiner de la norme C++03 à C++14
    • Retour à une version précédente : réusiner de la norme C++23 à C++11
  • Expliquer et réusiner en COBOL
• Réusiner d'un langage à un autre
  • Réusiner du C en Rust
  • Réusiner du Perl en Python
• Autres exemples pratiques de réusinage
  • Réusiner du JavaScript
  • Réusiner du Bash en ZSH ou SH
  • Autres cas d'utilisation et tutoriels
• Principaux points à retenir

Réusiner le code aux normes d'un langage de programmation moderne

Les sections suivantes illustrent comment réusiner le code. Elles fournissent également des explications sur les différences spécifiques au langage de programmation étudié.

Générer en Java 7 et réusiner en Java 8

Un client voulait savoir si GitLab Duo prend en charge Java 7. Lorsque j'ai testé les suggestions de code et les prompts de GitLab Chat pour générer du code en Java 7, j'ai également pensé à des conseils pour effectuer la migration. Claude 3.5 d'Anthropic est capable de comprendre les différences entre divers langages de programmation, tout comme GitLab Duo.

L'exemple suivant illustre un prompt pour générer du code en Java 7 à l'aide des suggestions de code.

// Generate a new class for a File Manager. Use Java 7 features only.
import java.io.*;
import java.nio.file.*;
import java.util.*;

public class FileManager {
    private Path rootDirectory;

    public FileManager(String rootPath) throws IOException {
        this.rootDirectory = Paths.get(rootPath);
        if (!Files.exists(rootDirectory)) {
            Files.createDirectories(rootDirectory);
        }
    }

    public void createFile(String fileName, String content) throws IOException {
        Path filePath = rootDirectory.resolve(fileName);
        Files.write(filePath, content.getBytes(), StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
    }

    public String readFile(String fileName) throws IOException {
        Path filePath = rootDirectory.resolve(fileName);
        return new String(Files.readAllBytes(filePath));
    }

    public void deleteFile(String fileName) throws IOException {
        Path filePath = rootDirectory.resolve(fileName);
        Files.delete(filePath);
    }

    public List<String> listFiles() throws IOException {
        List<String> fileList = new ArrayList<>();
        try (DirectoryStream<Path> stream = Files.newDirectoryStream(rootDirectory)) {
            for (Path file : stream) {
                fileList.add(file.getFileName().toString());
            }
        }
        return fileList;
    }

    public void copyFile(String sourceFileName, String destinationFileName) throws IOException {
        Path sourcePath = rootDirectory.resolve(sourceFileName);
        Path destinationPath = rootDirectory.resolve(destinationFileName);
        Files.copy(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
    }

    public void moveFile(String sourceFileName, String destinationFileName) throws IOException {
        Path sourcePath = rootDirectory.resolve(sourceFileName);
        Path destinationPath = rootDirectory.resolve(destinationFileName);
        Files.move(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
    }

    public long getFileSize(String fileName) throws IOException {
        Path filePath = rootDirectory.resolve(fileName);
        return Files.size(filePath);
    }

    public boolean fileExists(String fileName) {
        Path filePath = rootDirectory.resolve(fileName);
        return Files.exists(filePath);
    }
}

Vous pouvez poursuivre dans votre IDE en suivant ces étapes :

1. Parcourez et comprenez le code généré : sélectionnez le code dans l'éditeur (en bleu sur la capture d'écran), ouvrez GitLab Duo Chat et envoyez la commande slash /explain comme prompt.

2. Réusinez le code Java 7 en Java 8 : sélectionnez le code dans l'éditeur, ouvrez GitLab Chat et envoyez /refactor using Java 8 features pour affiner le prompt.
3. Si vous ne souhaitez pas réusiner le code, créez un nouveau fichier java8.java et générez du code spécifique en Java 8 à l'aide des suggestions de code en saisissant le prompt // Generate a new class for a File Manager. Use Java 8 features only..
4. Continuez à écrire du code en Java 8 dans le même contexte en vous servant des complétions de code alimentées par l'IA.

Vous pouvez regarder chaque étape dans le vidéo ci-dessous.

Le code source est disponible dans le projet Challenge GitLab Duo - Générer et réusiner du code de Java 7 à 8.

Réusiner pour répondre à différentes normes C++

Fruit d'une longue histoire, la norme C++ peut désormais être considérée comme stable et mature. En fonction de l'architecture et des plateformes cibles, la norme prise en charge dépend du compilateur sur le système d'exploitation hôte.

Au cours de ma carrière, j'ai dû prendre en charge 25 distributions Linux et Windows différentes dans des projets open source. D'après mon expérience, les compilateurs ne prennent pas en charge les fonctionnalités de langage plus récentes et les normes C++ de la même manière. Nous avons adopté les fonctionnalités C++11 en 2015, et n'avons jamais évoqué une migration vers C++14 ou C++17.

Le réusinage des fonctions et des algorithmes pour passer à une nouvelle norme C++ aurait nécessité trop d'efforts, et il aurait fallu recevoir de l'aide pour comprendre les différences. À l'époque, nous faisions nos recherches dans des livres, en ligne, sur Stack Overflow et parfois avec des outils d'aide au réusinage du code.

Les assistants alimentés par l'IA et GitLab Duo ont changé la donne : on a maintenant la possibilité de demander aux suggestions de code et à GitLab Chat de fournir du code source dans une norme C++ spécifique. Il est également possible de comparer les différentes sorties.

L'exemple suivant part d'un prompt pour générer du code source spécifiquement pour la norme C++03. Il implémente un analyseur de configuration simple pour le format de configuration .ini.

/* Create a config parser which can parse an ini format
Use C++03 standard only
 */

#include <iostream>
#include <fstream>
#include <string>
#include <map>
#include <sstream>

class ConfigParser {
private:
    std::map<std::string, std::map<std::string, std::string> > config;

public:
    ConfigParser() {}

    bool parse(const std::string& filename) {
        std::ifstream file(filename.c_str());
        if (!file.is_open()) {
            return false;
        }

        std::string line;
        std::string currentSection;

        while (std::getline(file, line)) {
            // Trim whitespace
            size_t first = line.find_first_not_of(" \t");
            size_t last = line.find_last_not_of(" \t");
            if (first == std::string::npos) continue; // Skip empty lines
            line = line.substr(first, (last - first + 1));

            if (line[0] == '[' && line[line.length() - 1] == ']') {
                // This is a section
                currentSection = line.substr(1, line.length() - 2);
            } else {
                // This is a key-value pair
                size_t delimiterPos = line.find('=');
                if (delimiterPos != std::string::npos) {
                    std::string key = line.substr(0, delimiterPos);
                    std::string value = line.substr(delimiterPos + 1);
                    config[currentSection][key] = value;
                }
            }
        }

        file.close();
        return true;
    }

    std::string getValue(const std::string& section, const std::string& key) const {
        std::map<std::string, std::map<std::string, std::string> >::const_iterator sectionIt = config.find(section);
        if (sectionIt != config.end()) {
            std::map<std::string, std::string>::const_iterator keyIt = sectionIt->second.find(key);
            if (keyIt != sectionIt->second.end()) {
                return keyIt->second;
            }
        }
        return "";
    }

    void printConfig() const {
        std::map<std::string, std::map<std::string, std::string> >::const_iterator sectionIt;
        for (sectionIt = config.begin(); sectionIt != config.end(); ++sectionIt) {
            std::cout << "[" << sectionIt->first << "]" << std::endl;
            std::map<std::string, std::string>::const_iterator keyIt;
            for (keyIt = sectionIt->second.begin(); keyIt != sectionIt->second.end(); ++keyIt) {
                std::cout << keyIt->first << " = " << keyIt->second << std::endl;
            }
            std::cout << std::endl;
        }
    }
};

int main() {
    ConfigParser parser;
    if (parser.parse("config.ini")) {
        std::cout << "Config file parsed successfully." << std::endl;
        parser.printConfig();

        std::cout << "Value of 'key1' in 'section1': " << parser.getValue("section1", "key1") << std::endl;
    } else {
        std::cout << "Failed to parse config file." << std::endl;
    }
    return 0;
}

Les mêmes prompts peuvent être utilisés pour l'explication du code, la génération de tests, ainsi que le réusinage du code: /explain focus on C++03 features, /tests for C++03 features, /refactor into C++03.

Les normes C++ suivantes ont été testées avec les suggestions de code de GitLab Duo :

• C++03
• C++11
• C++14
• C++17
• C++20
• C++23

Vous pouvez trouver le code source dans le projet Challenge - Réusiner l'analyseur de configuration aux normes Cpp.

De nombreuses combinaisons différentes permettent de réusiner le code source pour passer d'une norme C++ à une autre. Les exemples suivants illustrent la modernisation de code en C++ en cas de mise à niveau de la version, mais testent également un retour à une version précédente dans le cas où des développeurs ambitieux qui souhaitaient utiliser C++20 ont dû revenir à C++11 pour prendre en charge les environnements de leurs entreprises clientes.

Migration : réusiner de la norme C++03 à C++14

L'objectif est de moderniser le code et de comprendre les changements entre C++03 et C++14. Ouvrez le code source 03.cpp dans l'IDE, sélectionnez-le et utilisez le prompt suivant pour GitLab Chat :

/refactor into C++14 and explain the changes

Réponse potentielle de GitLab Duo Chat :

…

Explanations of the changes:

1. Default constructor: Changed `ConfigParser() {}` to `ConfigParser() = default;` to use the default constructor.
2. File opening: Removed `.c_str()` when opening the file, as C++11 and later support `std::string` directly.
3. Lambda functions: Introduced a lambda function trim to handle string trimming, making the code more readable and reusable.
4. Auto keyword: Used `auto` for type deduction in various places, improving code readability.
5. Range-based for loops: In the `printConfig` method, replaced traditional for loops with range-based for loops, which are more concise and less error-prone.
6. Structured bindings: Used structured bindings in the range-based for loops to directly access key-value pairs.
7. If statements with initializers: In the `getValue` method, used if statements with initializers to combine the find operation and the check in a single line.
8. String member functions: Used `front()` and `back()` instead of array-style access for the first and last characters of strings.
9. Uniform initialization: Used uniform initialization `{}` instead of parentheses `()` for object creation.
10. Removed `std::endl`: Replaced `std::endl` with `'\n'` for better performance, as `std::endl` forces a flush of the output buffer.

These changes make the code more modern, concise, and potentially more efficient while maintaining the same functionality.

Retour à une version précédente : réusiner de la norme C++23 à C++11

Il peut arriver que des développeurs commencent à implémenter une nouvelle fonctionnalité ou une étude de faisabilité en utilisant une norme C++ moderne, par exemple la norme C++20, mais que les versions réellement prises en charge par les environnements des entreprises clientes nécessitent des compilateurs plus anciens compatibles C++11. Le retour à une version précédente a un coût. Il faut évaluer quelles fonctionnalités du langage sont toujours prises en charge et anticiper les autres inconvénients qui pourraient survenir.

Ouvrez le code source 23.cpp dans l'IDE, sélectionnez-le et saisissez le prompt suivant dans GitLab Duo :

/refactor into C++11, explain the necessary changes and potential problems

Réponse potentielle de GitLab Duo Chat :

The main changes required to make this code compatible with C++11 are:

1. Remove the C++23 standard comment, as it's no longer applicable.
2. Replace `std::string::find_first_not_of` and `std::string::find_last_not_of` with C++11 compatible alternatives in the trim function.
3. Use `const auto&` instead of `auto` for loop variables to avoid unnecessary copying.

Potential problems in the original code:

1. The original code used C++23 features, which might not be widely supported yet.
2. The `trim` function used `std::string::find_first_not_of` and `std::string::find_last_not_of`, which are not available in C++11.
3. The use of `auto` instead of `const auto&` in some loops could lead to unnecessary copying of complex objects.

These issues have been addressed in the refactored version. The `trim` function now uses `std::find_if_not` with lambda functions to achieve the same result in a C++11 compatible way. The use of `const auto&` ensures that no unnecessary copying occurs when iterating over the config map.

Pratique asynchrone: testez d'autres scénarios de réusinage de version.

Expliquer et réusiner en COBOL

Vous pouvez utiliser GitLab Duo pour expliquer le code source, analyser, corriger et réusiner les programmes COBOL. Bien que je n'aie jamais appris ou codé en COBOL, j'ai trouvé ce cours de programmation COBOL et ses nombreux exemples utiles.

J'ai ensuite demandé à GitLab Chat comment démarrer avec COBOL, créer un programme COBOL et compiler un programme COBOL sur macOS.

Please explain what COBOL is and its syntax

Please create a COBOL program that shows the first steps

Tell me more about the COBOL compiler. Which system do I need? Can I do it on my macOS?

Ouvrez un programme COBOL, sélectionnez le code source, passez à GitLab Duo Chat et envoyez le prompt /explain pour expliquer l'objectif et la fonctionnalité.

Vous pouvez également affiner les prompts pour obtenir des résumés plus généraux, par exemple :

/explain like I am five

Conseil : les langages de programmation partagent des algorithmes et des fonctionnalités similaires. GitLab Chat a proposé d'expliquer COBOL en Python. Par conséquent, j'ai ajusté les prompts suivants pour demander une explication en Python.

/explain in a different programming language

Vous pouvez également utiliser la commande slash /refactor comme prompt dans GitLab Chat pour améliorer la qualité du code, résoudre les problèmes potentiels et essayer de réusiner COBOL en Python.

/refactor fix the environment error

/refactor fix potential problems

/refactor into Python

La vidéo GitLab Duo Coffee Chat - Challenge : expliquer et réusiner des programmes COBOL montre toutes les étapes abordées dans un cas d'utilisation pratique. Elle illustre notamment comment trouver une période manquante :

Réusiner d'un langage à un autre

La modernisation et l'amélioration de la qualité du code nécessitent parfois de changer de langage de programmation. Des prompts de réusinage similaires dans GitLab Duo peuvent accélérer le processus de migration. L'exemple de COBOL avec Python n'est qu'une des nombreuses exigences en vigueur dans les environnements d'entreprise. Examinons d'autres cas d'utilisation.

Réusiner du C en Rust

Au début de 2024, plusieurs langages de programmation, comme C, ont été accusés de ne pas être à mémoire sécurisée. Les recommandations pour les projets futurs comprennent l'utilisation de langages à mémoire sécurisée comme Rust. Comment démarrer la migration et quels sont les défis à relever ?

Essayons avec un exemple simple en C. Le code a été généré à l'aide des suggestions de code et devrait contenir les informations de base sur le système d'exploitation, comme le nom, la version et la plateforme. Le code C dispose d'une compatibilité multiplateforme sur Windows, Linux et macOS pour la compilation.

// Read OS files to identify the platform, name, versions
// Print them on the terminal
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#ifdef _WIN32
    #include <windows.h>
#elif __APPLE__
    #include <sys/utsname.h>
#else
    #include <sys/utsname.h>
#endif

void get_os_info() {
    #ifdef _WIN32
        OSVERSIONINFOEX info;
        ZeroMemory(&info, sizeof(OSVERSIONINFOEX));
        info.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
        GetVersionEx((OSVERSIONINFO*)&info);

        printf("Platform: Windows\n");
        printf("Version: %d.%d\n", info.dwMajorVersion, info.dwMinorVersion);
        printf("Build: %d\n", info.dwBuildNumber);
    #elif __APPLE__
        struct utsname sys_info;
        uname(&sys_info);

        printf("Platform: macOS\n");
        printf("Name: %s\n", sys_info.sysname);
        printf("Version: %s\n", sys_info.release);
    #else
        struct utsname sys_info;
        uname(&sys_info);

        printf("Platform: %s\n", sys_info.sysname);
        printf("Name: %s\n", sys_info.nodename);
        printf("Version: %s\n", sys_info.release);
    #endif
}

int main() {
    get_os_info();
    return 0;
}

Ouvrez le code source dans os.c dans JetBrains CLion, par exemple. Sélectionnez le code source et saisissez le prompt /explain dans GitLab Chat pour expliquer l'objectif et la fonctionnalité. Entrez ensuite le prompt /refactor dans GitLab Chat pour réusiner le code C, puis poursuivez avec : /refactor into Rust.

Initialisez un nouveau projet Rust (astuce : demandez à GitLab Duo Chat) et copiez le code source généré dans le fichier src/main.rs. Exécutez cargo build pour compiler le code.

Vous pouvez voir toutes les étapes dans la vidéo GitLab Duo Coffee Chat : Challenge - Réusiner du C en Rust. Vous verrez en outre une erreur de compilation qui sera corrigée à l'aide de GitLab Chat et de la commande slash /refactor. La session montre également comment améliorer la maintenabilité du nouveau code Rust en renforçant la gestion des erreurs.

Réusiner du Perl en Python

Un script opérationnel tourne sur des serveurs de production. Son auteur a quitté l'entreprise il y a dix ans et personne ne veut y toucher. Ce problème ne concerne peut-être pas qu'un seul script, mais peut-être plusieurs scripts, voire une application entière. Il a été décidé de tout migrer vers Python 3, dans le but de moderniser le code et de comprendre les changements entre Perl et Python.

Récemment, au cours d'un atelier GitLab Duo, un client a demandé s'il était possible d'effectuer une migration directe avec GitLab Duo. En un mot, la réponse est : oui. Pour clarifier : vous pouvez saisir des prompts plus spécifiques dans GitLab Chat pour réusiner le code Perl en Python, comme dans d'autres exemples de cet article.

Ouvrez le code source script.pl dans l'IDE, sélectionnez-le et ouvrez GitLab Chat.

#!/usr/bin/perl
use strict;
use warnings;

open my $md_fh, '<', 'file.md' or die "Could not open file.md: $!";

my $l = 0;
my $e = 0;
my $h = 0;

while (my $line = <$md_fh>) {
  $l++;
  if ($line =~ /^\s*$/) {
    $e++;
    next;
  }
  if ($line =~ /^#+\s*(.+)/) {
    print "$1\n";
    $h++; 
  }
}

print "\nS:\n"; 
print "L: $l\n";
print "E: $e\n"; 
print "H: $h\n";

You can use the following prompts to:

1. /explain its purpose, and /refactor to improve the code.
2. /refactor into Python pour obtenir un script Python fonctionnel.

Astuce : vous pouvez réusiner le code Perl dans d'autres langages cibles. La vidéo GitLab Duo Coffee Chat : Challenge - Réusiner du Perl en Python fournit des exemples avec PHP, Ruby, Rust, Go, Java, VB.NET, C# et d'autres langages.

Si vous souhaitez continuer à utiliser des scripts Perl, vous pouvez configurer Perl comme langage supplémentaire en vous servant des suggestions de code de GitLab Duo. GitLab Chat comprend déjà Perl et peut vous aider si vous utilisez des questions et des prompts de commande slash, comme vous pouvez le voir dans la vidéo ci-dessous.

Autres exemples pratiques de réusinage

Réusiner du JavaScript

Eddie Jaoude montre dans un exemple pratique comment réusiner du code JavaScript pour améliorer sa qualité ou ajouter des fonctionnalités.

Réusiner du Bash en ZSH ou SH

J'utilise Bash comme shell depuis 20 ans et je suis récemment passé à ZSH sur macOS. À cause de ce changement, mon script ne fonctionnait pas et mon terminal affichait des erreurs inconnues. Les limitations du shell sont un autre cas d'utilisation. Elles justifient également le réusinage : certains systèmes d'exploitation ou distributions Linux/Unix ne fournissent pas Bash, mais uniquement SH, par exemple Alpine.

Le GitLab Duo Coffee Chat : Challenge - Réusiner des scripts shell fournit un exemple avec un programme C qui peut suivre les fichiers syslog et un script de compilation écrit en Bash. Tout au long du Challenge, GitLab Chat reçoit des requêtes avec des prompts /explain et /refactor pour améliorer le code. Il est également possible de réusiner du Bash en SH ou ZSH pour assurer la conformité à POSIX. À la fin de la session, GitLab Chat doit fournir cinq implémentations de scripts shell différentes et expliquer les principaux résumés.

Autres cas d'utilisation et tutoriels

• Documentation : cas d'utilisation de GitLab Duo
• Tutoriel : meilleurs conseils pour obtenir des suggestions de code alimentées par l'IA efficaces avec GitLab Duo
• Tutoriel : 10 bonnes pratiques pour utiliser GitLab Duo Chat alimenté par l'IA

Principaux points à retenir

1. GitLab Duo fournit une aide efficace pour expliquer et réusiner le code.
2. Il est possible de réusiner le code pour l'adapter aux normes de différents langages et poser des questions de suivi dans GitLab Chat.
3. Les prompts de suggestion de code peuvent générer des normes spécifiques à des langages de programmation, et la complétion de code respecte le contexte du code actuel.
4. Le réusinage du code dans de nouveaux langages de programmation contribue aux plans de migration et de modernisation à long terme.
5. Le code peut être « rétrogradé » à une version précédente lorsque les normes d'un langage sont prises en charge par un ancien système.
6. GitLab Duo peut expliquer du code complexe et des langages de programmation avec différents exemples de langages de programmation.
7. La mise à jour vers Claude 3.5 d'Anthropic sur GitLab.com a amélioré une fois de plus la qualité et la rapidité des suggestions de code et de GitLab Chat (il est recommandé de mettre à niveau GitLab Auto-géré vers la version 17.3).
8. Votre seule limite : votre imagination et les points de friction en production.

Apprenez-en plus sur les suggestions de code et les workflows efficaces de GitLab Chat, et commencez à réusiner du code alimenté par l'IA avec GitLab Duo dès aujourd'hui !

Commencez votre essai gratuit de 60 jours de GitLab Duo !