Feature: Update kiota vs code extension

scripts/execute-vscode-sideload.ps1

@@ -0,0 +1,36 @@
+param (
+    [string]
+    [Parameter(Mandatory = $false)]
+    $Platform = "win-x64",
+    [switch]
+    $WSL
+)
+
+
+Push-Location ./vscode/microsoft-kiota
+
+# Install all dependencies
+npm i
+
+# Package the VS Code extension
+npx @vscode/vsce package
+
+# Getting package for its version
+$PackageJson = Get-Content "package.json" -Raw | ConvertFrom-Json
+
+# Install the extension
+code --install-extension "./kiota-$($PackageJson.version).vsix"
+
+$VsCodeRootPath = "~/.vscode"
+
+if ($WSL) {
+    $Platform = "linux-x64"
+    $VsCodeRootPath = "~/.vscode-server"
+}
+
+$KiotaBin = "$VsCodeRootPath/extensions/ms-graph.kiota-$($PackageJson.version)/.kiotabin/$($PackageJson.kiotaVersion)/$Platform"
+
+Pop-Location
+
+# Building Kiota
+dotnet publish ./src/kiota/kiota.csproj -p:PublishSingleFile=true -p:PublishReadyToRun=true --self-contained -c Release -r $platform -o $KiotaBin

src/kiota/Rpc/IServer.cs

@@ -10,7 +10,7 @@
     Task<SearchOperationResult> SearchAsync(string searchTerm, bool clearCache, CancellationToken cancellationToken);
     Task<ShowResult> ShowAsync(string descriptionPath, string[] includeFilters, string[] excludeFilters, bool clearCache, CancellationToken cancellationToken);
     Task<ManifestResult> GetManifestDetailsAsync(string manifestPath, string apiIdentifier, bool clearCache, CancellationToken cancellationToken);
-    Task<List<LogEntry>> GenerateAsync(string openAPIFilePath, string outputPath, GenerationLanguage language, string[] includePatterns, string[] excludePatterns, string clientClassName, string clientNamespaceName, bool usesBackingStore, bool cleanOutput, bool clearCache, bool excludeBackwardCompatible, string[] disabledValidationRules, string[] serializers, string[] deserializers, string[] structuredMimeTypes, bool includeAdditionalData, CancellationToken cancellationToken);
+    Task<List<LogEntry>> GenerateAsync(string openAPIFilePath, string outputPath, GenerationLanguage language, string[] includePatterns, string[] excludePatterns, string clientClassName, string clientNamespaceName, bool usesBackingStore, bool cleanOutput, bool clearCache, bool excludeBackwardCompatible, string[] disabledValidationRules, string[] serializers, string[] deserializers, string[] structuredMimeTypes, bool includeAdditionalData, ConsumerOperation operation, CancellationToken cancellationToken);
     Task<LanguagesInformation> InfoForDescriptionAsync(string descriptionPath, bool clearCache, CancellationToken cancellationToken);
-    Task<List<LogEntry>> GeneratePluginAsync(string openAPIFilePath, string outputPath, PluginType[] pluginTypes, string[] includePatterns, string[] excludePatterns, string clientClassName, bool cleanOutput, bool clearCache, string[] disabledValidationRules, CancellationToken cancellationToken);
+    Task<List<LogEntry>> GeneratePluginAsync(string openAPIFilePath, string outputPath, PluginType[] pluginTypes, string[] includePatterns, string[] excludePatterns, string clientClassName, bool cleanOutput, bool clearCache, string[] disabledValidationRules, ConsumerOperation operation, CancellationToken cancellationToken);
 }

src/kiota/Rpc/Server.cs

@@ -68,12 +68,12 @@
             _ = await Task.WhenAll(configurations
                                     .Select(x => GenerateClientAsync(x, logger, cancellationToken)));
             foreach (var (lockInfo, lockDirectoryPath) in locks)
                 logger.LogInformation("Update of {clientClassName} client for {language} at {lockDirectoryPath} completed", lockInfo?.ClientClassName, lockInfo?.Language, lockDirectoryPath);
             logger.LogInformation("Update of {length} clients completed successfully", locks.Length);
         }
         catch (Exception ex)
         {
             logger.LogCritical("error updating the client: {exceptionMessage}", ex.Message);
         }
         return logger.LogEntries;
     }
