Merge pull request #15 from badsyntax/dbcontext-info

Add dbcontext info command

Author: badsyntax

README.md

@@ -8,10 +8,11 @@ A VS Code extension to manage Entity Framework migrations.
 
 ## Features
 
-- List migrations by [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
 - Show migration applied status
-- Export [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext) as SQL script
+- Export `DbContext` as SQL script
+- View `DbContext` information
 
 ## Requirements
 
@@ -23,7 +24,9 @@ A VS Code extension to manage Entity Framework migrations.
 
 This extension contributes the following settings:
 
-- `entityframework.commands`: Custom commands, for example:
+- `entityframework.commands`: Custom commands
+  <details><summary>Example</summary>
+
   ```json
   {
     "entityframework.commands": {
@@ -96,11 +99,28 @@ This extension contributes the following settings:
         "\"$project\"",
         "--no-color",
         "--json"
+      ],
+      "dbContextInfo": [
+        "dotnet",
+        "ef",
+        "dbcontext",
+        "info",
+        "--context",
+        "\"$dbContext\"",
+        "--project",
+        "\"$project\"",
+        "--no-color",
+        "--json"
       ]
     }
   }
   ```
-- `entityframework.env`: Custom environment variables, for example:
+
+  </details>
+
+- `entityframework.env`: Custom environment variables
+  <details><summary>Example</summary>
+
   ```json
   {
     "entityframework.env": {
@@ -110,9 +130,11 @@ This extension contributes the following settings:
   }
   ```
 
+  </details>
+
 ## Performance
 
-The EF tools execute application code at design time to get information about the project, thus performance on large projects can be slow.
+The EF tools execute application code at design time to get information about the project, thus _performance on large projects can be slow_.
 
 ## Support
 

icons/help_dark.svg

@@ -50,6 +50,14 @@
           "dark": "icons/trash_dark.svg"
         }
       },
+      {
+        "command": "entityframework.dbContextInfo",
+        "title": "Information",
+        "icon": {
+          "light": "icons/help_light.svg",
+          "dark": "icons/help_dark.svg"
+        }
+      },
       {
         "command": "entityframework.refreshTree",
         "title": "Refresh Migrations",
@@ -109,6 +117,10 @@
           "command": "entityframework.removeMigration",
           "when": "false"
         },
+        {
+          "command": "entityframework.dbContextInfo",
+          "when": "false"
+        },
         {
           "command": "entityframework.addMigration",
           "when": "false"
@@ -165,18 +177,34 @@
           "group": "context@1"
         },
         {
-          "command": "entityframework.generateScript",
+          "command": "entityframework.addMigration",
           "when": "viewItem == dbContext",
-          "group": "inline@1"
+          "group": "context@3"
         },
         {
           "command": "entityframework.addMigration",
           "when": "viewItem == dbContext",
-          "group": "inline@2"
+          "group": "inline@3"
         },
         {
           "command": "entityframework.generateScript",
-          "when": "viewItem == dbContext"
+          "when": "viewItem == dbContext",
+          "group": "context@2"
+        },
+        {
+          "command": "entityframework.generateScript",
+          "when": "viewItem == dbContext",
+          "group": "inline@2"
+        },
+        {
+          "command": "entityframework.dbContextInfo",
+          "when": "viewItem == dbContext",
+          "group": "inline@1"
+        },
+        {
+          "command": "entityframework.dbContextInfo",
+          "when": "viewItem == dbContext",
+          "group": "context@1"
         }
       ]
     },
@@ -263,6 +291,18 @@
               "\"$project\"",
               "--no-color",
               "--json"
+            ],
+            "dbContextInfo": [
+              "dotnet",
+              "ef",
+              "dbcontext",
+              "info",
+              "--context",
+              "\"$dbContext\"",
+              "--project",
+              "\"$project\"",
+              "--no-color",
+              "--json"
             ]
           },
           "description": "Environment variables when interacting with Entity Framework."

icons/help_light.svg

@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+
+import { CLI } from '../cli/CLI';
+import { getCommandsConfig } from '../config/config';
+
+import type { TerminalProvider } from '../terminal/TerminalProvider';
+import { TextDocumentProvider } from '../util/TextDocumentProvider';
+import { TerminalAction } from './TerminalAction';
+
+export class DBContextInfoCommandAction extends TerminalAction {
+  constructor(
+    terminalProvider: TerminalProvider,
+    workspaceRoot: string,
+    dbContext: string,
+    project: string,
+  ) {
+    super(
+      terminalProvider,
+      getCommandsConfig().dbContextInfo,
+      {
+        dbContext,
+        project,
+      },
+      workspaceRoot,
+    );
+  }
+
+  public async run() {
+    const output = CLI.getDataFromStdOut(await super.run());
+    const uri = vscode.Uri.parse(`${TextDocumentProvider.scheme}:${output}`);
+    const doc = await vscode.workspace.openTextDocument(uri);
+    await vscode.languages.setTextDocumentLanguage(doc, 'json');
+    await vscode.window.showTextDocument(doc, { preview: false });
+    return output;
+  }
+}

