new code formatter

Author: daimor

CHANGELOG.md

@@ -1,8 +1,10 @@
 # Change Log
 
-## [0.7.6]
+## [0.7.7]
 
 - Completion for ObjectScript Commands
+- Hover documentation for ObjectScript commands
+- Text formatter for ObjectScript commands
 
 ## [0.7.4]
 

extension.ts

@@ -14,6 +14,7 @@ import { ObjectScriptFoldingRangeProvider } from './providers/ObjectScriptFoldin
 import { ObjectScriptDefinitionProvider } from './providers/ObjectScriptDefinitionProvider';
 import { ObjectScriptCompletionItemProvider } from './providers/ObjectScriptCompletionItemProvider';
 import { ObjectScriptHoverProvider } from './providers/ObjectScriptHoverProvider';
+import { DocumentFormattingEditProvider } from './providers/DocumentFormattingEditProvider';
 
 import { ObjectScriptExplorerProvider } from './explorer/explorer';
 import { outputChannel } from './utils';
@@ -95,11 +96,16 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
       new ObjectScriptCompletionItemProvider(),
       '$',
       '^',
-      '.'
+      '.',
+      '#'
     ),
     vscode.languages.registerHoverProvider(
       ['objectscript-class', 'objectscript', 'objectscript-macros'],
       new ObjectScriptHoverProvider()
+    ),
+    vscode.languages.registerDocumentFormattingEditProvider(
+      ['objectscript-class', 'objectscript', 'objectscript-macros'],
+      new DocumentFormattingEditProvider()
     )
   );
 }

package.json

@@ -2,7 +2,7 @@
   "name": "vscode-objectscript",
   "displayName": "InterSystems ObjectScript",
   "description": "InterSystems ObjectScript language support for Visual Studio Code",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "icon": "images/logo.png",
   "categories": [
     "Programming Languages",

providers/DocumentFormattingEditProvider.ts

@@ -0,0 +1,34 @@
+import * as vscode from 'vscode';
+
+import commands = require('./completion/commands.json');
+
+export class DocumentFormattingEditProvider implements vscode.DocumentFormattingEditProvider {
+  provideDocumentFormattingEdits(
+    document: vscode.TextDocument,
+    options: vscode.FormattingOptions,
+    token: vscode.CancellationToken
+  ): vscode.ProviderResult<vscode.TextEdit[]> {
+    let edits = [];
+
+    for (var i = 0; i < document.lineCount; i++) {
+      var line = document.lineAt(i);
+
+      let commandsMatch = line.text.match(/^\s+(?:}\s)?\b([a-z]+)\b/i);
+      if (commandsMatch) {
+        let [, found] = commandsMatch;
+        found = found;
+        let pos = line.text.indexOf(found);
+        let command = commands.find(el => el.alias.includes(found.toUpperCase()));
+        if (command.label !== found) {
+          let range = new vscode.Range(new vscode.Position(i, pos), new vscode.Position(i, pos + found.length));
+          edits.push({
+            range,
+            newText: command.label
+          });
+        }
+      }
+    }
+
+    return edits;
+  }
+}

providers/ObjectScriptCompletionItemProvider.ts

