Skip to content

Commit d6cb3c0

Browse files
committed
Add replication steps to readme.
1 parent 2bb639d commit d6cb3c0

File tree

2 files changed

+6
-68
lines changed

2 files changed

+6
-68
lines changed

README.md

+5-66
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,10 @@
11
# score-e2e-test-bug-replication README
22

3-
This is the README for your extension "score-e2e-test-bug-replication". After writing up a brief description, we recommend including the following sections.
3+
This repo replicates a bug lodged here: https://github.com/microsoft/vscode/issues/178184
44

5-
## Features
5+
Hover sequences are different at runtime vs testtime.
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
To demonstrate:
88

9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
14-
15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Following extension guidelines
53-
54-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
55-
56-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
57-
58-
## Working with Markdown
59-
60-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
61-
62-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
63-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
64-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
65-
66-
## For more information
67-
68-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
69-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
70-
71-
**Enjoy!**
9+
1. Run this extension in extensionHost using F5. Open the `src/extension.ts` file and hover over the method name `activate`. You should see the typescript hover information and as `Hello!` message at the bottom, this is as expected.
10+
1. Run the extension tests. The tests will fail as the first hover result contains `Hello` - however this should be last, as it is visually in the UI.

src/test/suite/extension.test.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import * as assert from 'assert';
22
import * as path from 'path';
3-
import * as util from 'node:util';
43
// You can import and use all API from the 'vscode' module
54
// as well as import your extension to test it
65
import * as vscode from 'vscode';
@@ -30,7 +29,7 @@ suite('Hover Test Suits', () => {
3029
const hoverTexts = hoverResults.map(h => (h.contents[0] as vscode.MarkdownString).value)
3130

3231
console.log(hoverTexts);
33-
32+
3433
assert.equal(hoverTexts.length, 2);
3534
assert.match(hoverTexts[0], /activate/); // the typescript `activate` hover content should be first
3635
assert.match(hoverTexts[1], /Hello/); // the 'hello' hover content should be last

0 commit comments

Comments
 (0)