Merge pull request #12 from badsyntax/sln-file

badsyntax · web-flow · commit 854936c3cee1 · 2022-12-24T17:11:11.000Z
Remove reliance on .sln file
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -46,6 +46,7 @@
   },
   "cSpell.language": "en-GB",
   "cSpell.words": [
+    "ASPNETCORE",
     "color",
     "dbcontext",
     "efcore",
diff --git a/README.md b/README.md
@@ -6,33 +6,23 @@ A VS Code extension to manage Entity Framework migrations.
 
 ## Features
 
-![treeview](images/treeview-screenshot.png)
+![Entity Framework Migrations](images/treeview-screenshot.png)
 
-- List dbContexts for all projects within a solution
+- List migrations by [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext)
 - Add/remove/run/undo migrations
+- Export [DbContext](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext) as SQL script
 
 ## Requirements
 
 - [dotnet sdk](https://dotnet.microsoft.com/download)
 - [efcore tools](https://learn.microsoft.com/en-us/ef/core/cli/dotnet)
-- A solution (`.sln`) file with projects
 - [Microsoft.EntityFrameworkCore.Design](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.Design) must be installed in one of the projects
 
 ## Extension Settings
 
 This extension contributes the following settings:
 
-- `entityframework.env`: Custom environment vars, for example:
-  ```json
-  {
-    "entityframework.env": {
-      "ASPNETCORE_ENVIRONMENT": "LocalDev",
-      "TenantId": "12345"
-    }
-  }
-  ```
 - `entityframework.commands`: Custom commands, for example:
-
   ```json
   {
     "entityframework.commands": {
@@ -87,10 +77,24 @@ This extension contributes the following settings:
     }
   }
   ```
+- `entityframework.env`: Custom environment variables, for example:
+  ```json
+  {
+    "entityframework.env": {
+      "ASPNETCORE_ENVIRONMENT": "LocalDev",
+      "TenantId": "12345"
+    }
+  }
+  ```
 
 ## Performance
 
-The EF tools execute application code at design time to get information about the project, thus performance can be slow on large projects.
+The EF tools execute application code at design time to get information about the project, thus performance on large projects can be slow.
+
+## Support
+
+- 👉 [Submit a bug report](https://github.com/badsyntax/vscode-entity-framework/issues/new?assignees=badsyntax&labels=bug&template=bug_report.md&title=)
+- 👉 [Submit a feature request](https://github.com/badsyntax/vscode-entity-framework/issues/new?assignees=badsyntax&labels=enhancement&template=feature_request.md&title=)
 
 ## License
 
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
     "Other"
   ],
   "activationEvents": [
-    "workspaceContains:**/*.sln"
+    "workspaceContains:**/*.csproj"
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "bugs": {
diff --git a/src/actions/GenerateScriptAction.ts b/src/actions/GenerateScriptAction.ts
@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 
-import { extractDataFromStdOut } from '../cli/ef';
+import { getDataFromStdOut } from '../cli/ef';
 import { getCommandsConfig } from '../config/config';
 import type { TerminalProvider } from '../terminal/TerminalProvider';
 import { TerminalAction } from './TerminalAction';
@@ -24,7 +24,7 @@ export class GenerateScriptAction extends TerminalAction {
   }
 
   public async run() {
-    const output = extractDataFromStdOut(await super.run());
+    const output = getDataFromStdOut(await super.run());
     const uri = vscode.Uri.parse('ef-script:' + output);
     const doc = await vscode.workspace.openTextDocument(uri);
     await vscode.languages.setTextDocumentLanguage(doc, 'sql');
diff --git a/src/cli/ef.ts b/src/cli/ef.ts
@@ -3,20 +3,32 @@ import { promisify } from 'node:util';
 import { getEnvConfig } from '../config/config';
 
 const execAsync = promisify(exec);
+const NEWLINE_SEPARATOR = /\r\n|\r|\n/;
+const STDOUT_PREFIX = /^[a-z]+:    /;
 
-export function extractDataFromStdOut(output: string): string {
+export function removePrefixFromStdOut(output: string): string {
   return output
-    .split(/\r\n|\r|\n/)
-    .filter(line => line.startsWith('data:    '))
-    .map(line => line.replace('data:    ', ''))
+    .split(NEWLINE_SEPARATOR)
+    .map(line => line.replace(STDOUT_PREFIX, ''))
     .join('\n');
 }
 
-export function removePrefixFromStdOut(output: string): string {
-  return output
-    .split(/\r\n|\r|\n/)
-    .map(line => line.replace(/^[a-z]+:    /, ''))
-    .join('\n');
+export function getDataFromStdOut(output: string): string {
+  return removePrefixFromStdOut(
+    output
+      .split(NEWLINE_SEPARATOR)
+      .filter(line => line.startsWith('data:'))
+      .join('\n'),
+  );
+}
+
+export function getErrorsFromStdOut(output: string): string {
+  return removePrefixFromStdOut(
+    output
+      .split(NEWLINE_SEPARATOR)
+      .filter(line => line.startsWith('error:'))
+      .join('\n'),
+  );
 }
 
 export async function execEF(
diff --git a/src/commands/AddMigrationCommand.ts b/src/commands/AddMigrationCommand.ts
@@ -19,7 +19,7 @@ export class AddMigrationCommand extends Command {
     }
     return new AddMigrationAction(
       this.terminalProvider,
-      this.item.solutionFile.workspaceRoot,
+      this.item.workspaceRoot,
       this.item.label,
       this.item.project,
     ).run();
diff --git a/src/commands/GenerateScriptCommand.ts b/src/commands/GenerateScriptCommand.ts
@@ -19,7 +19,7 @@ export class GenerateScriptCommand extends Command {
     }
     return new GenerateScriptAction(
       this.terminalProvider,
-      this.item.solutionFile.workspaceRoot,
+      this.item.workspaceRoot,
       this.item.label,
       this.item.project,
     ).run();
diff --git a/src/commands/RemoveMigrationCommand.ts b/src/commands/RemoveMigrationCommand.ts
@@ -19,7 +19,7 @@ export class RemoveMigrationCommand extends Command {
     }
     return new RemoveMigrationAction(
       this.terminalProvider,
-      this.item.solutionFile.workspaceRoot,
+      this.item.workspaceRoot,
       this.item.dbContext,
       this.item.project,
     ).run();
diff --git a/src/commands/RunMigrationCommand.ts b/src/commands/RunMigrationCommand.ts
@@ -19,7 +19,7 @@ export class RunMigrationCommand extends Command {
     }
     return new RunMigrationAction(
       this.terminalProvider,
-      this.item.solutionFile.workspaceRoot,
+      this.item.workspaceRoot,
       this.item.dbContext,
       this.item.project,
       this.item.migration.id,
diff --git a/src/commands/UndoMigrationCommand.ts b/src/commands/UndoMigrationCommand.ts
@@ -22,7 +22,7 @@ export class UndoMigrationCommand extends Command {
       return;
     }
     const cacheId = DbContextTreeItem.getCacheId(
-      this.item.solutionFile.workspaceRoot,
+      this.item.workspaceRoot,
       this.item.project,
       this.item.dbContext,
     );
@@ -33,7 +33,7 @@ export class UndoMigrationCommand extends Command {
         index === 0 ? '0' : migrations[index - 1].migration.id;
       return new RunMigrationAction(
         this.terminalProvider,
-        this.item.solutionFile.workspaceRoot,
+        this.item.workspaceRoot,
         this.item.dbContext,
         this.item.project,
         migrationId,
diff --git a/src/constants/constants.ts b/src/constants/constants.ts
@@ -1,3 +1,3 @@
-export const DB_CONTEXT_MODEL_SNAPSHOT_SUFFIX = 'ModelSnapshot.cs';
-
 export const EXTENSION_NAMESPACE = 'entityframework';
+
+export const TERMINAL_NAME = 'ef-migrations';
diff --git a/src/extension.ts b/src/extension.ts
@@ -3,19 +3,19 @@ import type * as vscode from 'vscode';
 import { TreeDataProvider } from './treeView/TreeDataProvider';
 import { CommandProvider } from './commands/CommandProvider';
 import { MigrationTreeItemDecorationProvider } from './treeView/MigrationTreeItemDecorationProvider';
-import { SolutionFinder } from './solution/SolutionProvider';
 import { Terminal } from './terminal/Terminal';
 import { TerminalProvider } from './terminal/TerminalProvider';
 import { ScriptFileProvider } from './util/ScriptFileProvider';
+import { ProjectFilesProvider } from './solution/ProjectFilesProvider';
 
 const subscriptions: vscode.Disposable[] = [];
 
 export async function activate(_context: vscode.ExtensionContext) {
-  const solutionFiles = await SolutionFinder.getSolutionFiles();
+  const projectFiles = await ProjectFilesProvider.getProjectFiles();
   const scriptFileProvider = new ScriptFileProvider();
   const migrationTreeItemDecorationProvider =
     new MigrationTreeItemDecorationProvider();
-  const treeDataProvider = new TreeDataProvider(solutionFiles);
+  const treeDataProvider = new TreeDataProvider(projectFiles);
   const terminalProvider = new TerminalProvider(new Terminal());
   const commandProvider = new CommandProvider(
     treeDataProvider,
diff --git a/src/solution/ProjectFilesProvider.ts b/src/solution/ProjectFilesProvider.ts
@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+import path from 'node:path';
+import { parseProject } from 'vs-parse';
+import type { ProjectFile } from '../types/ProjectFile';
+
+export class ProjectFilesProvider {
+  public static async getProjectFiles() {
+    const workspaceRoots = vscode.workspace.workspaceFolders || [];
+
+    const projects: ProjectFile[] = [];
+
+    for (const workspaceRoot of workspaceRoots) {
+      const projectFiles = await vscode.workspace.findFiles(
+        new vscode.RelativePattern(workspaceRoot, '**/*.csproj'),
+      );
+      for (const projectFile of projectFiles) {
+        const project = await parseProject(projectFile.fsPath);
+        const hasEFDesignPackage =
+          (project.packages || []).find(
+            pkg => pkg.name === 'Microsoft.EntityFrameworkCore.Design',
+          ) !== undefined;
+        if (hasEFDesignPackage) {
+          const projectName = path.basename(path.dirname(projectFile.fsPath));
+          projects.push({
+            name: projectName,
+            project,
+            workspaceRoot: workspaceRoot.uri.fsPath,
+            path: projectFile.fsPath,
+          });
+        }
+      }
+    }
+
+    return projects;
+  }
+}
diff --git a/src/solution/SolutionFilesProvider.ts b/src/solution/SolutionFilesProvider.ts
@@ -3,7 +3,7 @@ import { parseSolution } from 'vs-parse';
 import path from 'node:path';
 import type { SolutionFile } from '../types/SolutionFile';
 
-export class SolutionFinder {
+export class SolutionFilesProvider {
   public static async getSolutionFiles() {
     const workspaceRoots =
       vscode.workspace.workspaceFolders?.map(w => w.uri.fsPath) || [];
diff --git a/src/terminal/Terminal.ts b/src/terminal/Terminal.ts
@@ -3,7 +3,7 @@ import { spawn, type ChildProcessWithoutNullStreams } from 'node:child_process';
 
 import { EventWaiter } from '../util/EventWaiter';
 import { getEnvConfig } from '../config/config';
-import { removePrefixFromStdOut } from '../cli/ef';
+import { getErrorsFromStdOut, removePrefixFromStdOut } from '../cli/ef';
 
 const NL = '\n';
 const CR = '\r';
@@ -50,7 +50,9 @@ export class Terminal implements vscode.Pseudoterminal {
     });
 
     return new Promise(res => {
-      this.write(this.cmdArgs.join(' ') + '\n');
+      // --prefix-output is an internal flag that is added to all commands
+      const argsWithoutPrefixOutput = this.cmdArgs.slice(0, -1);
+      this.write(argsWithoutPrefixOutput.join(' ') + '\n');
 
       this.cmd?.stdout.on('data', data => {
         const dataString = data.toString();
@@ -64,10 +66,13 @@ export class Terminal implements vscode.Pseudoterminal {
         this.write(removePrefixFromStdOut(dataString));
       });
 
-      this.cmd?.on('exit', code => {
+      this.cmd?.on('exit', async _code => {
         this.cmd = undefined;
-        this.write(`Exited with code ${code}\n\n`);
-        res(stderr || stdout);
+        const error = stderr || getErrorsFromStdOut(stdout);
+        if (error) {
+          await vscode.window.showErrorMessage(error);
+        }
+        res(stdout);
       });
     });
   }
@@ -80,7 +85,7 @@ export class Terminal implements vscode.Pseudoterminal {
   }
 
   public write(message: string): void {
-    // We need NLCR to move down and left
+    // NLCR is required to move down and left
     const sanitisedMessage = message.replace(nlRegExp, `${NL + CR}$1`);
     this.writeEmitter.fire(sanitisedMessage);
   }
diff --git a/src/terminal/TerminalProvider.ts b/src/terminal/TerminalProvider.ts
@@ -1,17 +1,16 @@
 import * as vscode from 'vscode';
+import { TERMINAL_NAME } from '../constants/constants';
 import { Disposable } from '../util/Disposable';
 import type { Terminal } from './Terminal';
 
-const TERMINAL_NAME = 'ef-migrations';
-
 export class TerminalProvider extends Disposable {
   constructor(private readonly terminal: Terminal) {
     super();
   }
 
   public provideTerminal(): Terminal {
     let existingTerminal = vscode.window.terminals.find(
-      t => t.name === TERMINAL_NAME,
+      ({ name }) => name === TERMINAL_NAME,
     );
     if (!existingTerminal) {
       existingTerminal = vscode.window.createTerminal({
diff --git a/src/treeView/DbContextTreeItem.ts b/src/treeView/DbContextTreeItem.ts
@@ -3,10 +3,10 @@ import type { Migration } from '../types/Migration';
 import { getIconPath } from './iconProvider';
 import { MigrationTreeItem } from './MigrationTreeItem';
 import { TreeItem } from './TreeItem';
-import { execEF, extractDataFromStdOut } from '../cli/ef';
+import { execEF, getDataFromStdOut } from '../cli/ef';
 import { TreeItemCache } from './TreeItemCache';
-import type { SolutionFile } from '../types/SolutionFile';
 import { ContextValues } from './ContextValues';
+import type { ProjectFile } from '../types/ProjectFile';
 
 export const dbContextsCache = new TreeItemCache<MigrationTreeItem[]>();
 
@@ -15,16 +15,16 @@ export class DbContextTreeItem extends TreeItem {
 
   constructor(
     public readonly label: string,
-    solutionFile: SolutionFile,
+    private readonly projectFile: ProjectFile,
     public readonly project: string,
     collapsibleState: vscode.TreeItemCollapsibleState = vscode
       .TreeItemCollapsibleState.Collapsed,
   ) {
-    super(label, solutionFile, collapsibleState);
+    super(label, projectFile.workspaceRoot, collapsibleState);
     this.iconPath = getIconPath('database_light.svg', 'database_dark.svg');
     this.contextValue = ContextValues.dbContext;
     this.cacheId = DbContextTreeItem.getCacheId(
-      solutionFile.workspaceRoot,
+      projectFile.workspaceRoot,
       this.project,
       this.label,
     );
@@ -48,16 +48,14 @@ export class DbContextTreeItem extends TreeItem {
     try {
       const output = await execEF(
         `migrations list --context ${this.label} --project ${this.project} --no-color --json --prefix-output`,
-        this.solutionFile.workspaceRoot,
+        this.projectFile.workspaceRoot,
       );
-      const migrations = JSON.parse(
-        extractDataFromStdOut(output),
-      ) as Migration[];
+      const migrations = JSON.parse(getDataFromStdOut(output)) as Migration[];
       const children = migrations.map(
         (migration, index) =>
           new MigrationTreeItem(
             migration.name,
-            this.solutionFile,
+            this.projectFile.workspaceRoot,
             this.label,
             this.project,
             migration,
diff --git a/src/treeView/MigrationTreeItem.ts b/src/treeView/MigrationTreeItem.ts
diff --git a/src/treeView/MigrationTreeItemDecorationProvider.ts b/src/treeView/MigrationTreeItemDecorationProvider.ts
diff --git a/src/treeView/ProjectTreeItem.ts b/src/treeView/ProjectTreeItem.ts
diff --git a/src/treeView/SolutionTreeItem.ts b/src/treeView/SolutionTreeItem.ts
diff --git a/src/treeView/TreeDataProvider.ts b/src/treeView/TreeDataProvider.ts
diff --git a/src/treeView/TreeItem.ts b/src/treeView/TreeItem.ts
diff --git a/src/types/ProjectFile.ts b/src/types/ProjectFile.ts
diff --git a/src/vs-parse.d.ts b/src/vs-parse.d.ts

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class AddMigrationCommand extends Command {`
`19`	`19`	`}`
`20`	`20`	`return new AddMigrationAction(`
`21`	`21`	`this.terminalProvider,`
`22`		`- this.item.solutionFile.workspaceRoot,`
	`22`	`+ this.item.workspaceRoot,`
`23`	`23`	`this.item.label,`
`24`	`24`	`this.item.project,`
`25`	`25`	`).run();`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class GenerateScriptCommand extends Command {`
`19`	`19`	`}`
`20`	`20`	`return new GenerateScriptAction(`
`21`	`21`	`this.terminalProvider,`
`22`		`- this.item.solutionFile.workspaceRoot,`
	`22`	`+ this.item.workspaceRoot,`
`23`	`23`	`this.item.label,`
`24`	`24`	`this.item.project,`
`25`	`25`	`).run();`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class RemoveMigrationCommand extends Command {`
`19`	`19`	`}`
`20`	`20`	`return new RemoveMigrationAction(`
`21`	`21`	`this.terminalProvider,`
`22`		`- this.item.solutionFile.workspaceRoot,`
	`22`	`+ this.item.workspaceRoot,`
`23`	`23`	`this.item.dbContext,`
`24`	`24`	`this.item.project,`
`25`	`25`	`).run();`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class RunMigrationCommand extends Command {`
`19`	`19`	`}`
`20`	`20`	`return new RunMigrationAction(`
`21`	`21`	`this.terminalProvider,`
`22`		`- this.item.solutionFile.workspaceRoot,`
	`22`	`+ this.item.workspaceRoot,`
`23`	`23`	`this.item.dbContext,`
`24`	`24`	`this.item.project,`
`25`	`25`	`this.item.migration.id,`