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

Test: refactoring documentation contribution point proposal #89388

Closed
2 tasks done
mjbvz opened this issue Jan 27, 2020 · 2 comments
Closed
2 tasks done

Test: refactoring documentation contribution point proposal #89388

mjbvz opened this issue Jan 27, 2020 · 2 comments
Assignees
Milestone

Comments

@mjbvz
Copy link
Collaborator

mjbvz commented Jan 27, 2020

Test for #86788

Complexity: 4

background
The proposed documentation.refactoring contribution point allows extensions to contribute a command that lets users learn more about refactoring

  "contributes": {
    "documentation": {
      "refactoring": [
        {
          "title": "%documentation.refactoring.title%",
          "when": "typescript.isManagedFile",
          "command": "_typescript.learnMoreAboutRefactorings"
        }
      ]
    }

This is rendered at the bottom of the completion list

Testing
Using the code action sample extension, try using creating some documentation.refactoring contributions:

  • Can you get the contribution to show up as expected?
  • Does the when clause work?
  • Make sure that the documentation only shows up when you would expect:
    • It should only show in the lightbulb menu if a refactoring is returned
    • It should always show up in the refactor menu
    • But it should never block keybindings for code actions
@joaomoreno
Copy link
Member

I feel it's rather weird that a when clause is necessary. Usually when clauses are optional. Wouldn't a language selector be more appropriate?

@joaomoreno
Copy link
Member

I'm not really sure what But it should never block keybindings for code actions means.

@joaomoreno joaomoreno removed their assignment Jan 28, 2020
@jrieken jrieken closed this as completed Jan 28, 2020
@vscodebot vscodebot bot locked and limited conversation to collaborators Mar 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants