Skip to content

Commit 81757af

Browse files
author
vasilenkoalexey
committed
update readmr
1 parent 9b3b8d1 commit 81757af

3 files changed

Lines changed: 34 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,21 @@
55
This Visual Studio Code extension enables software architecture modeling using the [Structurizr DSL](https://github.com/structurizr/dsl). The Structurizr DSL implements the "diagrams as code" approach ([learn more](https://docs.structurizr.com/)) and provides a textual representation of the [C4 model](https://c4model.com/).
66

77
The extension includes:
8-
- A language server built on the official Structurizr DSL parser
8+
- A language server built on the official [Structurizr DSL](https://github.com/structurizr/java/tree/master/structurizr-dsl) parser
99
- Advanced capabilities for architectural description automation
10-
- Diagram visualization
11-
- DSL conversion to other formats
10+
- Syntax highlighting and validation
11+
- Text decorations
12+
- Go to Definition
13+
- Diagram visualization (embedded or structurizr.com cloud)
14+
- Graphviz based diagram auto layouting
15+
- Workspace.json based diagram manual layouting
16+
- Diagram exporing to .svg and .drawio, back imprting layout from .drawio
17+
- Support for workspace extends and `!include` files
1218

1319
## Prerequisites
1420

1521
- **Java 17+** ([download](https://dev.java/download)) - required for the language server
1622
- Workspace containing model files with `.dsl` extension
17-
- Support for multiple workspaces and `!include` files
1823

1924
## Features
2025

@@ -75,10 +80,10 @@ Export diagram to **drawio** and **svg** formats
7580
|--------|--------|---------|-------------|
7681
| `c4.diagram.render` | String | `embedded` | Diagram rendering method (embedded or structurizr.com cloud) |
7782
| `c4.editor.autoformat.indent` | Number | `4` | Spaces per indentation level |
78-
| `c4.languageserver.logs.enabled` | `true`/`false` | `false` | Enable language server logging to `c4-language-server.log` |
83+
| `c4.languageserver.logs.enabled` | `true`/`false` | `false` | Enable language server logging |
7984
| `c4.decorations.enabled` | `off`, `onChange`, `onSave` | `onChange` | Text decoration timing |
80-
| `c4.SSL\TLS.disabled` | `true`/`false` | `false` | Disable SSL/TLS verification |
81-
| `c4.beeline.telemetry.disabled` | `true`/`false` | `false` | Disable ArchOPS telemetry collection |
85+
| `c4.beeline.cert.verification.enabled` | `true`/`false` | `false` | Enable SSL-certificate verification when interacting with the ArchOPS server |
86+
| `c4.beeline.telemetry.enabled` | `true`/`false` | `true` | Enable telemetry collection when interacting with the ArchOPS server |
8287
| `c4.beeline.api.url` | URL | | ArchOPS server URL |
8388
| `c4.beeline.api.key` | String | | ArchOPS API key |
8489
| `c4.beeline.api.secret` | String | | ArchOPS API secret |

extension/CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Change Log
22

3+
## 1.0.8
4+
5+
- Fixed a bug exporting large-sized diagrams to the drawio format
6+
- Fixed a bug exporting diagrams with groups but without groupSeparator to the drawio format
7+
- Escapes the characters while exporting to drawio format
8+
- Write logs directly to the extension output instead of the file
9+
- Button at status bar for creating\writing workspace.json file
10+
- Fixed a bug when a reference to an element in an extended workspace could not be found from an include file while definition calculation
11+
- Fixed a bug when elements which have hierarchical identifiers could not be found while definition calculation
12+
- Some settings renaming
13+
314
## 1.0.7
415

516
- Fixed an error exporting dynamic diagrams to the drawio format

extension/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,21 @@
55
This Visual Studio Code extension enables software architecture modeling using the [Structurizr DSL](https://github.com/structurizr/dsl). The Structurizr DSL implements the "diagrams as code" approach ([learn more](https://docs.structurizr.com/)) and provides a textual representation of the [C4 model](https://c4model.com/).
66

77
The extension includes:
8-
- A language server built on the official Structurizr DSL parser
8+
- A language server built on the official [Structurizr DSL](https://github.com/structurizr/java/tree/master/structurizr-dsl) parser
99
- Advanced capabilities for architectural description automation
10-
- Diagram visualization
11-
- DSL conversion to other formats
10+
- Syntax highlighting and validation
11+
- Text decorations
12+
- Go to Definition
13+
- Diagram visualization (embedded or structurizr.com cloud)
14+
- Graphviz based diagram auto layouting
15+
- Workspace.json based diagram manual layouting
16+
- Diagram exporing to .svg and .drawio, back imprting layout from .drawio
17+
- Support for workspace extends and `!include` files
1218

1319
## Prerequisites
1420

1521
- **Java 17+** ([download](https://dev.java/download)) - required for the language server
1622
- Workspace containing model files with `.dsl` extension
17-
- Support for multiple workspaces and `!include` files
1823

1924
## Features
2025

@@ -77,9 +82,9 @@ Export diagram to **drawio** and **svg** formats
7782
| `c4.editor.autoformat.indent` | Number | `4` | Spaces per indentation level |
7883
| `c4.languageserver.logs.enabled` | `true`/`false` | `false` | Enable language server logging to `c4-language-server.log` |
7984
| `c4.decorations.enabled` | `off`, `onChange`, `onSave` | `onChange` | Text decoration timing |
80-
| `c4.SSL\TLS.disabled` | `true`/`false` | `false` | Disable SSL/TLS verification |
85+
| `c4.beeline.cert.verification.enabled` | `true`/`false` | `false` | Enable SSL-certificate verification when interacting with the ArchOPS server |
86+
| `c4.beeline.telemetry.enabled` | `true`/`false` | `true` | Enable telemetry collection when interacting with the ArchOPS server |
8187
| `c4.beeline.api.url` | URL | | ArchOPS server URL |
82-
| `c4.beeline.telemetry.disabled` | `true`/`false` | `false` | Disable ArchOPS telemetry collection |
8388
| `c4.beeline.api.key` | String | | ArchOPS API key |
8489
| `c4.beeline.api.secret` | String | | ArchOPS API secret |
8590
| `c4.beeline.cloud.token` | String | | Beeline Cloud security token |

0 commit comments

Comments
 (0)