@zenuml/core 2.0.16 → 2.0.17

package/docs/asciidoc/contributor.adoc

@@ -75,5 +75,22 @@ A.method
 The entry point of the demo pages is `src/main.ts`. It will find all the `pre` elements with
 class `zenuml` and render the ZenUML DSL code in it.
 
+== Parser
 
+We use antlr4 to parse the ZenUML DSL code. The grammar files are:
+
+1. Parser: `./src/g4/sequenceParser.g4`
+2. Lexer: `./src/g4/sequenceLexer.g4`
+
+=== How to generate the parser and lexer
+
+Run `yarn antlr4` to generate the parser and lexer.
+
+=== Setup local development environment
+
+Run `yarn antlr:setup` (`python3 -m pip install antlr4-tools`) to install the antlr4 command and the runtime.
+
+To test the setup, go to `src/g4-unit/hello-world` folder, and run:
+
+1.
 

package/docs/divider-parser-allow-spaces.md

@@ -0,0 +1,38 @@
+This document describe the design of parsing rules for the `divider` statement.
+
+## Typical use case
+
+The `divider` statement is used to separate the sequence of statements into logical
+groups.
+
+For example, a HTTPS sequence can be separated into three logical groups:
+1. Connect establishment
+2. TLS handshake
+3. HTTP request/response
+
+```
+Client->Server: TCP SYNC
+Server->Client: TCP SYN+ACK
+Client->Server: TCP ACK
+== Connection Established ==
+Client->Server: TLS Client Hello
+Server->Client: TLS Server Hello
+Server->Client: TLS Certificate
+Server->Client: TLS Server Hello Done
+== Certificate Check ==
+Client->Server: TLS Client Key Exchange
+Client->Server: TLS Change Cipher Spec
+Client->Server: TLS Finished
+Server->Client: TLS Change Cipher Spec
+Server->Client: TLS Finished
+== Key Exchange, Handshake Completed ==
+Client->Server: HTTP Request
+Server->Client: HTTP Response
+```
+
+## The Lexer
+
+
+## `divider` is a statement
+
+`divider` is treated as a statement as any other messages. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenuml/core",
-  "version": "2.0.16",
+  "version": "2.0.17",
   "private": false,
   "repository": {
     "url": "https://github.com/ZenUml/core.git"
@@ -13,10 +13,14 @@
     "test:unit:watch": "yarn antlr && vue-cli-service test:unit --watch",
     "cy": "cypress run",
     "lint": "vue-cli-service lint",
+    "antlr:setup": "python3 -m pip install antlr4-tools",
+    "antlr:generate": "pwd && cd ./src/g4-units/hello-world && antlr4 Hello.g4",
+    "antlr:javac": "pwd && cd ./src/g4-units/hello-world && CLASSPATH=\"../../../antlr/antlr-4.11.1-complete.jar:$CLASSPATH\" javac *.java",
+    "antlr:grun": "pwd && cd ./src/g4-units/hello-world && grun Hello r -tokens",
     "antlr": "yarn antlr:lexer && yarn antlr:parser",
     "antlr:clear": "rm -rf src/generated-parser/*",
-    "antlr:lexer": "java -Duser.dir=$(pwd)/src/g4 -cp $(pwd)/antlr/antlr-4.8-complete.jar org.antlr.v4.Tool -o ./src/generated-parser -Dlanguage=JavaScript sequenceLexer.g4",
-    "antlr:parser": "java -Duser.dir=$(pwd)/src/g4 -cp $(pwd)/antlr/antlr-4.8-complete.jar org.antlr.v4.Tool -o ./src/generated-parser -Dlanguage=JavaScript sequenceParser.g4",
+    "antlr:lexer": "java -Duser.dir=$(pwd)/src/g4 -cp $(pwd)/antlr/antlr-4.11.1-complete.jar org.antlr.v4.Tool -o ./src/generated-parser -Dlanguage=JavaScript sequenceLexer.g4",
+    "antlr:parser": "java -Duser.dir=$(pwd)/src/g4 -cp $(pwd)/antlr/antlr-4.11.1-complete.jar org.antlr.v4.Tool -o ./src/generated-parser -Dlanguage=JavaScript sequenceParser.g4",
     "build-crx": "vue-cli-service build --mode production --target lib --name zenuml/core ./src/index.js",
     "start": "vue-cli-service serve",
     "git:branch:clean:gone": "git fetch -p && git branch -vv | awk '/: gone]/{print $1}' | xargs git branch -d",
@@ -30,7 +34,7 @@
   "dependencies": {
     "@types/assert": "^1.5.4",
     "@types/ramda": "^0.28.0",
-    "antlr4": "~4.8.0",
+    "antlr4": "^4.11.0",
     "color-string": "1.5.2",
     "dom-to-image-more": "^2.9.5",
     "file-saver": "^2.0.5",
@@ -56,6 +60,7 @@
     "@babel/polyfill": "^7.10.1",
     "@babel/preset-env": "^7.13.5",
     "@babel/runtime-corejs2": "^7.12.13",
+    "@types/antlr4": "^4.11.2",
     "@types/color-string": "^1.5.2",
     "@types/jest": "^24.0.19",
     "@types/lodash": "^4.14.168",