ado-sync 0.1.48 → 0.1.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/dist/ai/summarizer.js +6 -3
- package/dist/ai/summarizer.js.map +1 -1
- package/dist/azure/test-cases.js +28 -10
- package/dist/azure/test-cases.js.map +1 -1
- package/dist/cli.js +238 -18
- package/dist/cli.js.map +1 -1
- package/dist/config.d.ts +0 -5
- package/dist/config.js +17 -3
- package/dist/config.js.map +1 -1
- package/dist/mcp-server.js +20 -21
- package/dist/mcp-server.js.map +1 -1
- package/dist/parsers/gherkin.js +2 -1
- package/dist/parsers/gherkin.js.map +1 -1
- package/dist/sync/engine.d.ts +41 -0
- package/dist/sync/engine.js +176 -10
- package/dist/sync/engine.js.map +1 -1
- package/dist/sync/publish-results.js +28 -3
- package/dist/sync/publish-results.js.map +1 -1
- package/dist/sync/writeback.js +41 -20
- package/dist/sync/writeback.js.map +1 -1
- package/dist/types.d.ts +7 -0
- package/docs/vscode-extension.md +139 -0
- package/llms.txt +24 -0
- package/package.json +2 -2
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# VS Code Extension
|
|
2
|
+
|
|
3
|
+
The **ado-sync VS Code Extension** brings the full `ado-sync` workflow into your editor — no terminal required for day-to-day tasks.
|
|
4
|
+
|
|
5
|
+
- **Marketplace:** [PavanMudigonda.ado-sync-vscode](https://marketplace.visualstudio.com/items?itemName=PavanMudigonda.ado-sync-vscode)
|
|
6
|
+
- **Source:** [github.com/PavanMudigonda/ado-sync-vscode](https://github.com/PavanMudigonda/ado-sync-vscode)
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Requirements
|
|
11
|
+
|
|
12
|
+
- `ado-sync` npm package installed globally:
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g ado-sync
|
|
15
|
+
```
|
|
16
|
+
Or as a dev dependency in your project (`npx ado-sync` is used automatically).
|
|
17
|
+
- An `ado-sync.json` (or `ado-sync.yml`) config file in the workspace root.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
**From VS Code:**
|
|
24
|
+
1. Open the Extensions panel (`Ctrl+Shift+X` / `Cmd+Shift+X`)
|
|
25
|
+
2. Search for `ado-sync`
|
|
26
|
+
3. Click **Install**
|
|
27
|
+
|
|
28
|
+
**From the CLI:**
|
|
29
|
+
```bash
|
|
30
|
+
code --install-extension PavanMudigonda.ado-sync-vscode
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**From the Marketplace:**
|
|
34
|
+
Visit the [Marketplace page](https://marketplace.visualstudio.com/items?itemName=PavanMudigonda.ado-sync-vscode) and click **Install**.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Features
|
|
39
|
+
|
|
40
|
+
### CodeLens
|
|
41
|
+
|
|
42
|
+
Every `@tc:12345` tag in `.feature` and `.md` files gets inline action links directly above it:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
[ View in ADO ] [ Push ] [ Fetch ]
|
|
46
|
+
@tc:12345
|
|
47
|
+
Scenario: User can log in
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- **View in ADO** — opens the Test Case in your browser
|
|
51
|
+
- **Push** — pushes only this test case to Azure DevOps
|
|
52
|
+
- **Fetch** — retrieves the latest version of this test case from ADO
|
|
53
|
+
|
|
54
|
+
Toggle CodeLens on/off with the `ado-sync.showCodeLens` setting.
|
|
55
|
+
|
|
56
|
+
### Hover Tooltips
|
|
57
|
+
|
|
58
|
+
Hover over any `@tc:12345` tag to see a tooltip with a direct link to the Azure DevOps Test Case.
|
|
59
|
+
|
|
60
|
+
### Sidebar Tree View
|
|
61
|
+
|
|
62
|
+
The **Testing** panel (`Ctrl+Shift+T`) includes an **ADO Test Cases** tree:
|
|
63
|
+
|
|
64
|
+
- Lists all spec files in the workspace that contain `@tc:` tags
|
|
65
|
+
- Each file expands to show its linked test cases with line numbers
|
|
66
|
+
- Click an entry to jump to the line in the editor
|
|
67
|
+
|
|
68
|
+
### Status Bar
|
|
69
|
+
|
|
70
|
+
The status bar item shows the current sync state of the workspace. Click it to run `ado-sync status` and refresh.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Commands
|
|
75
|
+
|
|
76
|
+
Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`) and type `ado-sync`:
|
|
77
|
+
|
|
78
|
+
| Command | Description |
|
|
79
|
+
|---|---|
|
|
80
|
+
| `ado-sync: Push` | Push all local spec changes to Azure DevOps (creates new TCs, updates existing) |
|
|
81
|
+
| `ado-sync: Push (Dry Run)` | Preview what push would do — no changes applied |
|
|
82
|
+
| `ado-sync: Pull` | Pull Azure DevOps changes back into local spec files |
|
|
83
|
+
| `ado-sync: Pull (Dry Run)` | Preview what pull would do — no changes applied |
|
|
84
|
+
| `ado-sync: Status` | Show a diff of local vs. Azure DevOps state |
|
|
85
|
+
| `ado-sync: Validate Config` | Verify the config file and test the Azure DevOps connection |
|
|
86
|
+
| `ado-sync: Generate Spec from Story` | Prompt for a User Story ID and generate a `.feature` or `.md` spec file |
|
|
87
|
+
| `ado-sync: Fetch Test Case` | Prompt for a Test Case ID and retrieve it from Azure DevOps |
|
|
88
|
+
| `ado-sync: Publish Test Results` | Upload a result file (JUnit XML, TRX, NUnit, Playwright JSON, Cucumber JSON, CTRF) |
|
|
89
|
+
|
|
90
|
+
All command output goes to the **ado-sync** Output Channel (View → Output → select `ado-sync` from the dropdown).
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Settings
|
|
95
|
+
|
|
96
|
+
Configure via VS Code Settings (`Ctrl+,` → search `ado-sync`) or directly in `settings.json`:
|
|
97
|
+
|
|
98
|
+
| Setting | Type | Default | Description |
|
|
99
|
+
|---|---|---|---|
|
|
100
|
+
| `ado-sync.configPath` | `string` | `""` | Path to the config file, relative to the workspace root. Empty = auto-detect (`ado-sync.json` / `ado-sync.yml`). |
|
|
101
|
+
| `ado-sync.showCodeLens` | `boolean` | `true` | Show inline CodeLens links above `@tc:` tags. |
|
|
102
|
+
| `ado-sync.autoStatus` | `boolean` | `false` | Automatically run `ado-sync status` when a spec file is saved. |
|
|
103
|
+
| `ado-sync.outputLevel` | `string` | `"normal"` | Output verbosity: `"normal"`, `"verbose"`, or `"quiet"`. |
|
|
104
|
+
|
|
105
|
+
Example `settings.json`:
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"ado-sync.configPath": "config/ado-sync.json",
|
|
109
|
+
"ado-sync.showCodeLens": true,
|
|
110
|
+
"ado-sync.autoStatus": true,
|
|
111
|
+
"ado-sync.outputLevel": "verbose"
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Quick Start
|
|
118
|
+
|
|
119
|
+
1. Install `ado-sync` globally: `npm install -g ado-sync`
|
|
120
|
+
2. In your project root, run `ado-sync init` to generate `ado-sync.json`
|
|
121
|
+
3. Fill in your `orgUrl`, `project`, `testPlan.id`, and auth token (see [configuration.md](configuration.md))
|
|
122
|
+
4. Install this extension
|
|
123
|
+
5. Open a `.feature` or `.md` spec file — CodeLens links appear automatically above each `@tc:` tag
|
|
124
|
+
6. Run `ado-sync: Validate Config` from the Command Palette to confirm connectivity
|
|
125
|
+
7. Run `ado-sync: Push (Dry Run)` to preview, then `ado-sync: Push` to sync
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Troubleshooting
|
|
130
|
+
|
|
131
|
+
| Symptom | Fix |
|
|
132
|
+
|---|---|
|
|
133
|
+
| CodeLens not showing | Check `ado-sync.showCodeLens` is `true`; reload the window (`Ctrl+Shift+P` → Reload Window) |
|
|
134
|
+
| Commands fail with "ado-sync not found" | Run `npm install -g ado-sync` or ensure it is in your project's `devDependencies` |
|
|
135
|
+
| "Config file not found" | Run `ado-sync init` in the workspace root, or set `ado-sync.configPath` |
|
|
136
|
+
| Auth errors | Verify `AZURE_DEVOPS_TOKEN` is set in your environment or `.env` file |
|
|
137
|
+
| Output channel empty | Set `ado-sync.outputLevel` to `"verbose"` for more detail |
|
|
138
|
+
|
|
139
|
+
For CLI-level issues see [troubleshooting.md](troubleshooting.md).
|
package/llms.txt
CHANGED
|
@@ -131,6 +131,29 @@ Automatically route Test Cases into named suites by tag:
|
|
|
131
131
|
|
|
132
132
|
A `.env` file in the working directory is loaded automatically.
|
|
133
133
|
|
|
134
|
+
## VS Code Extension
|
|
135
|
+
|
|
136
|
+
`ado-sync-vscode` — VS Code extension (marketplace ID: `PavanMudigonda.ado-sync-vscode`)
|
|
137
|
+
|
|
138
|
+
Requires `ado-sync` npm package installed globally and an `ado-sync.json` config in the workspace root.
|
|
139
|
+
|
|
140
|
+
Features:
|
|
141
|
+
- CodeLens: inline View / Push / Fetch links above every `@tc:12345` tag
|
|
142
|
+
- Hover tooltips: hover `@tc:` to open Test Case in Azure DevOps
|
|
143
|
+
- Sidebar tree: Testing panel lists spec files and linked test cases with line numbers
|
|
144
|
+
- Status bar: live sync state, click to run status
|
|
145
|
+
|
|
146
|
+
Commands (Command Palette):
|
|
147
|
+
`ado-sync: Push`, `ado-sync: Push (Dry Run)`, `ado-sync: Pull`, `ado-sync: Pull (Dry Run)`,
|
|
148
|
+
`ado-sync: Status`, `ado-sync: Validate Config`, `ado-sync: Generate Spec from Story`,
|
|
149
|
+
`ado-sync: Fetch Test Case`, `ado-sync: Publish Test Results`
|
|
150
|
+
|
|
151
|
+
Settings:
|
|
152
|
+
- `ado-sync.configPath` (string, default "") — config file path relative to workspace root
|
|
153
|
+
- `ado-sync.showCodeLens` (boolean, default true) — toggle CodeLens
|
|
154
|
+
- `ado-sync.autoStatus` (boolean, default false) — auto-run status on spec file save
|
|
155
|
+
- `ado-sync.outputLevel` (string, default "normal") — "normal" | "verbose" | "quiet"
|
|
156
|
+
|
|
134
157
|
## MCP server
|
|
135
158
|
|
|
136
159
|
`ado-sync-mcp` starts an MCP stdio server exposing 13 tools:
|
|
@@ -162,3 +185,4 @@ Register in Claude Code (`~/.claude/claude_desktop_config.json`):
|
|
|
162
185
|
- docs/mcp-server.md — MCP server setup and tool reference
|
|
163
186
|
- docs/troubleshooting.md — common errors and fixes
|
|
164
187
|
- docs/agent-setup.md — step-by-step guide for AI agents doing autonomous setup
|
|
188
|
+
- docs/vscode-extension.md — VS Code extension commands, settings, CodeLens, sidebar, troubleshooting
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ado-sync",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.49",
|
|
4
4
|
"description": "Bidirectional sync between local test specs (Cucumber/Markdown) and Azure DevOps Test Cases",
|
|
5
5
|
"bin": {
|
|
6
6
|
"ado-sync": "./dist/cli.js",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"glob": "^13.0.6",
|
|
46
46
|
"js-yaml": "^4.1.1",
|
|
47
47
|
"jszip": "^3.10.1",
|
|
48
|
-
"node-llama-cpp": "^3.18.
|
|
48
|
+
"node-llama-cpp": "^3.18.1"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@types/js-yaml": "^4.0.9",
|