Release v0.3.0 (#131)

* Bump version to 0.3.0 * Fix outline and property behavior * Update readme * Use all contributors spec * Fix readme * Also add package diagram entry * Update changelog * Update README.md
borkdominik · Jul 21, 2023 · 38c1c03 · 38c1c03
1 parent b8eff56
commit 38c1c03
Show file tree

Hide file tree

Showing 23 changed files with 701 additions and 69 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -0,0 +1,96 @@
+{
+  "projectName": "bigUML",
+  "projectOwner": "borkdominik",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "none",
+  "contributorsSortAlphabetically": true,
+  "contributors": [
+    {
+      "login": "haydar-metin",
+      "name": "Haydar Metin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13104167?v=4",
+      "profile": "https://github.com/haydar-metin",
+      "contributions": [
+        "code", "maintenance", "diagram"
+      ]
+    },
+    {
+      "login": "aylin-sarioglu",
+      "name": "Aylin Sarioğlu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/61785275?v=4",
+      "profile": "https://github.com/aylin-sarioglu",
+      "contributions": [
+        "code", "diagram"
+      ]
+    },
+    {
+      "login": "julia05",
+      "name": "julia05",
+      "avatar_url": "https://avatars.githubusercontent.com/u/23345501?v=4",
+      "profile": "https://github.com/julia05",
+      "contributions": [
+        "code", "diagram"
+      ]
+    },
+    {
+      "login": "JakobD97",
+      "name": "JakobD97",
+      "avatar_url": "https://avatars.githubusercontent.com/u/57354440?v=4",
+      "profile": "https://github.com/JakobD97",
+      "contributions": [
+        "code", "diagram"
+      ]
+    },
+    {
+      "login": "DerYeger",
+      "name": "Jan Müller",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7950094?v=4",
+      "profile": "https://jan-mueller.at/",
+      "contributions": [
+        "code", "diagram"
+      ]
+    },
+    {
+      "login": "mrstexx",
+      "name": "Stefan Miljevic",
+      "avatar_url": "https://avatars.githubusercontent.com/u/18032955?v=4",
+      "profile": "https://github.com/mrstexx",
+      "contributions": [
+        "code", "diagram"
+      ]
+    },
+    {
+      "login": "borkdominik",
+      "name": "borkdominik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/60790671?v=4",
+      "profile": "http://model-engineering.info/",
+      "contributions": [
+        "projectManagement"
+      ]
+    },
+    {
+      "login": "deweiiss",
+      "name": "Julian Weiß",
+      "avatar_url": "https://avatars.githubusercontent.com/u/73828363?v=4",
+      "profile": "https://github.com/deweiiss",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "types": {
+    "diagram": {
+      "symbol": "↔",
+      "description": "Worked on a diagram",
+      "link": ""
+    }
+  },
+  "contributorsPerLine": 7,
+  "linkToUsage": false
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+*.log
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,16 @@ All notable changes to this project will be documented in this file.
 
 ### What's Changed
 
+## [v0.3.0 - 2023-05-23](https://github.com/borkdominik/bigUML/releases/tag/v0.3.0)
+
+### What's Changed
+
+- Introduce diagram popup by @haydar-metin in https://github.com/borkdominik/bigUML/pull/124
+- Move property palette to VSCode by @haydar-metin in https://github.com/borkdominik/bigUML/pull/125
+- Add usecase diagram together with server message handling and copy paste operations by @haydar-metin, @julia05, @JakobD97 in https://github.com/borkdominik/bigUML/pull/127
+- Add package diagram together with diagram outline view by @haydar-metin, @DerYeger, @mrstexx in https://github.com/borkdominik/bigUML/pull/128
+- Remove theia and bug fixes by @haydar-metin in https://github.com/borkdominik/bigUML/pull/130
+
 ## [v0.2.1 - 2023-05-23](https://github.com/borkdominik/bigUML/releases/tag/v0.2.1)
 
 ### What's Changed

diff --git a/README.md b/README.md
@@ -1,15 +1,3 @@
-<!-- LOGO -->
-<p align="center">
-  <img src="./client/packages/uml-vscode-integration/extension/resources/logo.png" alt="Logo" width="150" height="150" />
-</p>
-
-<!-- TITLE -->
-<h1 align="center">bigUML Modeling Tool</h1>
-
-<p align="center">
-  <strong>Editing UML diagrams in VS Code and developing custom integrations for your IDE of choice is now possible.</strong>
-</p>
-
 <!-- DEMO -->
 <p align="center">
   <img src="./media/bigUML-demo.gif" alt="Demo" />
@@ -23,11 +11,22 @@
   <a target="_blank" href="https://marketplace.visualstudio.com/items?itemName=BIGModelingTools.umldiagram">
     <img alt="Visual Studio Marketplace Version" src="https://img.shields.io/visual-studio-marketplace/v/BIGModelingTools.umldiagram?style=for-the-badge&label=VS%20Code%20Version" height="20"/>
   </a>
-  <a target="_blank" href="https://github.com/borkdominik/bigUML/graphs/contributors">
-    <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/borkdominik/bigUML?color=lightgrey&style=for-the-badge" height="20"/>
-  </a>
 </p>
 
+<br>
+
+<!-- LOGO -->
+<img align="left" src="./client/packages/uml-vscode-integration/extension/resources/logo.png" alt="Logo" width="150" height="150" />
+
+<!-- TITLE -->
+<h1 align="center">&emsp;bigUML Modeling Tool</h1>
+
+<p align="center">
+  &emsp;<strong>Editing UML diagrams in VS Code and developing custom integrations for your IDE of choice is now possible.</strong>
+</p>
+
+<br>
+
 - For VS Code users, the project is already distributed in the [VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=BIGModelingTools.umldiagram) and can be installed directly from VS Code.
 
 - This project enables developers to create their own editors by utilizing [GLSP](https://www.eclipse.org/glsp/), where the UML specification is/will be implemented.
@@ -54,17 +53,47 @@
 
 The UML 2 specification currently consists of **7 Structure Diagrams** and **7 Behavior Diagrams**.
 
+<details>
+<summary><strong>Class Diagram</strong></summary>
+
+<img src="./media/vscode-class.png" alt="Class Diagram" />
+
+</details>
+
+<details>
+<summary><strong>Use Case Diagram</strong></summary>
+
+<img src="./media/vscode-usecase.png" alt="Use Case Diagram" />
+
+<em>Initial implementation provided by: [@julia05](https://github.com/julia05), [@JakobD97](https://github.com/JakobD97)</em>
+
+</details>
+
+<details>
+<summary><strong>Package Diagram</strong></summary>
+
+Coming Soon!
+
+<em>Initial implementation provided by: [@DerYeger](https://github.com/DerYeger), [@mrstexx](https://github.com/mrstexx)</em>
+
+</details>
+
+<details>
+<summary><strong>Progress</strong></summary>
+
 ### Structure Diagrams
 
-| Class       | Component | Deployment | Object | Package | Profile | Composite |
-| ----------- | --------- | ---------- | ------ | ------- | ------- | --------- |
-| In progress | -         | -          | -      | -       | -       | -         |
+| Class  | Component | Deployment | Object | Package              | Profile | Composite |
+| ------ | --------- | ---------- | ------ | -------------------- | ------- | --------- |
+| Merged | -         | -          | -      | Merged, not released | -       | -         |
 
 ### Behavior Diagrams
 
-| Use Case | Activity | State Machine | Sequence                 | Communication | Interaction | Timing |
-| -------- | -------- | ------------- | ------------------------ | ------------- | ----------- | ------ |
-| -        | -        | -             | Contribution in progress | In progress   | -           | -      |
+| Use Case | Activity | State Machine | Sequence                 | Communication        | Interaction | Timing |
+| -------- | -------- | ------------- | ------------------------ | -------------------- | ----------- | ------ |
+| Merged   | -        | -             | Contribution in progress | Merged, not released | -           | -      |
+
+</details>
 
 ## Documentation
 
@@ -79,20 +108,36 @@ Get started with bigUML, learn fundamentals, explore advanced topics, or go thro
 
 Need help concerning the setup? Then go right to [Requirements](./docs/requirements.md) and continue with [Getting Started](./docs/getting-started.md).
 
-## Contributing
-
-Contributions to the project are always welcome!
-
-Do not hesitate to report a bug or to request a feature. Feel free to [open Issues](./issues) or submit PRs.
-
-### Maintainers
-
-- [Haydar Metin](https://github.com/haydar-metin) (main-developer)
-- [Julian Weiß](https://github.com/deweiiss) (former main-developer)
-- [Dominik Bork](https://github.com/borkdominik)
-- EclipseSource
-
-See [Contributors](./docs/contributors.md) for the list of the previous contributors.
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/aylin-sarioglu"><img src="https://avatars.githubusercontent.com/u/61785275?v=4?s=100" width="100px;" alt="Aylin Sarioğlu"/><br /><sub><b>Aylin Sarioğlu</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=aylin-sarioglu" title="Code">💻</a> <a href="#diagram-aylin-sarioglu" title="Worked on a diagram">↔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/haydar-metin"><img src="https://avatars.githubusercontent.com/u/13104167?v=4?s=100" width="100px;" alt="Haydar Metin"/><br /><sub><b>Haydar Metin</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=haydar-metin" title="Code">💻</a> <a href="#maintenance-haydar-metin" title="Maintenance">🚧</a> <a href="#diagram-haydar-metin" title="Worked on a diagram">↔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/JakobD97"><img src="https://avatars.githubusercontent.com/u/57354440?v=4?s=100" width="100px;" alt="JakobD97"/><br /><sub><b>JakobD97</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=JakobD97" title="Code">💻</a> <a href="#diagram-JakobD97" title="Worked on a diagram">↔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://jan-mueller.at/"><img src="https://avatars.githubusercontent.com/u/7950094?v=4?s=100" width="100px;" alt="Jan Müller"/><br /><sub><b>Jan Müller</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=DerYeger" title="Code">💻</a> <a href="#diagram-DerYeger" title="Worked on a diagram">↔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/deweiiss"><img src="https://avatars.githubusercontent.com/u/73828363?v=4?s=100" width="100px;" alt="Julian Weiß"/><br /><sub><b>Julian Weiß</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=deweiiss" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrstexx"><img src="https://avatars.githubusercontent.com/u/18032955?v=4?s=100" width="100px;" alt="Stefan Miljevic"/><br /><sub><b>Stefan Miljevic</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=mrstexx" title="Code">💻</a> <a href="#diagram-mrstexx" title="Worked on a diagram">↔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://model-engineering.info/"><img src="https://avatars.githubusercontent.com/u/60790671?v=4?s=100" width="100px;" alt="borkdominik"/><br /><sub><b>borkdominik</b></sub></a><br /><a href="#projectManagement-borkdominik" title="Project Management">📆</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/julia05"><img src="https://avatars.githubusercontent.com/u/23345501?v=4?s=100" width="100px;" alt="julia05"/><br /><sub><b>julia05</b></sub></a><br /><a href="https://github.com/borkdominik/bigUML/commits?author=julia05" title="Code">💻</a> <a href="#diagram-julia05" title="Worked on a diagram">↔</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+Contributions of any kind are welcome! Do not hesitate to report a bug or to request a feature. Feel free to [open Issues](./issues) or submit PRs.
 
 If you like our work, please feel free to [buy us a coffee](https://www.buymeacoffee.com/bigERtool) ☕️
 

diff --git a/client/environments/theia-app/package.json b/client/environments/theia-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "biguml-theia",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "private": true,
   "license": "MIT",
   "author": {

diff --git a/client/packages/uml-common/package.json b/client/packages/uml-common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@borkdominik-biguml/uml-common",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "UML-Common",
   "homepage": "https://github.com/borkdominik/bigUML",
   "bugs": "https://github.com/borkdominik/bigUML/issues",

diff --git a/client/packages/uml-components/package.json b/client/packages/uml-components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@borkdominik-biguml/uml-components",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "UML-Components",
   "homepage": "https://github.com/borkdominik/bigUML",
   "bugs": "https://github.com/borkdominik/bigUML/issues",

diff --git a/...nt/packages/uml-components/src/property-palette/web/property-palette-webview.component.ts b/...nt/packages/uml-components/src/property-palette/web/property-palette-webview.component.ts
@@ -7,7 +7,7 @@
  * SPDX-License-Identifier: MIT
  *********************************************************************************/
 
-import { ElementProperties, SetPropertyPaletteAction } from '@borkdominik-biguml/uml-common';
+import { ElementProperties, RefreshPropertyPaletteAction, SetPropertyPaletteAction } from '@borkdominik-biguml/uml-common';
 import { Action } from '@eclipse-glsp/protocol';
 import { html, TemplateResult } from 'lit';
 import { query, state } from 'lit/decorators.js';
@@ -39,6 +39,8 @@ export class PropertyPaletteWebview extends BigElement {
         });
 
         this.connection.listen(this.onConnectionAction.bind(this), Action.is);
+
+        this.dispatchAction(RefreshPropertyPaletteAction.create());
     }
 
     protected override render(): TemplateResult<1> {
@@ -60,10 +62,14 @@ export class PropertyPaletteWebview extends BigElement {
     }
 
     protected onDispatchAction(event: CustomEvent<Action>): void {
+        this.dispatchAction(event.detail);
+    }
+
+    protected dispatchAction(payload: Action): void {
         this.connection.post<Action>({
             clientId: this.clientId,
             command: 'dispatch-action',
-            payload: event.detail
+            payload
         });
     }
 }
diff --git a/client/packages/uml-components/src/vscode/vscode-api.ts b/client/packages/uml-components/src/vscode/vscode-api.ts
@@ -14,6 +14,8 @@ import { v4 } from 'uuid';
 
 export interface VSCodeApi {
     postMessage: (message: any) => void;
+    getState<T>(): T | undefined;
+    setState(json: object): void;
 }
 
 let api: VSCodeApi | undefined;
@@ -44,7 +46,7 @@ export class VSCodeConnection {
     private static _instance: VSCodeConnection;
     protected listeners: { [commandId: string]: (result: any, error: any) => void } = {};
 
-    protected readonly vscode: VSCodeApi;
+    readonly vscode: VSCodeApi;
 
     private constructor() {
         this.vscode = getOrAcquireVSCodeApi();

diff --git a/client/packages/uml-glsp/package.json b/client/packages/uml-glsp/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@borkdominik-biguml/uml-glsp",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "UML-GLSP",
   "homepage": "https://github.com/borkdominik/bigUML",
   "bugs": "https://github.com/borkdominik/bigUML/issues",

diff --git a/client/packages/uml-integration/package.json b/client/packages/uml-integration/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@borkdominik-biguml/uml-integration",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "UML-Integration",
   "homepage": "https://github.com/borkdominik/bigUML",
   "bugs": "https://github.com/borkdominik/bigUML/issues",

diff --git a/client/packages/uml-modelserver/package.json b/client/packages/uml-modelserver/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@borkdominik-biguml/uml-modelserver",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "UML-Modelserver",
   "homepage": "https://github.com/borkdominik/bigUML",
   "bugs": "https://github.com/borkdominik/bigUML/issues",