Merge pull request #710 from jpogran/gh-709-puppetfile-autocomplete

(GH-709) Puppetfile autocomplete

Author: jpogran

package-lock.json

@@ -9,6 +9,7 @@ import { IFeature } from './feature';
 import { DebuggingFeature } from './feature/DebuggingFeature';
 import { FormatDocumentFeature } from './feature/FormatDocumentFeature';
 import { PDKFeature } from './feature/PDKFeature';
+import { PuppetfileCompletionFeature } from './feature/PuppetfileCompletionFeature';
 import { PuppetfileHoverFeature } from './feature/PuppetfileHoverFeature';
 import { PuppetModuleHoverFeature } from './feature/PuppetModuleHoverFeature';
 import { PuppetNodeGraphFeature } from './feature/PuppetNodeGraphFeature';
@@ -85,6 +86,7 @@ export function activate(context: vscode.ExtensionContext) {
     new UpdateConfigurationFeature(logger, extContext),
     statusBar,
     new PuppetfileHoverFeature(extContext, logger),
+    new PuppetfileCompletionFeature(extContext, logger),
   ];
 
   if (configSettings.workspace.editorService.enable === false) {

src/extension.ts

@@ -0,0 +1,50 @@
+import * as vscode from 'vscode';
+import { IFeature } from '../feature';
+import { getPuppetModuleCompletion } from '../forge';
+import { ILogger } from '../logging';
+
+export class PuppetfileCompletionProvider implements vscode.CompletionItemProvider {
+  constructor(public logger: ILogger) {}
+  async provideCompletionItems(
+    document: vscode.TextDocument,
+    position: vscode.Position,
+    token: vscode.CancellationToken,
+    context: vscode.CompletionContext,
+  ): Promise<vscode.CompletionItem[] | vscode.CompletionList> {
+    // get all text until the `position` and check if it reads `mod.`
+    const linePrefix = document.lineAt(position).text.substr(0, position.character);
+    if (!linePrefix.startsWith('mod')) {
+      return undefined;
+    }
+
+    const completionText = document.getText(document.getWordRangeAtPosition(position));
+
+    const data = await getPuppetModuleCompletion(completionText, this.logger);
+
+    const l: vscode.CompletionList = new vscode.CompletionList();
+    data.modules.forEach((element) => {
+      l.items.push(new vscode.CompletionItem(element, vscode.CompletionItemKind.Module));
+    });
+
+    return l;
+  }
+
+  resolveCompletionItem?(
+    item: vscode.CompletionItem,
+    token: vscode.CancellationToken,
+  ): vscode.ProviderResult<vscode.CompletionItem> {
+    throw new Error('Method not implemented.');
+  }
+}
+
+export class PuppetfileCompletionFeature implements IFeature {
+  constructor(public context: vscode.ExtensionContext, public logger: ILogger) {
+    const selector = [{ scheme: 'file', language: 'puppetfile' }];
+    context.subscriptions.push(
+      vscode.languages.registerCompletionItemProvider(selector, new PuppetfileCompletionProvider(logger)),
+    );
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  dispose() {}
+}

src/feature/PuppetfileCompletionFeature.ts

@@ -2,6 +2,11 @@ import axios from 'axios';
 import { extensions, MarkdownString } from 'vscode';
 import { ILogger } from './logging';
 
+export interface PuppetForgeCompletionInfo {
+  total: number;
+  modules: string[];
+}
+
 export interface PuppetForgeModuleInfo {
   uri: string;
   slug: string;
@@ -108,3 +113,38 @@ export function getModuleInfo(title: string, logger: ILogger): Promise<PuppetFor
       });
   });
 }
+
+export function getPuppetModuleCompletion(text: string, logger: ILogger): Promise<PuppetForgeCompletionInfo> {
+  return new Promise((resolve) => {
+    return axios
+      .get(`https://forgeapi.puppet.com/private/modules?starts_with=${text}`, {
+        params: {
+          // eslint-disable-next-line @typescript-eslint/camelcase
+          exclude_fields: 'readme changelog license reference',
+        },
+        headers: {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'User-Agent': `puppet-vscode/${getVersion()}`,
+        },
+      })
+      .then((response) => {
+        if (response.status !== 200) {
+          logger.error(`Error getting Puppet forge data. Status: ${response.status}:${response.statusText}`);
+          resolve();
+        }
+
+        const info = response.data;
+        const results: string[] = info.results as string[];
+        const data = {
+          total: parseInt(info.total),
+          modules: results,
+        };
+
+        resolve(data);
+      })
+      .catch((error) => {
+        logger.error(`Error getting Puppet forge data: ${error}`);
+        resolve();
+      });
+  });
+}