Add RewritePlugin. Closes #150 (#151)

Author: garrytrinder

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.0] - Unreleased
+
+### Added:
+
+- Snippets: `devproxy-plugin-rewrite` - RewritePlugin instance
+- Snippets: `devproxy-plugin-rewrite-config` - RewritePlugin config section
+
 ## [0.12.0] - 2024-10-31
 
 > **Note**: `0.11.x` pre-releases are not included in this changelog. They were used to test the new features and fixes before the final release.

README.md

@@ -131,6 +131,8 @@ Shown when the active document is a Dev Proxy configuration file
 | `devproxy-plugin-rate-limiting-file` | Dev Proxy rate limiting file |
 | `devproxy-plugin-rate-limiting-file-schema` | Dev Proxy rate limiting file schema |
 | `devproxy-plugin-retry-after` | RetryAfterPlugin instance |
+| `devproxy-plugin-rewrite` | RewritePlugin instance |
+| `devproxy-plugin-rewrite-config` | RewritePlugin config section |
 | `devproxy-reporter-json` | JsonReporter instance |
 | `devproxy-reporter-markdown` | MarkdownReporter instance |
 | `devproxy-reporter-plain-text` | PlainTextReporter instance |

package-lock.json

@@ -2,7 +2,7 @@
   "name": "dev-proxy-toolkit",
   "displayName": "Dev Proxy Toolkit",
   "description": "Makes it easy to create and update Dev Proxy configuration files.",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "publisher": "garrytrinder",
   "engines": {
     "vscode": "^1.89.0"

package.json

@@ -160,6 +160,13 @@ export const pluginSnippets: PluginSnippets = {
   RetryAfterPlugin: {
     instance: 'devproxy-plugin-retry-after',
   },
+  RewritePlugin: {
+    instance: 'devproxy-plugin-rewrite',
+    config: {
+      name: 'devproxy-plugin-rewrite-config',
+      required: true,
+    }
+  },
   JsonReporter: {
     instance: 'devproxy-reporter-json',
   },
@@ -288,6 +295,10 @@ export const pluginDocs: PluginDocs = {
     name: 'Retry After Plugin',
     url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/retryafterplugin',
   },
+  RewritePlugin: {
+    name: 'Rewrite Plugin',
+    url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/rewriteplugin',
+  },
   JsonReporter: {
     name: 'JSON Reporter',
     url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/jsonreporter',

src/constants.ts

@@ -848,6 +848,27 @@
     ],
     "description": "RetryAfterPlugin instance"
   },
+  "RewritePlugin": {
+    "prefix": "devproxy-plugin-rewrite",
+    "body": [
+      "{",
+      "\t\"name\": \"RewritePlugin\",",
+      "\t\"enabled\": true,",
+      "\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\",",
+      "\t\"configSection\": \"rewritePlugin\"",
+      "}"
+    ],
+    "description": "RewritePlugin instance"
+  },
+  "RewritePluginConfig":{
+    "prefix": "devproxy-plugin-rewrite-config",
+    "body": [
+      "\"rewritePlugin\": {",
+      "\t\"rewritesFile\": \"rewrites.json\"",
+      "}"
+    ],
+    "description": "RewritePlugin config section"
+  },
   "JsonReporter": {
     "prefix": "devproxy-reporter-json",
     "body": [