|
1 | 1 | # Dev Proxy Toolkit
|
2 | 2 |
|
3 |
| -[Dev Proxy](https://aka.ms/devproxy) is a command line tool that helps you simulate behaviors and errors of cloud APIs. |
| 3 | +[Dev Proxy](https://aka.ms/devproxy) is an API simulator that helps you effortlessly test your app beyond the happy path. |
4 | 4 |
|
5 | 5 | The Dev Proxy Toolkit extension for Visual Studio Code makes it easy to create and update configuration files.
|
6 | 6 |
|
| 7 | +> **IMPORTANT** |
| 8 | +> |
| 9 | +> Dev Proxy Toolkit is designed to be used with the latest version of Dev Proxy, v0.17.1. If you are using an earlier build some features may not work as intended. |
| 10 | +> |
| 11 | +
|
7 | 12 | ## Features
|
8 | 13 |
|
| 14 | +The following sections describe the features that the extension contributes to Visual Studio Code when installed |
| 15 | + |
| 16 | +### Diagnostics |
| 17 | + |
| 18 | +- Check for missing `configSection` property in plugin instance for plugins that require configuration |
| 19 | +- Check for missing `configSection` when defined in plugin instance |
| 20 | +- Check that schema matches installed version of Dev Proxy |
| 21 | + |
| 22 | +### Code Actions |
| 23 | + |
| 24 | +- Update schema to match installed version of Dev Proxy |
| 25 | + |
| 26 | +### Code Lenses |
| 27 | + |
| 28 | +- Plugin documentation link |
| 29 | + |
| 30 | +### Notifications |
| 31 | + |
| 32 | +- Not installed |
| 33 | +- New version detection |
| 34 | + |
| 35 | +### Status Bar |
| 36 | + |
| 37 | +- Display installed Dev Proxy version |
| 38 | +- Display waring when Dev Proxy is not latest version |
| 39 | +- Display tick if Dev Proxy is latest version (check based on `newVersionNotification` config setting) |
| 40 | +- Display radio tower when Dev Proxy is running |
| 41 | +- Display error is Dev Proxy is not installed |
| 42 | + |
| 43 | +### Settings |
| 44 | + |
| 45 | +- `devproxytoolkit.versionPreference` - Determines the version to use when Dev Proxy and Dev Proxy Beta are installed side by side. Can be `stable` (default) or `beta`. |
| 46 | + |
9 | 47 | ### Snippets
|
10 | 48 |
|
11 | 49 | | Prefix | Description |
|
@@ -66,21 +104,3 @@ The Dev Proxy Toolkit extension for Visual Studio Code makes it easy to create a
|
66 | 104 | | `devproxy-plugin-rate-limiting-file` | Dev Proxy rate limiting file |
|
67 | 105 | | `devproxy-plugin-rate-limiting-file-schema` | Dev Proxy rate limiting file schema |
|
68 | 106 | | `devproxy-plugin-retry-after` | RetryAfterPlugin instance |
|
69 |
| - |
70 |
| -### Diagnostics |
71 |
| - |
72 |
| -The following diagnostic checks are performed: |
73 |
| - |
74 |
| -- Check for empty `urlsToWatch` |
75 |
| -- Check for missing `configSection` property in plugin instance for plugins that require configuration |
76 |
| -- Check for missing `configSection` when defined in plugin instance |
77 |
| -- Check that schema matches installed version of Dev Proxy |
78 |
| -- Code action to update schema to correct version |
79 |
| - |
80 |
| -### Dev Proxy detection |
81 |
| - |
82 |
| -The following checks are performed: |
83 |
| - |
84 |
| -- Check if Dev Proxy is installed |
85 |
| -- Check if Dev Proxy is the latest version |
86 |
| -- Check if Dev Proxy is running |
|
0 commit comments