[20231027]Feat/support tips feature (#4)

* support login with AKSK input

* add aksk input

* login with AKSK: 1.store aksk in process. 2.add refresh feature. 3.add icon pkg.

* add aksk input

* support: set aksk and terraform init/plan/apply/destroy cmd

* update tiat-resource.config

* 1.add res doc redirect function. 2.adjust tips logic.

* 1.scrape tool. 2.adjust package.json for npm compile.

package.json

@@ -256,18 +256,23 @@
         "mocha": "^10.1.0",
         "tsconfig-paths": "^4.2.0",
         "typescript": "^4.9.4",
-        "vscode": "^1.1.34"
+        "vscode": "^1.1.34",
+        "@types/cheerio": "^0.22.33",
+        "cheerio": "^1.0.0-rc.12"
     },
     "dependencies": {
+        "@types/jsdom": "^21.1.4",
         "@types/strip-ansi": "^5.2.1",
         "all": "^0.0.0",
         "asynckit": "^0.4.0",
         "axios": "^1.3.5",
         "chalk": "^4.1.2",
         "fs-extra": "^11.1.0",
         "inversify": "^6.0.1",
+        "jsdom": "^22.1.0",
         "lodash": "^4.17.21",
         "lodash-es": "^4.17.21",
+        "marked": "^0.3.6",
         "opn": "^6.0.0",
         "reflect-metadata": "^0.1.13",
         "shared": "^0.2.0",
@@ -278,4 +283,4 @@
         "vscode-extension-telemetry-wrapper": "^0.13.3",
         "vscode-nls-i18n": "^0.2.4"
     }
-}
+}

src/autocomplete/TerraformExampleProvider.ts

@@ -0,0 +1,21 @@
+import { CompletionItemProvider, TextDocument, Position, CancellationToken, CompletionItem } from "vscode";
+import resources from '../../config/tips/tiat-resources.json';
+import * as _ from "lodash";
+
+var topLevelTypes = ["output", "provider", "resource", "variable", "data"];
+var topLevelRegexes = topLevelTypes.map(o => {
+    return {
+        type: o,
+        regex: new RegExp(o + ' "[A-Za-z0-9\-_]+" "[A-Za-z0-9\-_]*" \{')
+    };
+});
+
+export class TerraformExampleProvider implements CompletionItemProvider {
+    document: TextDocument;
+    position: Position;
+    token: CancellationToken;
+
+    public provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): CompletionItem[] {
+        return [];
+    }
+}

src/autocomplete/TerraformHoverProvider.ts

@@ -0,0 +1,18 @@
+import { HoverProvider, TextDocument, Position, CancellationToken, CompletionItem, CompletionItemKind, Hover, ProviderResult } from "vscode";
+import resources from '../../config/tips/tiat-resources.json';
+import * as _ from "lodash";
+
+var topLevelTypes = ["output", "provider", "resource", "variable", "data"];
+var topLevelRegexes = topLevelTypes.map(o => {
+    return {
+        type: o,
+        regex: new RegExp(o + ' "[A-Za-z0-9\-_]+" "[A-Za-z0-9\-_]*" \{')
+    };
+});
+
+export class TerraformHoverProvider implements HoverProvider {
+    provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover> {
+        throw new Error("Method not implemented.");
+    }
+
+}

src/autocomplete/TerraformResDocProvider.ts

@@ -0,0 +1,28 @@
+import {
+    DefinitionProvider,
+    TextDocument,
+    Position,
+    CancellationToken,
+    Definition
+} from "vscode";
+import * as _ from "lodash";
+// import * as opn from "opn";
+import opn from "opn";
+import resources from '../../config/tips/tiat-resources.json';
+
+const urlPrefix = "https://www.terraform.io";
+
+export class TerraformResDocProvider implements DefinitionProvider {
+    public provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition {
+        const words = document.getWordRangeAtPosition(position);
+        const resName = document.getText(words);
+
+        const found = _.get(resources, resName);
+        const urlSuffix = found.url?.toString() || "";
+        var target = <string>(urlPrefix + urlSuffix);
+        if (urlSuffix && target) {
+            opn(target);
+        }
+        return null;
+    }
+}

src/autocomplete/TerraformCompletionProvider.ts → src/autocomplete/TerraformTipsProvider.ts

@@ -1,6 +1,5 @@
 import { CompletionItemProvider, TextDocument, Position, CancellationToken, CompletionItem, CompletionItemKind } from "vscode";
-// var resources = require('../../config/snippets/tiat-resources.json');
-import resources from '../../config/snippets/tiat-resources.json';
+import resources from '../../config/tips/tiat-resources.json';
 import * as _ from "lodash";
 
 var topLevelTypes = ["output", "provider", "resource", "variable", "data"];
@@ -11,7 +10,7 @@ var topLevelRegexes = topLevelTypes.map(o => {
     };
 });
 
