deprecated functions, quick fix for $zobjxxx, ignore commands in &sql

daimor · daimor · commit 1625bbec1b03 · 2020-01-04T12:22:32.000+03:00
diff --git a/src/extension.ts b/src/extension.ts
@@ -63,6 +63,7 @@ export let panel: vscode.StatusBarItem;
 export let terminal: vscode.Terminal;
 
 import TelemetryReporter from "vscode-extension-telemetry";
+import { CodeActionProvider } from "./providers/CodeActionProvider";
 
 const packageJson = vscode.extensions.getExtension(extensionId).packageJSON;
 const extensionVersion = packageJson.version;
@@ -312,6 +313,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
     vscode.languages.setLanguageConfiguration("objectscript-class", getLanguageConfiguration("class")),
     vscode.languages.setLanguageConfiguration("objectscript", getLanguageConfiguration("routine")),
     vscode.languages.setLanguageConfiguration("objectscript-macros", getLanguageConfiguration("routine")),
+    vscode.languages.registerCodeActionsProvider(
+      documentSelector("objectscript-class", "objectscript"),
+      new CodeActionProvider()
+    ),
     vscode.languages.registerDocumentSymbolProvider(
       documentSelector("objectscript-class"),
       new ObjectScriptClassSymbolProvider()
diff --git a/src/providers/CodeActionProvider.ts b/src/providers/CodeActionProvider.ts
@@ -0,0 +1,51 @@
+import * as vscode from "vscode";
+import { Formatter } from "./Formatter";
+
+export class CodeActionProvider implements vscode.CodeActionProvider {
+  private _formatter: Formatter;
+  public constructor() {
+    this._formatter = new Formatter();
+  }
+
+  public provideCodeActions(
+    document: vscode.TextDocument,
+    range: vscode.Range | vscode.Selection,
+    context: vscode.CodeActionContext,
+    token: vscode.CancellationToken
+  ): vscode.ProviderResult<(vscode.Command | vscode.CodeAction)[]> {
+    const codeActions: vscode.CodeAction[] = [];
+    context.diagnostics.forEach(diagnostic => {
+      if (diagnostic.code === "$zobjxxx") {
+        const text = document.getText(diagnostic.range).toLowerCase();
+        let replacement = "";
+        switch (text) {
+          case "$zobjclassmethod":
+            replacement = "$classmethod";
+            break;
+          case "$zobjmethod":
+            replacement = "$method";
+            break;
+          case "$zobjproperty":
+            replacement = "$property";
+            break;
+          case "$zobjclass":
+            replacement = "$classname";
+            break;
+          default:
+        }
+        if (replacement.length) {
+          replacement = this._formatter.function(replacement);
+          codeActions.push(this.createFix(document, diagnostic.range, replacement));
+        }
+      }
+    });
+    return codeActions;
+  }
+
+  private createFix(document: vscode.TextDocument, range: vscode.Range, replacement: string): vscode.CodeAction {
+    const fix = new vscode.CodeAction(`Replace with ${replacement}`, vscode.CodeActionKind.QuickFix);
+    fix.edit = new vscode.WorkspaceEdit();
+    fix.edit.replace(document.uri, range, replacement);
+    return fix;
+  }
+}
diff --git a/src/providers/ObjectScriptDiagnosticProvider.ts b/src/providers/ObjectScriptDiagnosticProvider.ts
@@ -96,6 +96,8 @@ export class ObjectScriptDiagnosticProvider {
     let endingComma = false;
     let isCode = !isClass;
     let jsScript = false;
+    let sql = false;
+    let sqlParens = 0;
     for (let i = 0; i < document.lineCount; i++) {
       const line = document.lineAt(i);
       const text = this.stripLineComments(line.text);
@@ -106,6 +108,19 @@ export class ObjectScriptDiagnosticProvider {
         jsScript = true;
       }
 
+      if (text.match("&sql")) {
+        sql = true;
+        sqlParens = 0;
+      }
+
+      if (sql) {
+        sqlParens = sqlParens + (text.split("(").length - 1) - (text.split(")").length - 1);
+        if (sqlParens <= 0) {
+          sql = false;
+        }
+        continue;
+      }
+
       if (jsScript) {
         if (text.match(/<\/script>/)) {
           jsScript = false;
@@ -151,8 +166,9 @@ export class ObjectScriptDiagnosticProvider {
             code: "",
             message: "Unrecognized command",
             range,
-            severity: vscode.DiagnosticSeverity.Error,
-            source: "",
+            severity: found.toUpperCase().startsWith("Z")
+              ? vscode.DiagnosticSeverity.Warning
+              : vscode.DiagnosticSeverity.Error,
             relatedInformation: [
               new vscode.DiagnosticRelatedInformation(
                 new vscode.Location(document.uri, range),
@@ -211,11 +227,11 @@ export class ObjectScriptDiagnosticProvider {
         );
         if (!systemFunction) {
           result.push({
-            code: "",
-            message: "Unrecognized system function/variable",
             range,
-            severity: vscode.DiagnosticSeverity.Error,
-            source: "",
+            message: "Unrecognized system function/variable",
+            severity: found.toUpperCase().startsWith("$Z")
+              ? vscode.DiagnosticSeverity.Warning
+              : vscode.DiagnosticSeverity.Error,
             relatedInformation: [
               new vscode.DiagnosticRelatedInformation(
                 new vscode.Location(document.uri, range),
@@ -224,6 +240,21 @@ export class ObjectScriptDiagnosticProvider {
             ],
           });
         }
+        if (systemFunction && systemFunction.deprecated) {
+          result.push({
+            range,
+            code: systemFunction.code || "",
+            severity: vscode.DiagnosticSeverity.Warning,
+            message: "Deprecated system function/variable",
+            tags: [vscode.DiagnosticTag.Deprecated],
+            relatedInformation: [
+              new vscode.DiagnosticRelatedInformation(
+                new vscode.Location(document.uri, range),
+                `System function or variable '${found}' deprecated`
+              ),
+            ],
+          });
+        }
       }
     }
     return result;
diff --git a/src/providers/ObjectScriptHoverProvider.ts b/src/providers/ObjectScriptHoverProvider.ts
@@ -89,9 +89,11 @@ export class ObjectScriptHoverProvider implements vscode.HoverProvider {
     }
   }
 
-  public documentationLink(link): string | null {
+  public documentationLink(link: string): string | null {
     if (link) {
-      return `[Online documenation](https://docs.intersystems.com/irislatest${link})`;
+      return `[Online documenation](${
+        link.startsWith("http") ? "" : "https://docs.intersystems.com/irislatest"
+      }${link})`;
     }
     return;
   }
diff --git a/src/providers/completion/systemFunctions.json b/src/providers/completion/systemFunctions.json
@@ -1774,6 +1774,62 @@
     ],
     "link":"/csp/docbook/DocBook.UI.Page.cls?KEY=RCOS_fzname"
   },
+  {
+    "label": "$ZOBJCLASSMETHOD",
+    "alias": [
+      "$ZOBJCLASSMETHOD"
+    ],
+    "deprecated": true,
+    "documentation": [
+      "The $ZOBJCLASSMETHOD functions have been replaced with standard Caché functions. ",
+      "The $ZOBJCLASSMETHOD functions are still available to applications, but they are no longer documented.",
+      "Replaced by `$CLASSMETHOD`"
+    ],
+    "link": "https://cedocs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GCRNA_upgrade20101_zobj",
+    "code": "$zobjxxx"
+  },
+  {
+    "label": "$ZOBJMETHOD",
+    "alias": [
+      "$ZOBJMETHOD"
+    ],
+    "deprecated": true,
+    "documentation": [
+      "The $ZOBJMETHOD functions have been replaced with standard Caché functions. ",
+      "The $ZOBJMETHOD functions are still available to applications, but they are no longer documented.",
+      "Replaced by `$METHOD`"
+    ],
+    "link": "https://cedocs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GCRNA_upgrade20101_zobj",
+    "code": "$zobjxxx"
+  },
+  {
+    "label": "$ZOBJPROPERTY",
+    "alias": [
+      "$ZOBJPROPERTY"
+    ],
+    "deprecated": true,
+    "documentation": [
+      "The $ZOBJPROPERTY functions have been replaced with standard Caché functions. ",
+      "The $ZOBJPROPERTY functions are still available to applications, but they are no longer documented.",
+      "Replaced by `$PROPERTY`"
+    ],
+    "link": "https://cedocs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GCRNA_upgrade20101_zobj",
+    "code": "$zobjxxx"
+  },
+  {
+    "label": "$ZOBJCLASS",
+    "alias": [
+      "$ZOBJCLASS"
+    ],
+    "deprecated": true,
+    "documentation": [
+      "The $ZOBJCLASS functions have been replaced with standard Caché functions. ",
+      "The $ZOBJCLASS functions are still available to applications, but they are no longer documented.",
+      "Replaced by `$CLASSNAME`"
+    ],
+    "link": "https://cedocs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GCRNA_upgrade20101_zobj",
+    "code": "$zobjxxx"
+  },
   {
     "label":"$ZPOSITION",
     "alias":[

Original file line number	Diff line number	Diff line change
`@@ -89,9 +89,11 @@ export class ObjectScriptHoverProvider implements vscode.HoverProvider {`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`		`- public documentationLink(link): string \| null {`
	`92`	`+ public documentationLink(link: string): string \| null {`
`93`	`93`	`if (link) {`
`94`		- return `[Online documenation](https://docs.intersystems.com/irislatest${link})`;
	`94`	+ return `[Online documenation](${
	`95`	`+ link.startsWith("http") ? "" : "https://docs.intersystems.com/irislatest"`
	`96`	+ }${link})`;
`95`	`97`	`}`
`96`	`98`	`return;`
`97`	`99`	`}`