@@ -137,7 +137,7 @@
             return indexingNormalizationRegex().Replace(name, "{}");
         return name;
     }
-    public async Task<List<LogEntry>> GenerateAsync(string openAPIFilePath, string outputPath, GenerationLanguage language, string[] includePatterns, string[] excludePatterns, string clientClassName, string clientNamespaceName, bool usesBackingStore, bool cleanOutput, bool clearCache, bool excludeBackwardCompatible, string[] disabledValidationRules, string[] serializers, string[] deserializers, string[] structuredMimeTypes, bool includeAdditionalData, CancellationToken cancellationToken)
+    public async Task<List<LogEntry>> GenerateAsync(string openAPIFilePath, string outputPath, GenerationLanguage language, string[] includePatterns, string[] excludePatterns, string clientClassName, string clientNamespaceName, bool usesBackingStore, bool cleanOutput, bool clearCache, bool excludeBackwardCompatible, string[] disabledValidationRules, string[] serializers, string[] deserializers, string[] structuredMimeTypes, bool includeAdditionalData, ConsumerOperation operation, CancellationToken cancellationToken)
     {
         var logger = new ForwardedLogger<KiotaBuilder>();
         var configuration = Configuration.Generation;
@@ -151,7 +151,7 @@
         configuration.ClearCache = clearCache;
         configuration.ExcludeBackwardCompatible = excludeBackwardCompatible;
         configuration.IncludeAdditionalData = includeAdditionalData;
-        configuration.Operation = ConsumerOperation.Add; //TODO should be updated to edit in the edit scenario
+        configuration.Operation = operation;
         if (disabledValidationRules is { Length: > 0 })
             configuration.DisabledValidationRules = disabledValidationRules.ToHashSet(StringComparer.OrdinalIgnoreCase);
         if (serializers is { Length: > 0 })
@@ -173,17 +173,17 @@
         {
             var result = await GenerateClientAsync(configuration, logger, cancellationToken);
             if (result)
                 logger.LogInformation("Generation of {clientClassName} client for {language} at {outputPath} completed", configuration.ClientClassName, configuration.Language, configuration.OutputPath);
             else
                 logger.LogInformation("Client generation skipped, client is up to date");
         }
         catch (Exception ex)
         {
             logger.LogCritical("error generating the client: {exceptionMessage}", ex.Message);
         }
         return logger.LogEntries;
     }
-    public async Task<List<LogEntry>> GeneratePluginAsync(string openAPIFilePath, string outputPath, PluginType[] pluginTypes, string[] includePatterns, string[] excludePatterns, string clientClassName, bool cleanOutput, bool clearCache, string[] disabledValidationRules, CancellationToken cancellationToken)
+    public async Task<List<LogEntry>> GeneratePluginAsync(string openAPIFilePath, string outputPath, PluginType[] pluginTypes, string[] includePatterns, string[] excludePatterns, string clientClassName, bool cleanOutput, bool clearCache, string[] disabledValidationRules, ConsumerOperation operation, CancellationToken cancellationToken)
     {
         var globalLogger = new ForwardedLogger<KiotaBuilder>();
         var configuration = Configuration.Generation;
@@ -194,7 +194,7 @@
             configuration.ClientClassName = clientClassName;
         configuration.CleanOutput = cleanOutput;
         configuration.ClearCache = clearCache;
-        configuration.Operation = ConsumerOperation.Add; //TODO should be updated to edit in the edit scenario
+        configuration.Operation = operation;
         if (disabledValidationRules is { Length: > 0 })
             configuration.DisabledValidationRules = disabledValidationRules.ToHashSet(StringComparer.OrdinalIgnoreCase);
         if (pluginTypes is { Length: > 0 })
@@ -217,7 +217,7 @@
         }
         catch (Exception ex)
         {
             globalLogger.LogCritical(ex, "error adding the client: {exceptionMessage}", ex.Message);
         }
         return globalLogger.LogEntries;
     }

vscode/microsoft-kiota/debugging.md

