Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand the set of doneOn clauses available to walkthrough steps #122570

Closed
7 tasks done
JacksonKearl opened this issue Apr 28, 2021 · 10 comments
Closed
7 tasks done

Expand the set of doneOn clauses available to walkthrough steps #122570

JacksonKearl opened this issue Apr 28, 2021 · 10 comments
Assignees
Labels
feature-request Request for new features or functionality getting-started insiders-released Patch has been released in VS Code Insiders verification-needed Verification of issue is requested verified Verification succeeded
Milestone

Comments

@JacksonKearl
Copy link
Contributor

JacksonKearl commented Apr 28, 2021

Currently vscode only allows a step to be doneOn a command having been executed. This should be expanded to support:

  • A link being opened (via a walkthrough)
  • A view having become visible
  • A setting having been modified
  • An extension being installed
  • A context key being set
  • A script (in core) explicitly checking the item off
  • The item being selected

Maybe more?

cc @digitarald

@JacksonKearl JacksonKearl self-assigned this Apr 28, 2021
@JacksonKearl JacksonKearl added getting-started feature-request Request for new features or functionality labels Apr 28, 2021
@JacksonKearl JacksonKearl added this to the May 2021 milestone Apr 28, 2021
@digitarald
Copy link
Contributor

Given how flexible context keys are, that list looks good!

@digitarald
Copy link
Contributor

For C++, clauses for launch.json and tasks.json set up. Potentially looking at specific types of entries.

@JacksonKearl
Copy link
Contributor Author

JacksonKearl commented May 13, 2021

Couple changes in tomorrows insiders:

  • doneOn is deprecated in favor of new "completionEvents", doneOn will still work the same, but completionEvents are preferred going forward (this mirrors activationEvents)
  • by default, with no doneOn or completionEvents set, the step will be checked when any of its buttons are pressed (links or commands)
    • if the step has no buttons, it will be checked when it's selected
  • completionEvents accepts entries in the format:
    'onCommand:${1:commandId}'
    'onLink:${2:linkId}'
    'extensionInstalled:${3:extensionId}'
    'stepSelected'

See JacksonKearl/md-to-html@4c477ea for an example conversion

Ashray123 pushed a commit to Ashray123/vscode that referenced this issue May 25, 2021
@JacksonKearl JacksonKearl added the verification-needed Verification of issue is requested label Jun 1, 2021
@JacksonKearl
Copy link
Contributor Author

Verify by playing with the sample https://github.com/microsoft/vscode-extension-samples/tree/main/getting-started-sample, the steps use these completion events.

@alexr00
Copy link
Member

alexr00 commented Jun 4, 2021

I can't get onLink to work:

					{
						"id": "openlink",
						"title": "Open Link",
						"description": "This step will open a link and check off.\n[Open Link](http://bing.com)",
						"media": {
							"image": "media/image.png",
							"altText": "Empty image"
						},
						"completionEvents": [
							"onLink:http://bing.com"
						]
					}

@alexr00 alexr00 reopened this Jun 4, 2021
@alexr00 alexr00 added the verification-found Issue verification failed label Jun 4, 2021
@alexr00
Copy link
Member

alexr00 commented Jun 4, 2021

Also, onSettingChanged causes steps to always show as complete, even when a setting has never been touched.
Never mind, this one is working.

@alexr00
Copy link
Member

alexr00 commented Jun 4, 2021

A script (in core) explicitly checking the item off

How should this one be tested?

@JacksonKearl
Copy link
Contributor Author

How should this one be tested?

That's there to enable checking off on settings sync being activated. If you see
image
when settings sync is activate, it is working as intended.

@JacksonKearl JacksonKearl removed the verification-found Issue verification failed label Jun 4, 2021
@meganrogge
Copy link
Contributor

@alexr00 did you verify this or what are the items you didn't get to? I will do those.

@alexr00
Copy link
Member

alexr00 commented Jun 7, 2021

onLink needs to be verified.
This one also needs to be verified: #122570 (comment).

Everything else has been verified.

@meganrogge meganrogge added the verified Verification succeeded label Jun 7, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jul 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality getting-started insiders-released Patch has been released in VS Code Insiders verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

5 participants
@digitarald @JacksonKearl @meganrogge @alexr00 and others