@@ -12,7 +12,37 @@ export class ObjectScriptCompletionItemProvider implements vscode.CompletionItem
     token: vscode.CancellationToken,
     context: vscode.CompletionContext
   ): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> {
-    return this.dollarsComplete(document, position) || this.commands(document, position);
+    if (context.triggerCharacter === '#') return this.macro(document, position, token, context);
+    return (
+      this.dollarsComplete(document, position) ||
+      this.commands(document, position) ||
+      this.macro(document, position, token, context)
+    );
+  }
+
+  macro(
+    document: vscode.TextDocument,
+    position: vscode.Position,
+    token: vscode.CancellationToken,
+    context: vscode.CompletionContext
+  ): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> {
+    let line = document.getText(new vscode.Range(new vscode.Position(position.line, 0), position));
+    let range = new vscode.Range(new vscode.Position(position.line, line.indexOf('#')), position);
+    if (!context.triggerCharacter && !line.match(/#+\b\w+\b$/)) {
+      return null;
+    }
+    return [
+      {
+        label: '##class()',
+        insertText: new vscode.SnippetString('##class($0)'),
+        range
+      },
+      {
+        label: '##super()',
+        insertText: new vscode.SnippetString('##super($0)'),
+        range
+      }
+    ];
   }
 
   commands(
@@ -24,7 +54,7 @@ export class ObjectScriptCompletionItemProvider implements vscode.CompletionItem
       new vscode.Range(new vscode.Position(word.start.line, 0), new vscode.Position(word.end.line, word.end.character))
     );
 
-    if (line.match(/\s+\b[a-z]+\b/i)) {
+    if (line.match(/^\s+\b[a-z]+\b$/i)) {
       let search = line.trim().toUpperCase();
       let items = commands
         .filter(el => el.label.startsWith(search) || el.alias.findIndex(el2 => el2.startsWith(search)) >= 0)
@@ -33,7 +63,7 @@ export class ObjectScriptCompletionItemProvider implements vscode.CompletionItem
           kind: vscode.CompletionItemKind.Keyword,
           preselect: el.alias.includes(search),
           documentation: new vscode.MarkdownString(el.documentation.join('')),
-          insertText: el.insertText ? new vscode.SnippetString(el.insertText) : el.label
+          insertText: new vscode.SnippetString(el.insertText || `${el.label} $0`)
         }));
       return {
         isIncomplete: items.length > 0,
@@ -60,12 +90,9 @@ export class ObjectScriptCompletionItemProvider implements vscode.CompletionItem
       if (dollars === '$') {
         let range = new vscode.Range(
           new vscode.Position(word.start.line, word.start.character - 1),
-          new vscode.Position(word.end.line, word.end.character + (textAfter.startsWith('(') ? 1 : 0))
+          new vscode.Position(word.end.line, word.end.character)
         );
-        let items = [
-          ...this.listSystemFunctions(search, textAfter.startsWith('(')),
-          ...this.listSystemVariables(search)
-        ];
+        let items = [...this.listSystemFunctions(search, textAfter.length > 0), ...this.listSystemVariables(search)];
         return {
           isIncomplete: items.length > 1,
           items: items.map(el => {
@@ -78,9 +105,9 @@ export class ObjectScriptCompletionItemProvider implements vscode.CompletionItem
       } else if (dollars === '^$') {
         let range = new vscode.Range(
           new vscode.Position(word.start.line, word.start.character - 2),
-          new vscode.Position(word.end.line, word.end.character + (textAfter.startsWith('(') ? 1 : 0))
+          new vscode.Position(word.end.line, word.end.character)
         );
-        return this.listStructuredSystemVariables(search, textAfter.startsWith('(')).map(el => {
+        return this.listStructuredSystemVariables(search, textAfter.length > 0).map(el => {
           return {
             ...el,
             range

providers/ObjectScriptHoverProvider.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 
+import commands = require('./completion/commands.json');
 import systemFunctions = require('./completion/systemFunctions.json');
 import systemVariables = require('./completion/systemVariables.json');
 import structuredSystemVariables = require('./completion/structuredSystemVariables.json');
@@ -10,6 +11,10 @@ export class ObjectScriptHoverProvider implements vscode.HoverProvider {
     position: vscode.Position,
     token: vscode.CancellationToken
   ): vscode.ProviderResult<vscode.Hover> {
+    return this.dollars(document, position) || this.commands(document, position);
+  }
+
+  dollars(document: vscode.TextDocument, position: vscode.Position): vscode.ProviderResult<vscode.Hover> {
     let word = document.getWordRangeAtPosition(position);
     let text = document.getText(
       new vscode.Range(new vscode.Position(position.line, 0), new vscode.Position(position.line, word.end.character))
@@ -38,6 +43,24 @@ export class ObjectScriptHoverProvider implements vscode.HoverProvider {
     return null;
   }
 
+  commands(document: vscode.TextDocument, position: vscode.Position): vscode.ProviderResult<vscode.Hover> {
+    let word = document.getWordRangeAtPosition(position);
+    let text = document.getText(
+      new vscode.Range(new vscode.Position(position.line, 0), new vscode.Position(position.line, word.end.character))
+    );
+    let commandMatch = text.match(/^\s+\b[a-z]+\b$/i);
+    if (commandMatch) {
+      let search = text.trim().toUpperCase();
+      let command = commands.find(el => el.label === search || el.alias.includes(search));
+      if (search) {
+        return {
+          range: word,
+          contents: [command.documentation.join(''), this.documentationLink(command.link)]
+        };
+      }
+    }
+  }
+
   documentationLink(link): string | null {
     if (link) {
       return `[Online documenation](https://docs.intersystems.com/irislatest${link})`;