Add Markdown support to run requests with code lenses (#933)

* Support sending requests from Markdown code blocks

* Activate the extension on Markdown as well

* Add docs for Markdown code lenses

* Fix linting error

Co-authored-by: Huachao Mao <[email protected]>

Author: acuarica

README.md

@@ -57,6 +57,7 @@ REST Client allows you to send HTTP request and view the response in Visual Stud
     - Support navigate to symbol definitions(request and file level custom variable) in open `http` file
     - CodeLens support to add an actionable link to send request
     - Fold/Unfold for request block
+* Support for Markdown fenced code blocks with either `http` or `rest`
 
 ## Usage
 In editor, type an HTTP request as simple as below:

package.json

@@ -54,7 +54,8 @@
     "onCommand:rest-client.copy-request-as-curl",
     "onCommand:rest-client.fold-response",
     "onCommand:rest-client.unfold-response",
-    "onLanguage:http"
+    "onLanguage:http",
+    "onLanguage:markdown"
   ],
   "main": "./dist/extension",
   "contributes": {

src/extension.ts

@@ -15,6 +15,7 @@ import { FileVariableReferencesCodeLensProvider } from './providers/fileVariable
 import { HttpCodeLensProvider } from './providers/httpCodeLensProvider';
 import { HttpCompletionItemProvider } from './providers/httpCompletionItemProvider';
 import { HttpDocumentSymbolProvider } from './providers/httpDocumentSymbolProvider';
+import { MarkdownCodeLensProvider } from './providers/markdownCodeLensProvider';
 import { RequestVariableCompletionItemProvider } from "./providers/requestVariableCompletionItemProvider";
 import { RequestVariableDefinitionProvider } from './providers/requestVariableDefinitionProvider';
 import { RequestVariableHoverProvider } from './providers/requestVariableHoverProvider';
@@ -54,6 +55,10 @@ export async function activate(context: ExtensionContext) {
         { language: 'http', scheme: '*' }
     ];
 
+    const mdDocumentSelector = [
+        { language: 'markdown', scheme: '*' }
+    ];
+
     context.subscriptions.push(languages.registerCompletionItemProvider(documentSelector, new HttpCompletionItemProvider()));
     context.subscriptions.push(languages.registerCompletionItemProvider(documentSelector, new RequestVariableCompletionItemProvider(), '.'));
     context.subscriptions.push(languages.registerHoverProvider(documentSelector, new EnvironmentOrFileVariableHoverProvider()));
@@ -66,6 +71,10 @@ export async function activate(context: ExtensionContext) {
         new ConfigurationDependentRegistration(
             () => languages.registerCodeLensProvider(documentSelector, new FileVariableReferencesCodeLensProvider()),
             s => s.enableCustomVariableReferencesCodeLens));
+    context.subscriptions.push(
+        new ConfigurationDependentRegistration(
+            () => languages.registerCodeLensProvider(mdDocumentSelector, new MarkdownCodeLensProvider()),
+            s => s.enableSendRequestCodeLens));
     context.subscriptions.push(languages.registerDocumentLinkProvider(documentSelector, new RequestBodyDocumentLinkProvider()));
     context.subscriptions.push(languages.registerDefinitionProvider(documentSelector, new FileVariableDefinitionProvider()));
     context.subscriptions.push(languages.registerDefinitionProvider(documentSelector, new RequestVariableDefinitionProvider()));

src/providers/markdownCodeLensProvider.ts

@@ -0,0 +1,22 @@
+import { CancellationToken, CodeLens, CodeLensProvider, Command, Range, TextDocument } from 'vscode';
+import { Selector } from '../utils/selector';
+
+export class MarkdownCodeLensProvider implements CodeLensProvider {
+
+    public provideCodeLenses(document: TextDocument, _token: CancellationToken): Promise<CodeLens[]> {
+        const blocks: CodeLens[] = [];
+
+        for (const range of Selector.getMarkdownRestSnippets(document)) {
+            const snippetRange = new Range(range.start.line + 1, 0, range.end.line, 0);
+            const cmd: Command = {
+                arguments: [document, snippetRange],
+                title: 'Send Request',
+                command: 'rest-client.request',
+            };
+            blocks.push(new CodeLens(range, cmd));
+        }
+
+        return Promise.resolve(blocks);
+    }
+
+}

src/utils/selector.ts

@@ -1,5 +1,5 @@
 import { EOL } from 'os';
-import { Range, TextEditor, window } from 'vscode';
+import { Position, Range, TextDocument, TextEditor, window } from 'vscode';
 import * as Constants from '../common/constants';
 import { fromString as ParseReqMetaKey, RequestMetadata } from '../models/requestMetadata';
 import { SelectedRequest } from '../models/SelectedRequest';
@@ -28,7 +28,19 @@ export class Selector {
         let selectedText: string | null;
         if (editor.selection.isEmpty || range) {
             const activeLine = range?.start.line ?? editor.selection.active.line;
-            selectedText = this.getDelimitedText(editor.document.getText(), activeLine);
+            if (editor.document.languageId === 'markdown') {
+                selectedText = null;
+
+                for (const r of Selector.getMarkdownRestSnippets(editor.document)) {
+                    const snippetRange = new Range(r.start.line + 1, 0, r.end.line, 0);
+                    if (snippetRange.contains(new Position(activeLine, 0))) {
+                        selectedText = editor.document.getText(snippetRange);
+                    }
+                }
+
+            } else {
+                selectedText = this.getDelimitedText(editor.document.getText(), activeLine);
+            }
         } else {
             selectedText = editor.document.getText(editor.selection);
         }
@@ -231,6 +243,31 @@ export class Selector {
             .map(([index, ]) => +index);
     }
 
+    public static* getMarkdownRestSnippets(document: TextDocument): Generator<Range> {
+        const snippetStartRegx = new RegExp('^\`\`\`(' + ['http', 'rest'].join('|') + ')$');
+        const snippetEndRegx = /^\`\`\`$/;
+
+        let snippetStart: number | null = null;
+        for (let i = 0; i < document.lineCount; i++) {
+            const lineText = document.lineAt(i).text;
+
+            const matchEnd = lineText.match(snippetEndRegx);
+            if (snippetStart !== null && matchEnd) {
+                const snippetEnd = i;
+
+                const range = new Range(snippetStart, 0, snippetEnd, 0);
+                yield range;
+
+                snippetStart = null;
+            } else {
+                const matchStart = lineText.match(snippetStartRegx);
+                if (matchStart) {
+                    snippetStart = i;
+                }
+            }
+        }
+    }
+
     private static handlePromptMetadata(metadatas: Map<RequestMetadata, string | undefined> , text: string) {
         const promptVarDef = this.getPrompVariableDefinition(text);
         if (promptVarDef) {