Merge pull request #1184 from christianhelle/vscode-generate-from-refitter-file

Author: christianhelle

src/VSCode/README.md

@@ -21,7 +21,7 @@ You can install this extension in several ways:
 
 ## Features
 
-This extension adds a context menu item **REST API Client Code Generator** when right-clicking on JSON or YAML files in the VS Code explorer. The context menu provides the following code generation options:
+This extension adds a context menu item **REST API Client Code Generator** when right-clicking on JSON or YAML files in the VS Code explorer. Additionally, it provides a **Generate Refitter Output** command when right-clicking on `.refitter` settings files. The context menu provides the following code generation options:
 
 ### C# Generators
 
@@ -45,6 +45,10 @@ This extension adds a context menu item **REST API Client Code Generator** when
 - **Redux Query**: Generates a TypeScript REST API Client for Redux Query
 - **RxJS**: Generates a TypeScript REST API Client for RxJS
 
+### Refitter Settings Support
+
+- **Generate Refitter Output**: When right-clicking on a `.refitter` settings file, you can generate C# Refit interfaces using Refitter with custom configuration. This allows for advanced Refitter configurations including custom settings for authentication, serialization, and other Refitter-specific options.
+
 ## Screenshot
 
 ![Command Palette](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-command-palette.png)
@@ -77,12 +81,49 @@ The extension includes configurable settings:
 
 ## How to Use
 
+### For OpenAPI/Swagger Specifications
+
 1. Right-click on a Swagger/OpenAPI specification file (JSON or YAML) in the VS Code explorer
 2. Select "REST API Client Generator" in the context menu
 3. Choose your desired language (C# or TypeScript)
 4. Select one of the available generators for that language
 5. The generated code will be saved in the configured output directory and opened in the editor
 
+### For Refitter Settings Files
+
+1. Create a `.refitter` settings file with your Refitter configuration
+2. Right-click on the `.refitter` file in the VS Code explorer
+3. Select "Generate Refitter Output" from the context menu
+4. The generated C# Refit interfaces will be created according to your settings file configuration
+
+## Refitter Settings Files
+
+The extension supports Refitter settings files (`.refitter`) which allow you to configure advanced options for generating C# Refit interfaces. A typical `.refitter` settings file includes:
+
+- **OpenAPI specification URL or file path**
+- **Namespace configuration**
+- **Output file paths**
+- **Authentication settings**
+- **Serialization options**
+- **Custom type mappings**
+- **And many other Refitter-specific options**
+
+Example `.refitter` file:
+
+```json
+{
+  "openApiSpecUrl": "https://petstore.swagger.io/v2/swagger.json",
+  "namespace": "PetStore.Api",
+  "outputFolder": "./Generated",
+  "outputFilename": "PetStoreApi.cs",
+  "clientName": "PetStoreClient",
+  "generateContracts": true,
+  "generateXmlDocCodeComments": true
+}
+```
+
+For more information about Refitter settings, visit the [Refitter documentation](https://github.com/christianhelle/refitter).
+
 ## Dependencies
 
 ### C# Dependencies

src/VSCode/package.json

@@ -89,6 +89,10 @@
       {
         "command": "restApiClientCodeGenerator.typescript.rxjs",
         "title": "Generate TypeScript Client for RxJS"
+      },
+      {
+        "command": "restApiClientCodeGenerator.refitterSettings",
+        "title": "Generate Refitter Output"
       }
     ],
     "menus": {
@@ -97,6 +101,11 @@
           "submenu": "restApiClientCodeGenerator.submenu",
           "when": "resourceExtname == .json || resourceExtname == .yaml || resourceExtname == .yml",
           "group": "z_commands"
+        },
+        {
+          "command": "restApiClientCodeGenerator.refitterSettings",
+          "when": "resourceExtname == .refitter",
+          "group": "z_commands"
         }
       ],
       "restApiClientCodeGenerator.submenu": [

src/VSCode/src/extension.ts

@@ -545,6 +545,73 @@ async function executeRapicgenTypeScript(generator: string, specificationFilePat
   }
 }
 
+/**
+ * Executes the Rapicgen tool with Refitter using a settings file
+ * @param settingsFilePath The path to the .refitter settings file
+ * @param context The extension context
+ */
+async function executeRapicgenRefitterSettings(settingsFilePath: string, context: vscode.ExtensionContext): Promise<void> {
+  // Validate the settings file
+  if (!validateSpecificationFile(settingsFilePath)) {
+    return;
+  }
+  
+  // Check if .NET SDK is installed
+  if (!isDotNetSdkInstalled()) {
+    vscode.window.showErrorMessage(
+      '.NET SDK not found. Please install .NET SDK 6.0 or higher to use this extension. Visit https://dotnet.microsoft.com/download/dotnet to download and install.'
+    );
+    return;
+  }
+  
+  // Ensure the Rapicgen tool is installed and up-to-date
+  const rapicgenAvailable = await ensureRapicgenToolAvailable(context);
+  if (!rapicgenAvailable) {
+    return;
+  }
+
+  const command = `rapicgen csharp refitter --settings-file "${settingsFilePath}"`;
+  
+  try {
+    // Show progress while generating
+    await vscode.window.withProgress({
+      location: vscode.ProgressLocation.Notification,
+      title: 'Generating Refitter output from settings file...',
+      cancellable: false
+    }, async () => {
+      try {
+        // Run with higher timeout since code generation can take time
+        const output = execSync(command, { 
+          encoding: 'utf-8',
+          timeout: 120000 // 2 minute timeout
+        });
+        
+        // Log output for debugging
+        console.log(`Rapicgen Refitter settings output: ${output}`);
+        
+        vscode.window.showInformationMessage('Successfully generated Refitter output from settings file');
+      } catch (error: unknown) {
+        let errorMessage = 'Error generating Refitter output from settings file';
+        
+        const err = error as { message?: string; stderr?: string };
+        if (err.message) {
+          errorMessage += `: ${err.message}`;
+        }
+        
+        if (err.stderr) {
+          errorMessage += `\n${err.stderr}`;
+          console.error('Command stderr:', err.stderr);
+        }
+        
+        vscode.window.showErrorMessage(errorMessage);
+        console.error('Command execution error:', error);
+      }
+    });
+  } catch (error) {
+    console.error('Error during Refitter settings code generation process:', error);
+  }
+}
+
 /**
  * Validates that a specification file exists and is readable
  * @param specificationFilePath The path to the OpenAPI/Swagger specification file
@@ -641,10 +708,42 @@ export function activate(context: vscode.ExtensionContext) {
 
         executeRapicgenTypeScript(generator.command, fileUri.fsPath, context);
       }
-    );
-
-    context.subscriptions.push(disposable);
+    );    context.subscriptions.push(disposable);
   }
+  
+  // Register command for Refitter settings
+  const refitterSettingsDisposable = vscode.commands.registerCommand(
+    'restApiClientCodeGenerator.refitterSettings',
+    async (fileUri: vscode.Uri) => {
+      if (!fileUri) {
+        // If command was triggered from command palette, ask for file
+        const files = await vscode.workspace.findFiles('**/*.refitter');
+        if (files.length === 0) {
+          vscode.window.showErrorMessage('No .refitter settings files found in the workspace');
+          return;
+        }
+
+        const fileItems = files.map(file => ({
+          label: path.basename(file.fsPath),
+          description: vscode.workspace.asRelativePath(file),
+          path: file.fsPath
+        }));
+
+        const selectedFile = await vscode.window.showQuickPick(fileItems, {
+          placeHolder: 'Select a .refitter settings file'
+        });
+
+        if (!selectedFile) {
+          return;
+        }
+        fileUri = vscode.Uri.file(selectedFile.path);
+      }
+
+      executeRapicgenRefitterSettings(fileUri.fsPath, context);
+    }
+  );
+
+  context.subscriptions.push(refitterSettingsDisposable);
 }
 
 /**