docs: update docs

mgechev · Dec 20, 2017 · b8a0d38 · b8a0d38
1 parent 8072a80
commit b8a0d38
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -167,6 +167,12 @@ npm install -g ts-node
 ts-node demo/index.ts
 ```
 
+# Diagram
+
+Here's a UML class diagram which shows the relations between the individual abstractions:
+
+[![UML Diagram](https://github.com/mgechev/aspect.js/blob/master/assets/diagram.png?raw=true)](https://github.com/mgechev/aspect.js/blob/master/assets/diagram.png?raw=true)
+
 # Roadmap
 
 - [x] Tests
@@ -179,10 +185,9 @@ ts-node demo/index.ts
     - [x] Throwing
     - [x] Returning
   - [x] Around
-- [ ] Implement the following joint points:
+- [x] Implement the following joint points:
   - [x] Method execution
   - [x] Static method execution
-  - [ ] Constructor execution
   - [x] Filed get
   - [x] Field set
 

diff --git a/assets/diagram.png b/assets/diagram.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,8 @@
   "main": "index.js",
   "typings": "index.d.ts",
   "scripts": {
-    "build_publish": "rm -rf dist && tsc && ngc && cp ./package.json README.md dist/lib",
+    "build_publish": "rm -rf dist && tsc && npm run generate_diagram && ngc && cp ./package.json README.md dist/lib",
+    "generate_diagram": "tsviz -r lib/index.ts assets/diagram.png",
     "test": "tsc && mocha -R nyan ./dist/test/**/*.spec.js",
     "format": "prettier --single-quote --trailing-comma es5 --print-width 120 --write lib/src/**/*.ts"
   },
@@ -40,6 +41,7 @@
     "mocha": "^3.4.2",
     "prettier": "^1.7.4",
     "rxjs": "^5.2.0",
+    "tsviz": "^1.0.11",
     "typescript": "^2.0.2",
     "zone.js": "^0.7.7"
   }

diff --git a/yarn.lock b/yarn.lock
@@ -112,6 +112,12 @@ glob@7.1.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
 
+graphviz@>=0.0.8:
+  version "0.0.8"
+  resolved "https://registry.yarnpkg.com/graphviz/-/graphviz-0.0.8.tgz#e599e40733ef80e1653bfe89a5f031ecf2aa4aaa"
+  dependencies:
+    temp "~0.4.0"
+
 growl@1.9.2:
   version "1.9.2"
   resolved "https://registry.yarnpkg.com/growl/-/growl-1.9.2.tgz#0ea7743715db8d8de2c5ede1775e1b45ac85c02f"
@@ -266,6 +272,10 @@ symbol-observable@^1.0.1:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/symbol-observable/-/symbol-observable-1.0.4.tgz#29bf615d4aa7121bdd898b22d4b3f9bc4e2aa03d"
 
+temp@~0.4.0:
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/temp/-/temp-0.4.0.tgz#671ad63d57be0fe9d7294664b3fc400636678a60"
+
 tsickle@^0.2:
   version "0.2.6"
   resolved "https://registry.yarnpkg.com/tsickle/-/tsickle-0.2.6.tgz#ad4abf92e74ebdf3fb5aa187ca85b02066fe1a1b"
@@ -275,6 +285,13 @@ tsickle@^0.2:
     source-map "^0.5.6"
     source-map-support "^0.4.2"
 
+tsviz@^1.0.11:
+  version "1.0.11"
+  resolved "https://registry.yarnpkg.com/tsviz/-/tsviz-1.0.11.tgz#4fdd2b5037487af7cbb987174d3c723bcbaf2444"
+  dependencies:
+    graphviz ">=0.0.8"
+    typescript "=1.8.10"
+
 type-detect@0.1.1:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-0.1.1.tgz#0ba5ec2a885640e470ea4e8505971900dac58822"
@@ -283,6 +300,10 @@ type-detect@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-1.0.0.tgz#762217cc06db258ec48908a1298e8b95121e8ea2"
 
+typescript@=1.8.10:
+  version "1.8.10"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-1.8.10.tgz#b475d6e0dff0bf50f296e5ca6ef9fbb5c7320f1e"
+
 typescript@^2.0.2:
   version "2.3.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.3.4.tgz#3d38321828231e434f287514959c37a82b629f42"