microsoft / microsoft/vscode-sublime-keybindings

Sublime Extension prompt shown should not be stored in user settings

Open
#67 0 comments 1 reaction 1 assignee View on GitHub

@rebornix is already working on this.

Since Dec 1, 2017.

bug
Dominant language
TypeScript
Stars
257
Forks
128
PR merge metrics
No merged PRs in 30d

Description

From @alexandrudima on June 27, 2017 9:20

Testing #29144

"sublimeTextKeymap.promptV3Features": true

This should not be a user-facing setting. Extensions should store state using the context object passed into the activate function.

Instead, I suggest the following:

  • contribute a command called: "Customize VS Code with Sublime Text settings"
  • this will ensure that the user can invoke the command palette and invoke the customize action independently of the prompt and repeatedly.
  • once user interaction has been made with the prompt (i.e. YES or NO, but not More info), the context.globalState passed in the activate method should be used to store the flag that the prompt should not be shown again.
    • when YES is pressed, invoke the command you have contributed and write to globalState that the prompt should not be shown again.
    • when NO is pressed, write to globalState that the prompt should not be shown again.
    • when More info is pressed, open the help page.

For testing purposes, I believe the extension global state can be cleared via Developer Tools > Application > Local Storage

Copied from original issue: Microsoft/vscode#29546

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.