Merge pull request #1155 from christianhelle/vscode-docs-typescript

Update VS Code docs

Author: christianhelle

src/VSCode/README.md

@@ -1,6 +1,6 @@
 # REST API Client Code Generator
 
-A VS Code extension for generating C# REST API clients from OpenAPI/Swagger specifications.
+A VS Code extension for generating C# and TypeScript REST API clients from OpenAPI/Swagger specifications.
 
 ## Installation
 
@@ -16,57 +16,84 @@ You can install this extension in several ways:
    - Locate and select the downloaded `.vsix` file
 
 3. **Build from Source**:
+
    ```powershell
    git clone https://github.com/christianhelle/apiclientcodegen.git
    cd apiclientcodegen
    ./src/build-vscode.ps1
    ```
+
    Then install the generated `.vsix` file using the method above.
 
 ## 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:
 
+### C# Generators
+
 - **NSwag**: Generates a C# REST API Client using NSwag
 - **Refitter**: Generates a C# Refit interface using Refitter
 - **OpenAPI Generator**: Generates a C# REST API Client using OpenAPI Generator
 - **Microsoft Kiota**: Generates a C# REST API Client using Microsoft Kiota
 - **Swagger Codegen CLI**: Generates a C# REST API Client using Swagger Codegen CLI
 - **AutoREST**: Generates a C# REST API Client using AutoREST
 
+### TypeScript Generators
+
+- **Angular**: Generates a TypeScript REST API Client for Angular
+- **Aurelia**: Generates a TypeScript REST API Client for Aurelia
+- **Axios**: Generates a TypeScript REST API Client for Axios
+- **Fetch**: Generates a TypeScript REST API Client for Fetch
+- **Inversify**: Generates a TypeScript REST API Client for Inversify
+- **jQuery**: Generates a TypeScript REST API Client for jQuery
+- **NestJS**: Generates a TypeScript REST API Client for NestJS
+- **Node**: Generates a TypeScript REST API Client for Node
+- **Redux Query**: Generates a TypeScript REST API Client for Redux Query
+- **RxJS**: Generates a TypeScript REST API Client for RxJS
+
 ## Screenshot
 
 ![Command Palette](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-command-palette.png)
 
-![C#](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu.png)
+![C# Context Menu](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu.png)
 
-![TypeScript](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu-typescript.png)
+![TypeScript Context Menu](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu-typescript.png)
 
 ## Requirements
 
+### For C# code generation
+
 - .NET SDK 6.0 or higher
 - Java Runtime Environment (for OpenAPI Generator and Swagger Codegen CLI)
 - NPM (for AutoREST and NSwag)
 
+### For TypeScript code generation
+
+- Node.js and NPM
+- OpenAPI Generator
+
 The extension uses the `rapicgen` .NET tool to generate the code. If not already installed, you will be prompted to install it when first attempting to generate code.
 
-## Extension Settings
+## Settings and Configuration
 
-This extension contributes the following settings:
+The extension includes configurable settings:
 
-* `restApiClientCodeGenerator.namespace`: Default namespace to use in generated code (default: "GeneratedCode")
-* `restApiClientCodeGenerator.outputDirectory`: Output directory relative to workspace folder (default: same directory as the specification file)
+- `restApiClientCodeGenerator.namespace`: Default namespace to use in generated code (default: "GeneratedCode")
+- `restApiClientCodeGenerator.outputDirectory`: Output directory relative to workspace folder (default: same directory as the specification file)
 
 ## How to Use
 
 1. Right-click on a Swagger/OpenAPI specification file (JSON or YAML) in the VS Code explorer
-2. Select "REST API Client Code Generator" in the context menu
-3. Choose one of the available code generators
-4. The generated C# code will be saved and opened in the editor
+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
 
 ## Dependencies
 
-The code generated by each generator depends on different NuGet packages:
+### C# Dependencies
+
+The C# code generated by each generator depends on different NuGet packages:
 
 - **NSwag**: Depends on Newtonsoft.Json
 - **Refitter**: Depends on Refit
@@ -75,6 +102,17 @@ The code generated by each generator depends on different NuGet packages:
 - **Swagger Codegen CLI**: Depends on RestSharp and JsonSubTypes
 - **AutoREST**: Depends on Microsoft.Rest.ClientRuntime and Newtonsoft.Json
 
+### TypeScript Dependencies
+
+The TypeScript code generated depends on the framework chosen:
+
+- **Angular**: Depends on @angular/core, rxjs
+- **Axios**: Depends on axios
+- **Fetch**: Uses the browser's native fetch API
+- **jQuery**: Depends on jquery
+- **RxJS**: Depends on rxjs
+- For other frameworks, please refer to their official documentation or the [OpenAPI Generator documentation](https://openapi-generator.tech/docs/generators) for detailed dependency information.
+
 ## Related
 
 - This extension is the VS Code equivalent of the [REST API Client Code Generator](https://marketplace.visualstudio.com/items?itemName=ChristianResmaHelle.APIClientCodeGenerator2022) extension for Visual Studio.