package.json

@@ -3,6 +3,7 @@ import { CLI } from '../cli/CLI';
 
 import { getCommandsConfig } from '../config/config';
 import type { TerminalProvider } from '../terminal/TerminalProvider';
+import { TextDocumentProvider } from '../util/TextDocumentProvider';
 import { TerminalAction } from './TerminalAction';
 
 export class GenerateScriptAction extends TerminalAction {
@@ -25,7 +26,7 @@ export class GenerateScriptAction extends TerminalAction {
 
   public async run() {
     const output = CLI.getDataFromStdOut(await super.run());
-    const uri = vscode.Uri.parse('ef-script:' + output);
+    const uri = vscode.Uri.parse(`${TextDocumentProvider.scheme}:${output}`);
     const doc = await vscode.workspace.openTextDocument(uri);
     await vscode.languages.setTextDocumentLanguage(doc, 'sql');
     await vscode.window.showTextDocument(doc, { preview: false });

src/actions/DBContextInfoCommandAction.ts

@@ -7,6 +7,7 @@ import type { TreeDataProvider } from '../treeView/TreeDataProvider';
 import { Disposable } from '../util/Disposable';
 import { AddMigrationCommand } from './AddMigrationCommand';
 import type { Command } from './Command';
+import { DBContextInfoCommand } from './DBContextInfoCommand';
 import { GenerateScriptCommand } from './GenerateScriptCommand';
 import { OpenMigrationFileCommand } from './OpenMigrationFileCommand';
 import { RefreshTreeCommand } from './RefreshTreeCommand';
@@ -55,6 +56,11 @@ export class CommandProvider extends Disposable {
       OpenMigrationFileCommand.commandName,
       (item?: MigrationTreeItem) => new OpenMigrationFileCommand(item),
     );
+    this.registerCommand(
+      DBContextInfoCommand.commandName,
+      (item?: DbContextTreeItem) =>
+        new DBContextInfoCommand(terminalProvider, item),
+    );
   }
 
   public static getCommandName(name: string) {

src/actions/GenerateScriptAction.ts

@@ -0,0 +1,27 @@
+import { DBContextInfoCommandAction } from '../actions/DBContextInfoCommandAction';
+import type { TerminalProvider } from '../terminal/TerminalProvider';
+import { type DbContextTreeItem } from '../treeView/DbContextTreeItem';
+import { Command } from './Command';
+
+export class DBContextInfoCommand extends Command {
+  public static commandName = 'dbContextInfo';
+
+  constructor(
+    private readonly terminalProvider: TerminalProvider,
+    private readonly item?: DbContextTreeItem,
+  ) {
+    super();
+  }
+
+  public async run() {
+    if (!this.item) {
+      return;
+    }
+    return new DBContextInfoCommandAction(
+      this.terminalProvider,
+      this.item.workspaceRoot,
+      this.item.label,
+      this.item.project,
+    ).run();
+  }
+}

src/commands/CommandProvider.ts

@@ -12,6 +12,7 @@ type CommandsConfig = {
   generateScript: string[];
   listDbContexts: string[];
   listMigrations: string[];
+  dbContextInfo: string[];
 };
 
 export function getEnvConfig() {
@@ -30,5 +31,6 @@ export function getCommandsConfig() {
       generateScript: [],
       listDbContexts: [],
       listMigrations: [],
+      dbContextInfo: [],
     });
 }

src/commands/DBContextInfoCommand.ts

@@ -5,7 +5,7 @@ import { CommandProvider } from './commands/CommandProvider';
 import { MigrationTreeItemDecorationProvider } from './treeView/MigrationTreeItemDecorationProvider';
 import { Terminal } from './terminal/Terminal';
 import { TerminalProvider } from './terminal/TerminalProvider';
-import { ScriptFileProvider } from './util/ScriptFileProvider';
+import { TextDocumentProvider } from './util/TextDocumentProvider';
 import { ProjectFilesProvider } from './solution/ProjectFilesProvider';
 import { Logger } from './util/Logger';
 import { OUTPUT_CHANNEL_ID } from './constants/constants';
@@ -21,7 +21,7 @@ export async function activate(_context: vscode.ExtensionContext) {
 
   const cli = new CLI(logger);
   const projectFiles = await ProjectFilesProvider.getProjectFiles();
-  const scriptFileProvider = new ScriptFileProvider();
+  const textDocumentProvider = new TextDocumentProvider();
   const migrationTreeItemDecorationProvider =
     new MigrationTreeItemDecorationProvider();
   const treeDataProvider = new TreeDataProvider(projectFiles, cli);
@@ -35,7 +35,7 @@ export async function activate(_context: vscode.ExtensionContext) {
     treeDataProvider,
     commandProvider,
     terminalProvider,
-    scriptFileProvider,
+    textDocumentProvider,
   );
 }