@@ -46,3 +46,27 @@ Where kiotaVersionInPackage is the kiotaVersion field and versionInPackage is th
 > Note: the **.vscode** segment might change to **.vscode-server** if you're remoting to WSL.
 
 > Note: alternatively to building executable yourself, you can download it from [the pipeline](https://github.com/microsoft/kiota/actions/workflows/dotnet.yml) by filtering the branch (top right corner) with the pull request branch, selecting the latest run, and downloading the right OS version from the artifacts. The only remaining work will be to move the downloaded files to the right path above.
+
+#### Using the ready-made script
+
+If you want to automate these steps, you can use the following script to automate the process:
+
+```powershell
+.\scripts\execute-vscode-sideload.ps1 -Platform "win-x64|linux-x64|osx-x64" 
+```
+
+If you are using WSL, you can use the following:
+
+```powershell
+.\scripts\execute-vscode-sideload.ps1 -WSL
+```
+
+## FAQ
+
+### VS Code keeps reinstalling from the marketplace
+
+This is most likely caused by the fact that there's a newer released version. Run the following script replacing the version argument with the latest version of kiota.
+
+```powershell
+.\scripts\update-vscode-releases.ps1 -version "versionWithoutVPrefix" -online -filePath .\vscode\microsoft-kiota\package.json
+```

vscode/microsoft-kiota/l10n/bundle.l10n.ar.json

@@ -28,7 +28,6 @@
   "Generating client...": "انشاء العميل...",
   "Loading...": "جاري التحميل...",
   "Updating clients...": "تحديث العملاء...",
-  "Pick a lock file": "اختر ملف قفل",
   "Open a lock file": "افتح ملف قفل",
   "Filter the API description": "قم بتصفية وصف API",
   "Enter a filter": "أدخل عامل التصفية",
@@ -38,5 +37,38 @@
   "Invalid URL, please check the documentation for the supported URLs": "عنوان URL غير صالح ، يرجى التحقق من الوثائق الخاصة بعناوين URL المدعومة",
   "No content found in the clipboard": "لم يتم العثور على محتوى في الحافظة",
   "Invalid content found in the clipboard": "تم العثور على محتوى غير صالح في الحافظة",
-  "Select an API manifest key": "حدد مفتاح بيان واجهة برمجة التطبيقات"
+  "Select an API manifest key": "حدد مفتاح بيان واجهة برمجة التطبيقات",
+  "Edit Paths":"",
+  "Re-generate": "",
+  "Add an API description": "",
+  "Search or paste a path to an API description": "",
+  "Generate a plugin": "",
+  "Generate an API manifest": "",
+  "What do you want to generate?": "",
+  "Select an option": "",
+  "class": "",
+  "namespace": "",
+  "output directory": "",
+  "language": "",
+  "Create a new API client": "",
+  "Create a new plugin": "",
+  "Create a new manifest": "",
+  "plugin name:": "",
+  "Choose a name for the plugin": "",
+  "Choose a plugin type": "",
+  "manifest name": "",
+  "Choose a name for the manifest": "",
+  "Required": "",
+  "Open installation instructions for kiota?": "",
+  "Invalid generation type": "",
+  "Yes, override it": "",
+  "Before adding a new API description, consider that your changes and current selection will be lost.": "",
+  "Cancel": "",
+  "Do you want to remove this API description?": "",
+  "Please save the workspace.json file before re-generation.": "",
+  "OK": "",
+  "Generating manifest...": "",
+  "Generating plugin...": "",
+  "Re-generating client...": "",
+  "Re-generating plugin...": ""
 }

vscode/microsoft-kiota/l10n/bundle.l10n.cs.json

@@ -28,7 +28,6 @@
   "Generating client...": "Generování klienta...",
   "Updating clients...": "Aktualizace klientů...",
   "Loading...": "Načítání...",
-  "Pick a lock file": "Vybrat soubor zámku",
   "Open a lock file": "Otevřít soubor zámku",
   "Filter the API description": "Filtrovat popis API",
   "Enter a filter": "Zadejte filtr",
@@ -38,5 +37,38 @@
   "Invalid URL, please check the documentation for the supported URLs": "Neplatná URL adresa, zkontrolujte dokumentaci pro podporované URL adresy",
   "No content found in the clipboard": "V schránce nebyl nalezen žádný obsah",
   "Invalid content found in the clipboard": "V schránce byl nalezen neplatný obsah",
