MarkyAI markdownGenerator

MarkyAI - Générateur de démarques (extension de code VS)

J'ai étendu Pipet-code-agent pour créer un assistant de code IA en ajoutant une nouvelle fonctionnalité/commande pour générer des documents GitHub README bien formatés dans Markdown en fonction d'extraits de code sélectionnés. Pipet Code Agent est une extension Visual Studio Code développée par Google qui exploite la puissance de l'API Google Gemini pour aider les développeurs en générant des commentaires et des critiques pour le code sélectionné.

Caractéristiques

• Commentaires de révision de code : générez automatiquement des commentaires de révision de code qui identifient les bogues et suggèrent des améliorations.
• Commentaires de code : ajoutez des commentaires explicatifs à votre code.
• Générateur README Markdown : générez des documents README GitHub complets au format Markdown en fonction du code sélectionné.

Nouvelle commande : générateur README Markdown

La nouvelle commande ajoutée à cette extension vous permet de générer un document GitHub README bien structuré dans Markdown basé sur le code sélectionné dans l'éditeur. Le README comprend des en-têtes, des descriptions, des exemples de code et d'autres formats Markdown pertinents.

Exemple d'utilisation

1. Installer l'extension de l'agent Pipet Code

   L'extension n'étant pas encore publiée sur VS Code Marketplace, vous pouvez la tester localement en suivant ces étapes :

   • Clonez ou téléchargez ce référentiel.
   • Accédez au répertoire du projet dans votre terminal.

2. Installer les dépendances

   Installez les dépendances Node.js requises à l'aide de npm.

   npm install

3. Exécutez l'extension en mode débogage

   Ouvrez le projet dans Visual Studio Code et démarrez le débogage pour exécuter l'extension dans une fenêtre hôte de développement d'extension.

   npm run vscode:prepublish

4. Configurer la clé API

   Configurez votre clé API Google Gemini dans les paramètres VS Code.

    // settings.json
   {
       "google.gemini.apiKey" : " your-api-key-here "
   }

5. Utilisez la commande du générateur Markdown README

   • Sélectionnez l'extrait de code dans votre éditeur que vous souhaitez documenter.
   • Ouvrez la palette de commandes ( Ctrl+Shift+P ou Cmd+Shift+P ).
   • Tapez Pipet: Create README from Selected Text et sélectionnez la commande.

6. Exemple README généré

   Voici un exemple de README généré basé sur un extrait de code sélectionné :

    # API Key Loader
   
   This script attempts to load the API key from the environment.
   
   ## Features
   - Securely load API keys
   - Easy to integrate
   
   ## Example Usage
   
   ``` python
   api_key = os.getenv( " GOOGLE_API_KEY " )

Contribuer

Les contributions à cette extension sont les bienvenues ! Si vous avez des suggestions d'améliorations ou de nouvelles fonctionnalités, n'hésitez pas à ouvrir un ticket ou à créer une pull request sur le référentiel GitHub de Pipet Markdown Agent.

Licence

Ce projet est sous licence Apache 2.0.

---