Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dineug/vuerd-vscode
ERD Editor vscode extension
https://github.com/dineug/vuerd-vscode
database db diagram editor erd extension vscode vuerd
Last synced: about 2 months ago
JSON representation
ERD Editor vscode extension
- Host: GitHub
- URL: https://github.com/dineug/vuerd-vscode
- Owner: dineug
- License: mit
- Archived: true
- Created: 2020-01-14T14:32:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T15:59:11.000Z (over 3 years ago)
- Last Synced: 2024-09-21T18:16:07.191Z (about 2 months ago)
- Topics: database, db, diagram, editor, erd, extension, vscode, vuerd
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=dineug.vuerd-vscode
- Size: 34.6 MB
- Stars: 115
- Watchers: 3
- Forks: 14
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Moved
This module has [moved](https://github.com/vuerd/vuerd/tree/master/packages/vuerd-vscode). This repository is no longer maintained.
# vuerd-vscode
> [vuerd](https://github.com/vuerd/vuerd) ERD Editor vscode extension
[](https://www.npmjs.com/package/vuerd) [](https://marketplace.visualstudio.com/items?itemName=dineug.vuerd-vscode) [](https://atom.io/packages/vuerd-atom) [](https://github.com/vuerd/vuerd/blob/master/LICENSE) [](https://github.com/vuerd/vuerd/actions)
## ERD
## Usage
### [Webview API](https://code.visualstudio.com/api/extension-guides/webview)
1. ERD data [filename].vuerd.json Save a file as a form
1. Focus on the saved file and click the vuerd icon in the upper right corner of the Editor window
### [Custom Editor API](https://code.visualstudio.com/api/extension-guides/custom-editors)
1. ERD data [filename].vuerd Save a file as a form
## Theme settings.json
### Synchronize the current vscode theme
```json
{
"dineug.vuerd-vscode.themeSync": true,
// not synchronize color list
"dineug.vuerd-vscode.theme": {
"keyPK": "#B4B400",
"keyFK": "#dda8b1",
"keyPFK": "#60b9c4",
"edit": "#ffc107"
}
}
```
### Example settings.json configuration for a light themed editor
```json
{
"dineug.vuerd-vscode.themeSync": false,
"dineug.vuerd-vscode.theme": {
"canvas": "#d7d7d7",
"table": "#e6e6e6",
"tableActive": "#ebb692",
"focus": "#ff5600",
"keyPK": "#B4B400",
"keyFK": "#dda8b1",
"keyPFK": "#60b9c4",
"font": "#5d5d5d",
"fontActive": "black",
"fontPlaceholder": "#929292",
"contextmenu": "#e6e6e6",
"contextmenuActive": "#c7c2be",
"edit": "#003ef8",
"columnSelect": "#dcd5d0",
"columnActive": "#c8d6f7",
"minimapShadow": "#5d5d5d",
"scrollbarThumb": "#929292",
"scrollbarThumbActive": "#5d5d5d",
"menubar": "white",
"visualization": "#d7d7d7"
}
}
```
## Keymap settings.json
```json
{
"dineug.vuerd-vscode.keymap": {
"find": [
{
"altKey": true,
"key": "F"
}
],
"selectAllColumn": [] // remove keymap
}
}
```
## Document
- [Import SQL DDL support syntax](https://github.com/dineug/sql-ddl-parser/blob/master/src/SQL_DDL_Test_Case.md)
- [Live Demo](https://vuerd.github.io/vuerd/iframe.html?id=example-demo--erd-editor&args=&viewMode=story)
## Editor Keymap(default)
| Name | Keymap |
| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Editing - ERD | dblclick, Enter |
| Editing - Grid | dblclick, Enter |
| All Stop | Escape |
| Search - find, filter | Ctrl + F, Cmd + F |
| Undo - ERD | Ctrl + Z, Cmd + Z |
| Redo - ERD | Ctrl + Shift + Z, Cmd + Shift + Z |
| Selection - table, memo | Ctrl + Drag, Click, Ctrl + Click, Ctrl + Alt + A, Cmd + Drag, Cmd + Click, Cmd + Alt + A |
| Selection - column, filter | Click, Ctrl + Click, Cmd + Click, Shift + Click, Shift + Arrow key(up, down), Alt + A |
| Movement - table, memo, column, filter | Drag, Ctrl + Drag, Cmd + Drag |
| Copy - column | Ctrl + C, Cmd + C |
| Paste - column | Ctrl + V, Cmd + V |
| Contextmenu - ERD, Table, Relationship, SQL, GeneratorCode | Right-click |
| Table Properties | Ctrl + Space, Alt + Space |
| New Table | Alt + N |
| New Memo | Alt + M |
| New - column, filter | Alt + Enter |
| Delete - table, memo | Ctrl + Delete, Ctrl + Backspace, Cmd + Delete, Cmd + Backspace |
| Delete - column, filter | Alt + Delete, Alt + Backspace |
| Select Hint - dataType, find | Arrow key(right), Click |
| Move Hint - dataType, find | Arrow key(up, down) |
| Primary Key | Alt + K |
| checkbox - Grid, filter | Space, Click |
| Move checkbox - Grid, filter | Arrow key(up, down, left, right) |
| Relationship - Zero One | Ctrl + Alt + 1, Cmd + Alt + 1 |
| Relationship - Zero N | Ctrl + Alt + 2, Cmd + Alt + 2 |
| Relationship - One Only | Ctrl + Alt + 3, Cmd + Alt + 3 |
| Relationship - One N | Ctrl + Alt + 4, Cmd + Alt + 4 |
| Zoom In - ERD | Ctrl + Equal, Cmd + Equal |
| Zoom Out - ERD | Ctrl + Minus, Cmd + Minus |