Add poweshell.helpCompletion setting to control/disable feature (#1282)

* Add poweshell.helpCompletion setting to control/disable feature

Changing this setting does require a reload window.

Trigger sequence changed to just "##".

Fix #1228

* Rename triggerFinderLineComment field per PR review

Author: rkeithhill

package.json

@@ -447,6 +447,16 @@
           "default": "https://github.com/PowerShell/vscode-powershell",
           "description": "Specifies the url of the GitHub project in which to generate bug reports."
         },
+        "powershell.helpCompletion": {
+          "type": "string",
+          "enum": [
+            "Disabled",
+            "BlockComment",
+            "LineComment"
+          ],
+          "default": "BlockComment",
+          "description": "Controls the comment-based help completion behavior triggered by typing '##'. Set the generated help style with 'BlockComment' or 'LineComment'. Disable the feature with 'Disabled'."
+        },
         "powershell.scriptAnalysis.enable": {
           "type": "boolean",
           "default": true,

src/features/HelpCompletion.ts

@@ -7,6 +7,7 @@ import { Disposable, EndOfLine, Position, Range, SnippetString,
 import { LanguageClient, RequestType } from "vscode-languageclient";
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
+import Settings = require("../settings");
 
 export const CommentHelpRequestType =
     new RequestType<any, any, void, void>("powerShell/getCommentHelp");
@@ -27,21 +28,30 @@ export class HelpCompletionFeature implements IFeature {
     private helpCompletionProvider: HelpCompletionProvider;
     private languageClient: LanguageClient;
     private disposable: Disposable;
+    private settings: Settings.ISettings;
 
     constructor(private log: Logger) {
-        this.helpCompletionProvider = new HelpCompletionProvider();
-        const subscriptions = [];
-        workspace.onDidChangeTextDocument(this.onEvent, this, subscriptions);
-        this.disposable = Disposable.from(...subscriptions);
+        this.settings = Settings.load();
+
+        if (this.settings.helpCompletion !== Settings.HelpCompletion.Disabled) {
+            this.helpCompletionProvider = new HelpCompletionProvider();
+            const subscriptions = [];
+            workspace.onDidChangeTextDocument(this.onEvent, this, subscriptions);
+            this.disposable = Disposable.from(...subscriptions);
+        }
     }
 
     public dispose() {
-        this.disposable.dispose();
+        if (this.disposable) {
+            this.disposable.dispose();
+        }
     }
 
     public setLanguageClient(languageClient: LanguageClient) {
         this.languageClient = languageClient;
-        this.helpCompletionProvider.languageClient = languageClient;
+        if (this.helpCompletionProvider) {
+            this.helpCompletionProvider.languageClient = languageClient;
+        }
     }
 
     public onEvent(changeEvent: TextDocumentChangeEvent): void {
@@ -68,6 +78,7 @@ class TriggerFinder {
     private state: SearchState;
     private document: TextDocument;
     private count: number;
+
     constructor(private triggerCharacters: string) {
         this.state = SearchState.Searching;
         this.count = 0;
@@ -113,20 +124,20 @@ class TriggerFinder {
 }
 
 class HelpCompletionProvider {
-    private triggerFinderBlockComment: TriggerFinder;
-    private triggerFinderLineComment: TriggerFinder;
+    private triggerFinderHelpComment: TriggerFinder;
     private lastChangeText: string;
     private lastChangeRange: Range;
     private lastDocument: TextDocument;
     private langClient: LanguageClient;
+    private settings: Settings.ISettings;
 
     constructor() {
-        this.triggerFinderBlockComment = new TriggerFinder("<#");
-        this.triggerFinderLineComment = new TriggerFinder("##");
+        this.triggerFinderHelpComment = new TriggerFinder("##");
+        this.settings = Settings.load();
     }
 
     public get triggerFound(): boolean {
-        return this.triggerFinderBlockComment.found || this.triggerFinderLineComment.found;
+        return this.triggerFinderHelpComment.found;
     }
 
     public set languageClient(value: LanguageClient) {
@@ -137,13 +148,11 @@ class HelpCompletionProvider {
         this.lastDocument = document;
         this.lastChangeText = changeText;
         this.lastChangeRange = changeRange;
-        this.triggerFinderBlockComment.updateState(document, changeText);
-        this.triggerFinderLineComment.updateState(document, changeText);
+        this.triggerFinderHelpComment.updateState(document, changeText);
     }
 
     public reset(): void {
-        this.triggerFinderBlockComment.reset();
-        this.triggerFinderLineComment.reset();
+        this.triggerFinderHelpComment.reset();
     }
 
     public complete(): Thenable<void> {
@@ -161,7 +170,7 @@ class HelpCompletionProvider {
             {
                 documentUri: doc.uri.toString(),
                 triggerPosition: triggerStartPos,
-                blockComment: this.triggerFinderBlockComment.found,
+                blockComment: this.settings.helpCompletion === Settings.HelpCompletion.BlockComment,
             }).then((result) => {
                 if (result == null || result.content == null) {
                     return;

src/settings.ts

@@ -14,6 +14,12 @@ enum CodeFormattingPreset {
     Stroustrup,
 }
 
+export class HelpCompletion {
+    public static readonly Disabled: string = "Disabled";
+    public static readonly BlockComment: string = "BlockComment";
+    public static readonly LineComment: string = "LineComment";
+}
+
 export interface IPowerShellAdditionalExePathSettings {
     versionName: string;
     exePath: string;
@@ -61,6 +67,7 @@ export interface ISettings {
     startAutomatically?: boolean;
     useX86Host?: boolean;
     enableProfileLoading?: boolean;
+    helpCompletion: string;
     scriptAnalysis?: IScriptAnalysisSettings;
     debugging?: IDebuggingSettings;
     developer?: IDeveloperSettings;
@@ -132,6 +139,8 @@ export function load(): ISettings {
             configuration.get<boolean>("useX86Host", false),
         enableProfileLoading:
             configuration.get<boolean>("enableProfileLoading", false),
+        helpCompletion:
+            configuration.get<string>("helpCompletion", HelpCompletion.BlockComment),
         scriptAnalysis:
             configuration.get<IScriptAnalysisSettings>("scriptAnalysis", defaultScriptAnalysisSettings),
         debugging: