Merge pull request #32 from borkdominik/v0.2.0

V0.2.0
borkdominik · Oct 21, 2022 · dd6a17e · dd6a17e
2 parents a47ab08 + 3ca3486
commit dd6a17e
Show file tree

Hide file tree

Showing 65 changed files with 2,122 additions and 885 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,71 @@
+# Contribution Guidelines
+
+> *Welcome and thank you for considering contributing to bigER!*
+
+<!-- TABLE OF CONTENTS -->
+**📖 Table of Contents**
+1. [Bug Reports and Feature Request](#bug-reports-and-feature-request)
+2. [Questions and Other Issues](#questions-and-other-issues)
+3. [Creating Issues](#creating-issues)
+4. [Submit Changes](#submit-changes)
+
+
+<!-- TODO: code of conduct
+## Code of Conduct -->
+
+## Bug Reports and Feature Request
+
+If you noticed any new problems or miss certain functionality, you can use the provided [issue templates](https://github.com/borkdominik/bigER/issues/new/choose) to create a new bug report or feature request.
+
+## Questions and Other Issues
+
+Feel free to [open a blank issue](https://github.com/borkdominik/bigER/issues/new) in case you have questions or anything else to report. 
+
+## Creating Issues
+
+Please assure the following before submitting a new issue:
+- [X] Issue does not exist yet 
+- [X] Using the latest version bigER
+- [X] Look through documentation in the [bigER Wiki](https://github.com/borkdominik/bigER/wiki/)
+
+You can use one of the pre-defined labels to classify your issue. Currently, we use the following labels:
+- `bug` - Problems related to bugs
+- `discussion` - Discussion or question
+- `dev` - Improvements to the development experience
+- `docs` - Improvements or additions to documentation
+- `duplicate` - Duplicate of an existing issue
+- `feature` - Request new changes
+- `help` - Support needed
+- `needs more info` - Missing information to be valid
+- `won't do` - Currently considered out of scope and will not be worked on
+
+
+
+
+
+
+## Submit Changes
+
+
+**Fork the project**
+
+Fork the [bigER repository](https://github.com/borkdominik/bigER) so you can later submit a pull request with your changes. See the [GitHub Documentation on forking projects](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for more details.
+
+**Clone locally**
+
+Clone your fork locally:
+
+```bash
+git clone https://github.com/<your-username>/bigER.git
+```
+
+Make sure to merge recent changes from the upstream repository with your fork:
+
+```bash
+git checkout main
+git pull https://github.com/borkdominik/bigER.git main
+```
+
+**Submit Pull Request (PR)**
+
+Push your staged commits to your fork and [create a new pull request](https://github.com/borkdominik/bigER/pulls). Optionally link the PR with a corresponding issue. A code owner will review the changes and decide whether the PR can be merged with the `main` branch. 
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,3 @@
-# Pull Request Template
-
-## Description
-
 Describe your changes ...
 
 Fixes # (issue ID)
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,61 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "bigER: Build all",
+            "type": "shell",
+            "command": "yarn",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "bigER: Build Language Server",
+            "type": "shell",
+            "command": "language-server/gradlew -p language-server/ build",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "bigER: Build Webview",
+            "type": "shell",
+            "command": "yarn --cwd webview",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "bigER: Build Extension",
+            "type": "shell",
+            "command": "yarn --cwd extension",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": []
+        }
+    ]
+}
diff --git a/base-tsconfig.json b/base-tsconfig.json
@@ -5,19 +5,27 @@
         "downlevelIteration": true,
         "emitDecoratorMetadata": true,
         "experimentalDecorators": true,
+        "jsx": "react",
         "lib": [
-            "es6"
+            "ES2017", 
+            "dom" 
         ],
         "module": "commonjs",
         "moduleResolution": "node",
+        "noImplicitAny": true,
+        "noImplicitOverride": true,
+        "noImplicitReturns": true,
+        "noImplicitThis": true,
         "noUnusedLocals": true,
+        "resolveJsonModule": true,
         "skipLibCheck": true,
         "sourceMap": true,
         "strict": true, 
+        "strictNullChecks": true,
         "strictPropertyInitialization": false,             
-        "target": "es5"
-    },
-    "exclude": [
-        ".vscode-test"
-    ]
+        "target": "ES2017",
+        "types": [ 
+            "node"
+        ]
+    }
 }  
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
diff --git a/docs/ISSUES.md b/docs/ISSUES.md
diff --git a/docs/img/bachman-one-plus.png b/docs/img/bachman-one-plus.png
diff --git a/docs/img/bachman-one.png b/docs/img/bachman-one.png
diff --git a/docs/img/bachman-zero-plus.png b/docs/img/bachman-zero-plus.png
diff --git a/docs/img/bachman-zero.png b/docs/img/bachman-zero.png
diff --git a/docs/img/basic-example.png b/docs/img/basic-example.png
diff --git a/docs/img/chen-many.png b/docs/img/chen-many.png
diff --git a/docs/img/chen-one.png b/docs/img/chen-one.png
diff --git a/docs/img/crows-one-or-more.png b/docs/img/crows-one-or-more.png
diff --git a/docs/img/crows-one-or-one.png b/docs/img/crows-one-or-one.png
diff --git a/docs/img/crows-zero-or-more.png b/docs/img/crows-zero-or-more.png
diff --git a/docs/img/crows-zero-or-one.png b/docs/img/crows-zero-or-one.png
diff --git a/docs/img/default-custom.png b/docs/img/default-custom.png
diff --git a/docs/img/default-many.png b/docs/img/default-many.png
diff --git a/docs/img/default-none.png b/docs/img/default-none.png
diff --git a/docs/img/default-one.png b/docs/img/default-one.png
diff --git a/docs/img/demo.gif b/docs/img/demo.gif
diff --git a/docs/img/issue-workflow.png b/docs/img/issue-workflow.png
diff --git a/docs/img/minmax-1.png b/docs/img/minmax-1.png
diff --git a/docs/img/minmax-2.png b/docs/img/minmax-2.png
diff --git a/docs/img/tool-screenshot.png b/docs/img/tool-screenshot.png
diff --git a/examples/relationships.erd b/examples/relationships.erd
@@ -0,0 +1,30 @@
+erdiagram Model
+
+notation=default
+generate=off
+
+entity Entity1 { id key }
+entity Entity2 { id key }
+entity Entity3 { id key }
+entity Entity4 { id key }
+entity Entity5 { id key }
+entity Entity6 { id key }
+entity Entity7 { id key }
+entity Entity8 { id key }
+
+relationship Rel1 {
+    // zero-or-one -> one-and-only-one
+    Entity1[0..1] -> Entity2[1..1]
+}
+relationship Rel2 {
+    // [1..1] is the same as [1] (one)
+    Entity3[1..1] -> Entity4[1]
+}
+relationship Rel3 {
+    // zero-or-more -> one-or-more
+    Entity5[0..N] -> Entity6[1..N]
+}
+relationship Rel4 {
+    // [1..N] is the same as [N] (many)
+    Entity7[1..N] -> Entity8[N]
+}
diff --git a/extension/CHANGELOG.md b/extension/CHANGELOG.md
@@ -1,6 +1,24 @@
 # Changelog
+
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+
+## v0.2.0 - *10-2022*
+
+### Added
+- Support for participation constraints in the textual model. Can be specified by adding `[0..1]` (zero or one) or `[0..N]` (zero or more) to referenced entities in the relationship.
+- `Add Attribute` action to diagram popup when hovering over elements. 
+- Formatter for `.erd` files. Can be executed, e.g., from the command palette by searching for the `Format Document` command.
+- Various code improvements and tests.
+
+### Changed
+- Improvements to multi-notation support, enabled through the newly introduced participation constraints. See the [Notation page in the Wiki](https://github.com/borkdominik/bigER/wiki/Notations) for more details.
+
+
+### Removed
+- UML notation removed, as it will be reworked and available again in a future release. 
+
+
 ## v0.1.0 - *08-2022*
 
 ### Added
@@ -9,7 +27,7 @@ All notable changes to this project will be documented in this file. The format
 - Custom datatype for attributes.
 
 
-#### Changed
+### Changed
 - Improved the outline view with icons and better representation of element names
 - Option to enable the code generator from `generateSql` to `generate=sql`