Skip to content

Commit

Permalink
v0.2.0
Browse files Browse the repository at this point in the history
* Add a changelog.
* Add option to print executable version: `./go-wardley -V` or `./go-wardley --version`.
* Update HCL parsing code to allow for optional values.
* Update HCL parsing to print user facing diagnostic errors.
* Add fsnotify file watches.
* Allow defining Map Details (size) in HCL.
  • Loading branch information
DavidGamba committed Feb 13, 2020
1 parent 5812944 commit 57a073f
Show file tree
Hide file tree
Showing 10 changed files with 694 additions and 218 deletions.
72 changes: 49 additions & 23 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@ toc::[]
== Usage

----
$ go-wardley -f examples/map.hcl
map.svg
$ ./go-wardley -f examples/map.hcl
Updated file: examples/map.svg
$ go-wardley -f examples/map.hcl -o examples/map.svg
examples/map.svg
$ ./go-wardley -f examples/map.hcl -o examples/map.svg
Updated file: examples/map.svg
# Watch for file changes and update the file automatically.
$ ./go-wardley -f examples/map.hcl --watch
Starting watcher on: examples
Updated file: examples/map.svg
Updated file: examples/map.svg
----

image::./examples/map.svg[]
Expand All @@ -27,13 +33,13 @@ image::./examples/map.svg[]

----
node user {
label = "User"
label = "User" # Required
visibility = 1 # Required
evolution = "custom" # Required
x = 1 # Required
description = "Description"
fill = "black"
color = "black"
visibility = 1
evolution = "custom"
x = 1
description = "User Description"
}
----

Expand All @@ -43,9 +49,9 @@ node user {

----
connector {
from = "user"
to = "vcs"
label = ""
from = "user" # Required
to = "vcs" # Required
label = "Description"
color = "black"
type = "normal"
}
Expand All @@ -61,56 +67,76 @@ A more extensive one in link:./examples/map.hcl[].
----
node user {
label = "User"
fill = "black"
color = "black"
visibility = 1
evolution = "custom"
x = 1
description = "User Description"
fill = "black"
}
node vcs {
label = "On Prem VCS"
fill = "black"
color = "black"
visibility = 2
evolution = "product"
x = 1
description = "On prem VCS"
fill = "black"
}
node code_commit {
label = "Code Commit Mirror"
fill = "white"
color = "red"
visibility = 2
evolution = "commodity"
x = 1
description = "Allows Code Pipeline to access the code."
color = "red"
}
connector {
from = "user"
to = "vcs"
label = ""
color = "black"
type = "normal"
}
connector {
from = "vcs"
to = "code_commit"
label = ""
color = "red"
type = "change-inertia"
}
----

== Roadmap

* Looking into how to leverage HCL's extra features, in particular being able to reference a previous node for relative positioning:
+
----
node user {
...
x = 1
}
node vcs {
...
x = node.user.x + 1
}
----
+
It will allow moving groups of elements within the maps and even exporting/importing them to/from other maps and having to adjust only the anchor node absolute position.

* Make the node label optional, read the node ID if not present and title case it (configurable?).

* Add an optional leyend box indicating the types of elements used in the map.

* Better looks overall. Cleaner code.

* Allow specifying node, connector and grid font sizes independently.

* Arch type connector.

== License

This file is part of go-wardley.

Copyright (C) 2019 David Gamba Rios
Copyright (C) 2019-2020 David Gamba Rios

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
Expand Down
14 changes: 14 additions & 0 deletions changelog.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Changelog

== v0.2.0

* Add a changelog.
* Add option to print executable version: `./go-wardley -V` or `./go-wardley --version`.
* Update HCL parsing code to allow for optional values.
* Update HCL parsing to print user facing diagnostic errors.
* Add fsnotify file watches.
* Allow defining Map Details (size) in HCL.

== v0.1.0

Sharing MVP with the world, it sucks but it works.
Loading

0 comments on commit 57a073f

Please sign in to comment.