Skip to content

Add an option to enable/disable JSDoc autocomplete#23704

Merged
mjbvz merged 6 commits intomicrosoft:masterfrom
jsynowiec:feature/jsdoc-autocomplete-setting
Apr 3, 2017
Merged

Add an option to enable/disable JSDoc autocomplete#23704
mjbvz merged 6 commits intomicrosoft:masterfrom
jsynowiec:feature/jsdoc-autocomplete-setting

Conversation

@jsynowiec
Copy link
Contributor

@jsynowiec jsynowiec commented Mar 30, 2017 •
edited
Loading

Hopefully addresses #23642

This PR introduces a new settings option for TypeScript extension:

"jsDocCompletion.enabled": {
  "type": "boolean",
  "default": true,
  "description": "%jsDocCompletion.enabled%"
}

which allows to enable or disable expanding /** using docCommentTemplate tsserver command. When set to false the default SnippetString is used.

mar-31-2017 12-37-02

Jakub Synowiec added 4 commits March 31, 2017 00:36
Add new option to disable/enable jsdoc autocompletion
ff1b07d
Refactor JsDocCompletionItem
0269d71 
- remove internal command
- move TS service call and template generation to CompletionItem
- only call TS service if JSDoc completion is enabled in settings
- add local config and config update method to CompletionProvider
Change how and when JsDocCompletionHelper is registered
d1ba323 
Register JsDocCompletionHelper and update configuration in registerProviders instead of activate. Also react to configuration change.
Rename JsDocCompletionHelper to JsDocCompletionProvider
8b11046
@mention-bot
Copy link

mention-bot commented Mar 30, 2017

@jsynowiec, thanks for your PR! By analyzing the history of the files in this pull request, we identified @dbaeumer and @egamma to be potential reviewers.

@msftclas
Copy link

msftclas commented Mar 30, 2017

@jsynowiec,
Thanks for your contribution.
To ensure that the project team has proper rights to use your work, please complete the Contribution License Agreement at https://cla.microsoft.com.

It will cover your contributions to all Microsoft-managed open source projects.
Thanks,
Microsoft Pull Request Bot

@msftclas
Copy link

msftclas commented Mar 30, 2017

@jsynowiec, thanks for signing the contribution license agreement. We will now validate the agreement and then the pull request.

Thanks, Microsoft Pull Request Bot

@jsynowiec
Copy link
Contributor Author

jsynowiec commented Mar 31, 2017

Ok, I now see why it was done using an internal command. Reading docs and looking into other ways of restoring the previous behavior rather than immediately resolving the CompletionItem without showing the item preview. All ideas are welcome.

Restore completion prompt for JSDoc autocomplete
27738a3 
Restores internal command but but as a separate class. Registers command on extension activation.
@jsynowiec
Copy link
Contributor Author

jsynowiec commented Mar 31, 2017

Hopefully all should be OK now.

@chrmarti
Copy link
Collaborator

chrmarti commented Mar 31, 2017

@jsynowiec Thanks for the PR! We're currently finishing the upcoming release and will look into it some time next week.

@mjbvz mjbvz added this to the April 2017 milestone Apr 3, 2017
@mjbvz mjbvz merged commit 70e074a into microsoft:master Apr 3, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Apr 3, 2017

Thanks @jsynowiec! This looks like a good change. It came in a little late for the upcoming March release but it should be in the April insiders builds once those resume and in the 1.12 release

@mjbvz mjbvz mentioned this pull request Apr 3, 2017
Closed
@jsynowiec jsynowiec deleted the feature/jsdoc-autocomplete-setting branch April 3, 2017 18:57
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

@mjbvz mjbvz

Labels

None yet

Projects

None yet

Milestone

April 2017

Development

Successfully merging this pull request may close these issues.

5 participants

@jsynowiec @mention-bot @msftclas @chrmarti @mjbvz