Merge pull request #14 from badsyntax/open-migration

Open migration file

Author: badsyntax

README.md

@@ -8,9 +8,10 @@ A VS Code extension to manage Entity Framework migrations.
 
 ## Features
 
-- List migrations by project [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext)
+- List migrations by [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext)
 - Add/remove/run/undo migrations
-- Export project [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext) as SQL script
+- Show migration applied status
+- Export [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext) as SQL script
 
 ## Requirements
 

src/actions/IAction.ts

@@ -1,3 +1,3 @@
 export interface IAction {
-  run(): Promise<string>;
+  run(): Promise<string | void>;
 }

src/actions/OpenMigrationFileAction.ts

@@ -0,0 +1,27 @@
+import * as vscode from 'vscode';
+
+import type { Migration } from '../types/Migration';
+import type { IAction } from './IAction';
+
+export class OpenMigrationFileAction implements IAction {
+  constructor(
+    private readonly workspaceRoot: string,
+    private readonly migration: Migration,
+  ) {}
+
+  public async run() {
+    // The ef cli does not give us any information about migration file paths,
+    // which is why we have to find it ourselves.
+    const [migrationFile] = await vscode.workspace.findFiles(
+      new vscode.RelativePattern(
+        this.workspaceRoot,
+        `**/${this.migration.id}.cs`,
+      ),
+      undefined,
+      1,
+    );
+    if (migrationFile) {
+      await vscode.commands.executeCommand('vscode.open', migrationFile);
+    }
+  }
+}

src/commands/CommandProvider.ts

@@ -8,6 +8,7 @@ import { Disposable } from '../util/Disposable';
 import { AddMigrationCommand } from './AddMigrationCommand';
 import type { Command } from './Command';
 import { GenerateScriptCommand } from './GenerateScriptCommand';
+import { OpenMigrationFileCommand } from './OpenMigrationFileCommand';
 import { RefreshTreeCommand } from './RefreshTreeCommand';
 import { RemoveMigrationCommand } from './RemoveMigrationCommand';
 import { RunMigrationCommand } from './RunMigrationCommand';
@@ -50,6 +51,10 @@ export class CommandProvider extends Disposable {
       (clearCache: boolean) =>
         new RefreshTreeCommand(treeDataProvider, clearCache),
     );
+    this.registerCommand(
+      OpenMigrationFileCommand.commandName,
+      (item?: MigrationTreeItem) => new OpenMigrationFileCommand(item),
+    );
   }
 
   public static getCommandName(name: string) {

src/commands/OpenMigrationFileCommand.ts

@@ -0,0 +1,21 @@
+import { OpenMigrationFileAction } from '../actions/OpenMigrationFileAction';
+import type { MigrationTreeItem } from '../treeView/MigrationTreeItem';
+import { Command } from './Command';
+
+export class OpenMigrationFileCommand extends Command {
+  public static commandName = 'openMigrationFile';
+
+  constructor(private readonly item?: MigrationTreeItem) {
+    super();
+  }
+
+  public async run() {
+    if (!this.item) {
+      return;
+    }
+    return new OpenMigrationFileAction(
+      this.item.workspaceRoot,
+      this.item.migration,
+    ).run();
+  }
+}

src/treeView/TreeDataProvider.ts

@@ -5,6 +5,9 @@ import { EXTENSION_NAMESPACE } from '../constants/constants';
 import type { ProjectFile } from '../types/ProjectFile';
 import { ProjectTreeItem } from './ProjectTreeItem';
 import type { CLI } from '../cli/CLI';
+import { MigrationTreeItem } from './MigrationTreeItem';
+import { CommandProvider } from '../commands/CommandProvider';
+import { OpenMigrationFileCommand } from '../commands/OpenMigrationFileCommand';
 
 export class TreeDataProvider
   extends Disposable
@@ -23,12 +26,25 @@ export class TreeDataProvider
     private readonly cli: CLI,
   ) {
     super();
-    this.subscriptions.push(
-      vscode.window.registerTreeDataProvider(
-        `${EXTENSION_NAMESPACE}Tree`,
-        this,
-      ),
-    );
+    const view = vscode.window.createTreeView(`${EXTENSION_NAMESPACE}Tree`, {
+      treeDataProvider: this,
+    });
+    view.onDidChangeSelection(this.handleTreeItemSelection.bind(this));
+    this.subscriptions.push(view);
+  }
+
+  private async handleTreeItemSelection(
+    e: vscode.TreeViewSelectionChangeEvent<vscode.TreeItem>,
+  ) {
+    if (
+      e.selection.length === 1 &&
+      e.selection[0] instanceof MigrationTreeItem
+    ) {
+      await vscode.commands.executeCommand(
+        CommandProvider.getCommandName(OpenMigrationFileCommand.commandName),
+        e.selection[0],
+      );
+    }
   }
 
   public refresh(): void {