Search provider (#6)

Author: hasparus

packages/ethereum-viewer/package.json

@@ -15,13 +15,14 @@
   },
   "dependencies": {
     "fast-json-stable-stringify": "^2.1.0",
+    "match-sorter": "^6.3.1",
     "p-finally": "^2.0.1",
     "path-browserify": "^1.0.1",
     "ts-essentials": "^9.0.0"
   },
   "devDependencies": {
-    "typescript": "^4.5.3",
-    "@types/vscode": "^1.63.0"
+    "@types/vscode": "^1.63.0",
+    "typescript": "^4.5.3"
   },
   "engines": {
     "vscode": "^1.63.0"
@@ -32,6 +33,11 @@
   "categories": [
     "Other"
   ],
+  "enableProposedApi": true,
+  "enabledApiProposals": [
+    "fileSearchProvider",
+    "textSearchProvider"
+  ],
   "activationEvents": [
     "*"
   ],

packages/ethereum-viewer/src/extension.ts

@@ -1,10 +1,11 @@
-import path from "path/posix";
 import * as vscode from "vscode";
 
 import { addresses } from "./addresses";
 import * as etherscan from "./etherscan";
+import { StaticFileSearchProvider } from "./fileSearchProvider";
 import { FileSystem } from "./filesystem";
 import { fixtures } from "./test/fixtures";
+// import { StaticTextSearchProvider } from "./textSearchProvider";
 
 let initialized = false;
 const fs = FileSystem();
@@ -36,7 +37,7 @@ async function main(context: vscode.ExtensionContext) {
     name: network,
   });
 
-  let contractAddress: string | null = addresses.DAI;
+  let contractAddress: string | null = addresses.L1ChugSplashProxy;
 
   if (IN_DETH_HOST)
     contractAddress = await vscode.commands.executeCommand<string | null>(
@@ -55,13 +56,26 @@ async function main(context: vscode.ExtensionContext) {
 
   const mainFile = getMainContractFile(entries, info);
 
+  context.subscriptions.push(
+    vscode.workspace.registerFileSearchProvider(
+      "memfs",
+      new StaticFileSearchProvider(entries.map(([path]) => path))
+    )
+  );
+  // context.subscriptions.push(
+  //   vscode.workspace.registerTextSearchProvider(
+  //     "memfs",
+  //     new StaticTextSearchProvider(entries)
+  //   )
+  // );
+
   // We're instead trying to open the file even if it doesn't exist yet.
   await showTextDocument(mainFile);
   // This seems to be very slow:
   // // onFileChangeOnce(
   // //   context,
   // //   fs,
-  // //   mainFile,
+  // //   mainFile, 
   // //   (e) => void showTextDocument(e.uri.path)
   // // );
   // It's causing some errors in the console, but in the end it provides better UX.

packages/ethereum-viewer/src/fileSearchProvider.ts

@@ -0,0 +1,34 @@
+import { matchSorter } from "match-sorter";
+import {
+  CancellationToken,
+  Disposable,
+  FileSearchOptions,
+  FileSearchProvider,
+  FileSearchQuery,
+  ProviderResult,
+  Uri,
+} from "vscode";
+
+export class StaticFileSearchProvider
+  implements FileSearchProvider, Disposable
+{
+  static scheme = "github1s";
+  private readonly disposable?: Disposable;
+
+  // HACK: We don't support searching for added files.
+  constructor(private filePaths: string[]) {}
+
+  dispose() {
+    this.disposable?.dispose();
+  }
+
+  provideFileSearchResults(
+    query: FileSearchQuery,
+    _options: FileSearchOptions,
+    _token: CancellationToken
+  ): ProviderResult<Uri[]> {
+    return matchSorter(this.filePaths, query.pattern).map((path) =>
+      Uri.from({ scheme: "memfs", path: path })
+    );
+  }
+}

packages/ethereum-viewer/src/todo.textSearchProvider.ts

@@ -0,0 +1,84 @@
+import {
+  CancellationToken,
+  Disposable,
+  Position,
+  Progress,
+  Range,
+  TextSearchComplete,
+  TextSearchOptions,
+  TextSearchProvider,
+  TextSearchQuery,
+  TextSearchResult,
+  Uri,
+} from "vscode";
+
+export class StaticTextSearchProvider
+  implements TextSearchProvider, Disposable
+{
+  private readonly disposable?: Disposable;
+
+  constructor(
+    private readonly files: readonly [string /* key */, string /* contents */][]
+  ) {}
+
+  dispose() {
+    this.disposable?.dispose();
+  }
+
+  provideTextSearchResults(
+    query: TextSearchQuery,
+    options: TextSearchOptions,
+    progress: Progress<TextSearchResult>,
+    _token: CancellationToken
+  ): TextSearchComplete {
+    const matchesQuery = (content: string) => {
+      let pattern = query.pattern;
+
+      if (!query.isCaseSensitive) {
+        content = content.toLowerCase();
+        pattern = pattern.toLowerCase();
+      }
+
+      if (query.isRegExp) return content.match(new RegExp(pattern));
+
+      return content.includes(pattern);
+    };
+
+    // @todo handle options.includes and options.excludes
+    // @todo handle all options on query
+    const files = this.files.filter(([, content]) => matchesQuery(content));
+
+    for (const [path, content] of files) {
+      const lines = content.split("\n");
+      const lineIndex = lines.findIndex(matchesQuery);
+      const line = lines[lineIndex];
+      if (line) {
+        const lineNumber = lineIndex;
+        console.log({ path, lineNumber, line })
+        progress.report({
+          uri: Uri.from({ scheme: "memfs", path: "/" + path }),
+          lineNumber,
+          text: line,
+          ranges: [
+            // This is really bad. I'm not handling column number at all.
+            new Range(
+              new Position(lineNumber, 0),
+              new Position(lineNumber, line.length)
+            ),
+          ],
+          preview: {
+            text: line,
+            matches: [
+              new Range(
+                new Position(lineNumber, 0),
+                new Position(lineNumber, line.length)
+              )
+            ], 
+          }
+        });
+      }
+    }
+
+    return { limitHit: files.length >= options.maxResults };
+  }
+}