Merge pull request #28 from badsyntax/er-diagram

Add ER Diagram feature using mermaid

Author: badsyntax

.eslintrc.json

@@ -22,5 +22,5 @@
     "no-throw-literal": "warn",
     "semi": "off"
   },
-  "ignorePatterns": ["out", "dist", "**/*.d.ts"]
+  "ignorePatterns": ["out", "dist", "**/*.d.ts", "*.js", "webview-ui"]
 }

.github/workflows/main.yml

@@ -34,7 +34,16 @@ jobs:
         run: npm ci
       - name: Lint
         run: npm run lint
-      - name: Build
+      - name: Install webview-ui NPM Packages
+        run: npm ci
+        working-directory: ./webview-ui
+      - name: Lint webview-ui
+        run: npm run lint
+        working-directory: ./webview-ui
+      - name: Build webview-ui
+        run: npm run build
+        working-directory: ./webview-ui
+      - name: Package extension
         run: npm run package
       - name: Prepare test project
         run: |

.prettierignore

@@ -5,3 +5,4 @@ dist
 sample_dotnet
 .wdio-vscode-service
 out
+webview-ui

.vscode/extensions.json

@@ -3,6 +3,7 @@
     "dbaeumer.vscode-eslint",
     "amodio.tsl-problem-matcher",
     "esbenp.prettier-vscode",
-    "streetsidesoftware.code-spell-checker"
+    "streetsidesoftware.code-spell-checker",
+    "Tobermory.es6-string-html"
   ]
 }

.vscode/launch.json

@@ -7,7 +7,7 @@
       "request": "launch",
       "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
-      "preLaunchTask": "${defaultBuildTask}"
+      "preLaunchTask": "npm: compile"
     },
     {
       "name": "Extension Tests",

.vscode/settings.json

@@ -53,6 +53,7 @@
     "entityframework",
     "NLCR",
     "Pseudoterminal",
+    "quickpick",
     "richardwillis",
     "Testrunner",
     "waitfor",

.vscodeignore

@@ -1,20 +1,31 @@
-.vscode/**
-.vscode-test/**
+**/.vscode/**
+**/.vscode-test/**
 out/**
 node_modules/**
 src/**
-.gitignore
+**/.gitignore
 .yarnrc
-webpack.config.js
+**/webpack.config.js
 **/tsconfig.json
+**/tsconfig.node.json
 **/.eslintrc.json
 **/*.map
 **/*.ts
-.prettierrc.js
-.prettierignore
+**/.prettierrc.js
+**/.prettierrc.cjs
+**/.prettierignore
 .gitattributes
 .editorconfig
 .github/**
 images/**
 sample_dotnet/**
 .wdio-vscode-service/**
+
+webview-ui/src/**
+webview-ui/build/index.html
+webview-ui/public/**
+webview-ui/index.html
+webview-ui/README.md
+webview-ui/package.json
+webview-ui/package-lock.json
+webview-ui/node_modules/**

README.md

@@ -6,6 +6,12 @@ A VS Code extension to manage Entity Framework migrations.
 
 <img src="./images/treeview-screenshot.png" width="460" alt="Entity Framework Migrations" />
 
+## Requirements
+
+- [dotnet sdk](https://dotnet.microsoft.com/download)
+- [efcore tools](https://learn.microsoft.com/en-us/ef/core/cli/dotnet)
+- [Microsoft.EntityFrameworkCore.Design](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.Design) must be installed in one of the projects
+
 ## Features
 
 - List migrations by [`DbContext`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext)
@@ -14,12 +20,13 @@ A VS Code extension to manage Entity Framework migrations.
 - Export `DbContext` as SQL script
 - View `DbContext` information
 - [Scaffold](https://learn.microsoft.com/en-us/ef/core/cli/dotnet#dotnet-ef-dbcontext-scaffold) `DbContext` & entity types
+- Generate ER Diagram (Requires EF Core 7+)
 
-## Requirements
+### ER Diagram
 
-- [dotnet sdk](https://dotnet.microsoft.com/download)
-- [efcore tools](https://learn.microsoft.com/en-us/ef/core/cli/dotnet)
-- [Microsoft.EntityFrameworkCore.Design](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.Design) must be installed in one of the projects
+A [`Mermaid`](https://mermaid.js.org/syntax/entityRelationshipDiagram.html) [`.t4`](https://learn.microsoft.com/en-us/ef/core/managing-schemas/scaffolding/templates) template will be installed into the project. You can ignore this file (by adding it to `.gitignore`), or add it to source control. The template file is used to generate the ER Diagram, feel free to customise it. If you delete it, it will be regenerated next time you generate an ER Diagram.
+
+<img src="./images/er-diagram.png" width="640" alt="Entity Framework Migrations" />
 
 ## Extension Settings
 
@@ -89,9 +96,7 @@ This extension contributes the following settings:
         "--project",
         "\"$project\"",
         "--startup-project",
-        "\"$project\"",
-        "--no-color",
-        "--json"
+        "\"$project\""
       ],
       "listMigrations": [
         "dotnet",
@@ -103,9 +108,7 @@ This extension contributes the following settings:
         "--project",
         "\"$project\"",
         "--startup-project",
-        "\"$project\"",
-        "--no-color",
-        "--json"
+        "\"$project\""
       ],
       "dbContextInfo": [
         "dotnet",
@@ -117,9 +120,7 @@ This extension contributes the following settings:
         "--project",
         "\"$project\"",
         "--startup-project",
-        "\"$project\"",
-        "--no-color",
-        "--json"
+        "\"$project\""
       ],
       "scaffold": [
         "dotnet",
@@ -137,16 +138,40 @@ This extension contributes the following settings:
         "--context-dir",
         "\"$contextDir\"",
         "--namespace",
-        "\"$namespace\"",
-        "--no-color",
-        "--json"
+        "\"$namespace\""
+      ],
+      "generateERD": [
+        "dotnet",
+        "ef",
+        "dbcontext",
+        "scaffold",
+        "\"$connectionString\"",
+        "\"$provider\"",
+        "--context",
+        "\"$context\"",
+        "--project",
+        "\"$project\"",
+        "--output-dir",
+        "\"$outputDir\"",
+        "--use-database-names"
       ]
     }
   }
   ```
 
   </details>
 
+- `entityframework.erDiagram.ignoreTables`: A list of tables to ignore from the ER Diagram
+  <details><summary>Example</summary>
+
+  ```json
+  {
+    "entityframework.erDiagram": {
+      "ignoreTables": [".*Tracking$"]
+    }
+  }
+  ```
+
 - `entityframework.env`: Custom environment variables
   <details><summary>Example</summary>