feat(vscode): provide Run CodeLens on route handlers (#960)

Author: alestiago

extensions/vscode/README.md

@@ -8,6 +8,10 @@ Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
 
 Dart Frog can be installed from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) or by [searching within VS Code](https://code.visualstudio.com/docs/editor/extension-gallery#_search-for-an-extension).
 
+## Demonstration
+
+![demonstration](https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/extensions/vscode/assets/new-route-middleware-usage.gif)
+
 ## Commands
 
 | Command                                         | Description                          | Launch from                     |
@@ -18,17 +22,20 @@ Dart Frog can be installed from the [VS Code Marketplace](https://marketplace.vi
 | `Dart Frog: New Route`                          | Generates a new route                | Context menu or command palette |
 | `Dart Frog: New Middleware`                     | Generates a new middleware           | Context menu or command palette |
 | `Dart Frog: Start Daemon`                       | Starts the Dart Frog daemon          | Command palette                 |
-| `Dart Frog: Start Development Server`           | Starts a Dart Frog server            | Command palette                 |
+| `Dart Frog: Start Development Server`           | Starts a Dart Frog server            | Command palette and CodeLens    |
 | `Dart Frog: Debug Development Server`           | Debugs a Dart Frog server            | Command palette                 |
 | `Dart Frog: Start and Debug Development Server` | Starts and debugs a Dart Frog server | Command palette                 |
 | `Dart Frog: Stop Development Server`            | Stops a Dart Frog server             | Command palette                 |
 
-## Demonstration
+## Configuration
 
-![demonstration](https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/extensions/vscode/assets/new-route-middleware-usage.gif)
+| Name                       | Description                                         | Type    | Default |
+| -------------------------- | --------------------------------------------------- | ------- | ------- |
+| `dart-frog.enableCodeLens` | Whether or not to enable [CodeLens][code_lens_link] | Boolean | True    |
 
 [ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/main.yaml
 [dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog
 [license_link]: https://opensource.org/licenses/MIT
 [logo_black]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/assets/dart_frog_logo_black.png
 [very_good_ventures_link]: https://verygood.ventures
+[code_lens_link]: https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup

extensions/vscode/package.json

@@ -93,6 +93,14 @@
           "when": "!(resourceDirname =~ /routes/) && !(explorerResourceIsFolder && resourceFilename == routes)"
         }
       ]
+    },
+    "configuration": {
+      "properties": {
+        "dart-frog.enableCodeLens": {
+          "type": "boolean",
+          "default": true
+        }
+      }
     }
   },
   "extensionDependencies": [

extensions/vscode/src/code-lens/index.ts

@@ -0,0 +1 @@
+export * from "./on-request-code-lens";

extensions/vscode/src/code-lens/on-request-code-lens.ts

@@ -0,0 +1,116 @@
+import {
+  CodeLens,
+  CodeLensProvider,
+  Event,
+  EventEmitter,
+  Position,
+  ProviderResult,
+  TextDocument,
+  workspace,
+} from "vscode";
+import { nearestDartFrogProject } from "../utils";
+import path = require("path");
+
+abstract class ConfigurableCodeLensProvider implements CodeLensProvider {
+  protected codeLenses: CodeLens[] = [];
+
+  protected _onDidChangeCodeLenses: EventEmitter<void> =
+    new EventEmitter<void>();
+  public readonly onDidChangeCodeLenses: Event<void> =
+    this._onDidChangeCodeLenses.event;
+
+  constructor() {
+    workspace.onDidChangeConfiguration(() => {
+      this._onDidChangeCodeLenses.fire();
+    });
+  }
+
+  // eslint-disable-next-line no-unused-vars
+  public provideCodeLenses(document: TextDocument): ProviderResult<CodeLens[]> {
+    if (!this.hasEnabledCodeLenses()) {
+      return undefined;
+    }
+    return this.codeLenses;
+  }
+
+  public resolveCodeLens?(codeLens: CodeLens): ProviderResult<CodeLens> {
+    if (!this.hasEnabledCodeLenses()) {
+      return undefined;
+    }
+    return codeLens;
+  }
+
+  private hasEnabledCodeLenses(): boolean {
+    return workspace.getConfiguration("dart-frog").get("enableCodeLens", true);
+  }
+}
+
+// eslint-disable-next-line max-len
+abstract class RegularExpressionCodeLensProvider extends ConfigurableCodeLensProvider {
+  abstract readonly regex: RegExp;
+
+  public provideCodeLenses(document: TextDocument): ProviderResult<CodeLens[]> {
+    if (!super.provideCodeLenses(document)) {
+      return undefined;
+    }
+
+    this.codeLenses = [];
+    const text = document.getText();
+    let matches;
+    while ((matches = this.regex.exec(text)) !== null) {
+      const line = document.lineAt(document.positionAt(matches.index).line);
+      const indexOf = line.text.indexOf(matches[0]);
+      const position = new Position(line.lineNumber, indexOf);
+      const range = document.getWordRangeAtPosition(
+        position,
+        new RegExp(this.regex)
+      );
+      if (range) {
+        this.codeLenses.push(new CodeLens(range));
+      }
+    }
+    return this.codeLenses;
+  }
+}
+
+// eslint-disable-next-line max-len
+abstract class OnRequestCodeLensProvider extends RegularExpressionCodeLensProvider {
+  readonly regex: RegExp = /Response\s*onRequest\(RequestContext .*?\)\s*{/g;
+
+  public provideCodeLenses(document: TextDocument): ProviderResult<CodeLens[]> {
+    if (document.languageId !== "dart") {
+      return undefined;
+    }
+
+    const dartFrogProjectPath = nearestDartFrogProject(document.uri.fsPath);
+    if (!dartFrogProjectPath) {
+      return undefined;
+    }
+
+    const routesPath = path.join(dartFrogProjectPath, "routes");
+    if (!document.uri.fsPath.startsWith(routesPath)) {
+      return undefined;
+    }
+
+    return super.provideCodeLenses(document);
+  }
+}
+
+/**
+ * Shows a "Run" CodeLens on route handlers, which allows starting a development
+ * server.
+ */
+export class RunOnRequestCodeLensProvider extends OnRequestCodeLensProvider {
+  public resolveCodeLens?(codeLens: CodeLens): ProviderResult<CodeLens> {
+    if (!super.resolveCodeLens!(codeLens)) {
+      return undefined;
+    }
+
+    codeLens.command = {
+      title: "Run",
+      tooltip: "Starts a development server",
+      command: "dart-frog.start-dev-server",
+    };
+    return codeLens;
+  }
+}

extensions/vscode/src/extension.ts

@@ -19,6 +19,7 @@ import {
   readLatestDartFrogCLIVersion,
   suggestInstallingDartFrogCLI,
 } from "./utils";
+import { RunOnRequestCodeLensProvider } from "./code-lens";
 
 /**
  * This method is called when the extension is activated.
@@ -41,6 +42,11 @@ export function activate(
     ensureCompatibleCLI();
   }
 
+  vscode.languages.registerCodeLensProvider(
+    "dart",
+    new RunOnRequestCodeLensProvider()
+  );
+
   context.subscriptions.push(
     vscode.commands.registerCommand("dart-frog.create", create),
     vscode.commands.registerCommand("dart-frog.install-cli", installCLI),