-export class TerraformCompletionProvider implements CompletionItemProvider {
+export class TerraformTipsProvider implements CompletionItemProvider {
     document: TextDocument;
     position: Position;
     token: CancellationToken;
@@ -31,7 +30,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
         }
 
         // Are we trying to type a variable?
-        if (this.isTypingVariable(lineTillCurrentPosition)) {
+        if (this.isTypingTfCode(lineTillCurrentPosition)) {
             // These variables should always just have 3 parts, resource type, resource name, exported field
             var varString = this.getVariableString(lineTillCurrentPosition);
             var parts = varString.split(".");
@@ -74,7 +73,6 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
         }
 
         // Are we trying to type a parameter to a resource?
-
         let possibleResources = this.checkTopLevelResource(lineTillCurrentPosition);
         if (possibleResources.length > 0) {
             return this.getHintsForStrings(possibleResources);
@@ -87,8 +85,8 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
             if (parentType && parentType.type === "resource") {
                 let resourceType = this.getResourceTypeFromLine(line);
                 let ret = this.getItemsForArgs(resources[resourceType].args, resourceType);
-                return ret;            
-            } 
+                return ret;
+            }
             else if (parentType && parentType.type !== "resource") {
                 // We don't want to accidentally include some other containers stuff
                 return [];
@@ -99,7 +97,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
     }
 
     getNamesForResourceType(document: TextDocument, resourceType: string): string[] {
-        var r = new RegExp('resource "' + resourceType +'" "([a-zA-Z0-9\-_]+)"');
+        var r = new RegExp('resource "' + resourceType + '" "([a-zA-Z0-9\-_]+)"');
         var found = [];
         for (var i = 0; i < document.lineCount; i++) {
             var line = document.lineAt(i).text;
@@ -128,7 +126,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
     }
 
     isTopLevelType(line: string): boolean {
-        for (var i=0; i<topLevelTypes.length; i++) {
+        for (var i = 0; i < topLevelTypes.length; i++) {
             var resourceType = topLevelTypes[i];
             if (resourceType.indexOf(line) === 0) {
                 return true;
@@ -138,7 +136,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
     }
 
     getTopLevelType(line: string): CompletionItem[] {
-        for (var i=0; i<topLevelTypes.length; i++) {
+        for (var i = 0; i < topLevelTypes.length; i++) {
             var resourceType = topLevelTypes[i];
             if (resourceType.indexOf(line) === 0) {
                 return [new CompletionItem(resourceType, CompletionItemKind.Enum)];
@@ -147,7 +145,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
         return [];
     }
 
-    isTypingVariable(line: string): boolean {
+    isTypingTfCode(line: string): boolean {
         var r = /\$\{[0-9a-zA-Z_\.\-]*$/;
         return r.test(line);
     }
@@ -183,7 +181,7 @@ export class TerraformCompletionProvider implements CompletionItemProvider {
         });
     }
 
-    getParentType(line: string): boolean|any {
+    getParentType(line: string): boolean | any {
         for (var i = 0; i < topLevelRegexes.length; i++) {
             let tl = topLevelRegexes[i];
             if (tl.regex.test(line)) {

src/extension.ts

@@ -6,14 +6,13 @@ import { init } from "vscode-nls-i18n";
 import { TerraformCommand, TerraformerCommand } from "./commons/customCmdRegister";
 import { terraformShellManager } from "./client/terminal/terraformShellManager";
 import { DialogOption } from "./utils/uiUtils";
-import { TerraformCompletionProvider } from './autocomplete/TerraformCompletionProvider';
-import { TerraformDefinitionProvider } from './autocomplete/TerraformDefinitionProvider';
-import { registerExternelCommands } from './commons';
+import { TerraformTipsProvider } from './autocomplete/TerraformTipsProvider';
+import { TerraformResDocProvider } from './autocomplete/TerraformResDocProvider';
+import { registerExternelCommands, bindExtensionContext } from './commons';
 import { registerView } from './views';
 import { TerraformRunner } from './client/runner/terraformRunner';
 import { TerraformerRunner } from './client/runner/terraformerRunner';
 import { GitUtils } from './utils/gitUtils';
-import { bindExtensionContext } from "./commons";
 import _ from 'lodash';
 
 const TF_MODE: vscode.DocumentFilter = { language: 'terraform', scheme: 'file' };
@@ -96,8 +95,8 @@ export async function activate(context: vscode.ExtensionContext) {
 
     // auto-complete
     console.log('activate the auto complete(snippets and lint) feature');
-    context.subscriptions.push(vscode.languages.registerCompletionItemProvider(TF_MODE, new TerraformCompletionProvider(), '.'));
-    context.subscriptions.push(vscode.languages.registerDefinitionProvider(TF_MODE, new TerraformDefinitionProvider()));
+    context.subscriptions.push(vscode.languages.registerCompletionItemProvider(TF_MODE, new TerraformTipsProvider(), '.'));
+    context.subscriptions.push(vscode.languages.registerDefinitionProvider(TF_MODE, new TerraformResDocProvider()));
 
     // import-resource
     console.log('activate the import feature');
@@ -107,4 +106,6 @@ export async function activate(context: vscode.ExtensionContext) {
 }
 
 // This method is called when your extension is deactivated
-export function deactivate() { }
+export function deactivate() {
+    /* TODO document why this function 'deactivate' is empty */
+}