-  "Select an API manifest key": "Vyberte klíč manifestu API"
+  "Select an API manifest key": "Vyberte klíč manifestu API",
+  "Edit Paths":"Upravit cesty",
+  "Re-generate": "Znovu vygenerovat",
+  "Add an API description": "Přidat popis API",
+  "Search or paste a path to an API description": "Hledat nebo vložit cestu k popisu API",
+  "Generate a plugin": "Generovat plugin",
+  "Generate an API manifest": "Generovat API manifest",
+  "What do you want to generate?": "Co chcete generovat? ",
+  "Select an option": "Vyberte možnost",
+  "class": "třída",
+  "namespace": "jmenný prostor",
+  "output directory": "výstupní adresář",
+  "language": "jazyk",
+  "Create a new API client": "Vytvořit nového API klienta",
+  "Create a new plugin": "Vytvořit nový plugin",
+  "Create a new manifest": "Vytvořit nový manifest",
+  "plugin name:": "název pluginu",
+  "Choose a name for the plugin": "Vyberte název pro plugin",
+  "Choose a plugin type": "Vyberte typ pluginu",
+  "manifest name": "název manifestu",
+  "Choose a name for the manifest": "Vyberte název pro manifest",
+  "Required": "Požadováno",
+  "Open installation instructions for kiota?": "Otevřít instalační pokyny pro kiota",
+  "Invalid generation type": "Neplatný typ generování",
+  "Yes, override it": "Ano, přepsat",
+  "Before adding a new API description, consider that your changes and current selection will be lost.": "Před přidáním nového popisu API zvažte, že vaše změny a aktuální výběr budou ztraceny.",
+  "Cancel": "Zrušit",
+  "Do you want to remove this API description?": "Chcete odstranit tento popis API?",
+  "Please save the workspace.json file before re-generation.": "Před generováním prosím uložte soubor workspace.json",
+  "OK": "OK",
+  "Generating manifest...": "Generování manifestu...",
+  "Generating plugin...": "Generování pluginu...",
+  "Re-generating client...": "Opětovné generování klienta...",
+  "Re-generating plugin...": "Opětovné generování pluginu..."
 }

vscode/microsoft-kiota/l10n/bundle.l10n.es.json

@@ -28,7 +28,6 @@
   "Generating client...": "Generando cliente...",
   "Updating clients...": "Actualizando clientes...",
   "Loading...": "Cargando...",
-  "Pick a lock file": "Seleccionar un archivo lock",
   "Open a lock file": "Abrir un archivo lock",
   "Filter the API description": "Filtrar descripción de API",
   "Enter a filter": "Ingresar un filtro",
@@ -38,5 +37,38 @@
   "Invalid URL, please check the documentation for the supported URLs": "URL inválido, por favor revise la documentación de URL soportados.",
   "No content found in the clipboard": "Sin contenido en el portapapeles.",
   "Invalid content found in the clipboard": "Contenido inválido en el portapapeles.",
-  "Select an API manifest key": "Seleccione una llave de manifesto de API."
+  "Select an API manifest key": "Seleccione una llave de manifesto de API.",
+  "Edit Paths":"Editar ruta de acceso",
+  "Re-generate": "Re-generar",
+  "Add an API description": "Agregar una descripción de API",
+  "Search or paste a path to an API description": "Busca o pega una ruta a una descripcion de API",
+  "Generate a plugin": "Generar un plugin",
+  "Generate an API manifest": "Generar un manifesto de API",
+  "What do you want to generate?": "Qué quieres generar?",
+  "Select an option": "Seleccionar una opción",
+  "class": "clase",
+  "namespace": "namespace",
+  "output directory": "directorio de salida",
+  "language": "idioma",
+  "Create a new API client": "Crear un nuevo cliente de API",
+  "Create a new plugin": "Crear un nuevo plugin",
+  "Create a new manifest": "Crear un nuevo manifesto",
+  "plugin name:": "nombre del plugin",
+  "Choose a name for the plugin": "Elija un nombre para el plugin",
+  "Choose a plugin type": "Elija un tipo de plugin",
+  "manifest name": "Nombre de manifesto",
+  "Choose a name for the manifest": "Elija un nombre para el manifesto",
+  "Required": "Requerido",
+  "Open installation instructions for kiota?": "Abrir las instrucciones de instalación para Kiota",
+  "Invalid generation type": "Tipo de generación inválido",
+  "Yes, override it": "Sí, sobrescribir",
+  "Before adding a new API description, consider that your changes and current selection will be lost.": "Antes de agregar una nueva descripción de API, considere que sus cambios and selección actual se perderá",
+  "Cancel": "Cancelar",
+  "Do you want to remove this API description?": "Quieres quitar esta descripcion de API?",
+  "Please save the workspace.json file before re-generation.": "Por favor, guarde el archivo workspace.json antes de re-generar.",
+  "OK": "Ok",
+  "Generating manifest...": "Generando manifesto...",
+  "Generating plugin...": "Generando plugin...",
+  "Re-generating client...": "Re-generando cliente...",
+  "Re-generating plugin...": "Re-generando plugin..."
 }

vscode/microsoft-kiota/l10n/bundle.l10n.fr.json

@@ -28,7 +28,6 @@
   "Generating client...": "Génération du client...",
   "Updating clients...": "Mise à jour des clients...",
   "Loading...": "Chargement...",
-  "Pick a lock file": "Sélectionnez un fichier verrou",
   "Open a lock file": "Ouvrir un fichier verrou",
   "Filter the API description": "Filtrer la description d'API",
   "Enter a filter": "Entrez un filtre",
@@ -38,5 +37,38 @@
   "Invalid URL, please check the documentation for the supported URLs": "URL invalide, veuillez vérifier la documentation pour les URL prises en charge",
   "No content found in the clipboard": "Aucun contenu trouvé dans le presse-papiers",
   "Invalid content found in the clipboard": "Contenu non valide trouvé dans le presse-papiers",
-  "Select an API manifest key": "Sélectionnez une clé de manifeste d'API"
+  "Select an API manifest key": "Sélectionnez une clé de manifeste d'API",
+  "Edit Paths":"Modifier les chemins",
+  "Re-generate": "Générer de nouveau",
+  "Add an API description": "Ajouter une description d'API",
+  "Search or paste a path to an API description": "Rechercher ou coller un chemin vers unde description d'API",
+  "Generate a plugin": "Générer un plugin",
+  "Generate an API manifest": "Générer un manifeste d'API",
+  "What do you want to generate?": "Que souhaitez vous générer?",
+  "Select an option": "Sélectionnez une option",
+  "class": "classe",
+  "namespace": "espace de nommage",
+  "output directory": "répertoire de sortie",
+  "language": "langage",
+  "Create a new API client": "Créer un nouveau client d'API",
+  "Create a new plugin": "Créer un nouveau composant",
+  "Create a new manifest": "Créer un nouveau manifeste",
+  "plugin name:": "nom du composant",
+  "Choose a name for the plugin": "Choisissez un nom pour le composant",
+  "Choose a plugin type": "Choisisses un type de composant",
+  "manifest name": "nom du manifeste",
+  "Choose a name for the manifest": "Choisissez un nom pour le manifeste",
+  "Required": "Requis",
+  "Open installation instructions for kiota?": "Ouvrir les instructions d'installation pour kiota?",
+  "Invalid generation type": "Type de génération invalide",
+  "Yes, override it": "Oui, l'écraser",
+  "Before adding a new API description, consider that your changes and current selection will be lost.": "Avant d'ajouter une nouvelle description d'API veuillez noter que vos modifications et sélections actuelles seront perdues",
+  "Cancel": "Annuler",
+  "Do you want to remove this API description?": "Voulez-vous supprimer cette description d'API?",
+  "Please save the workspace.json file before re-generation.": "Veuillez sauvegarder le fichier workspace.json avant de générer à nouveau.",
+  "OK": "Ok",
+  "Generating manifest...": "Génération du manifeste...",
+  "Generating plugin...": "Génération du composant...",
+  "Re-generating client...": "Rafraichissement du client...",
+  "Re-generating plugin...": "Refraichissement du composant..."
 }