Embed core documentation into driver docs

Author: bigmontz

core/package-lock.json

@@ -25,11 +25,9 @@
     "url": "https://github.com/neo4j/neo4j-javascript-driver/issues"
   },
   "homepage": "https://github.com/neo4j/neo4j-javascript-driver#readme",
-  "dependencies": {
-    "esdoc-typescript-plugin": "^1.0.1",
-    "typescript": "^4.1.3"
-  },
+  "dependencies": {},
   "devDependencies": {
+    "typescript": "^4.1.3",
     "esdoc": "^1.1.0",
     "esdoc-importpath-plugin": "^1.0.2",
     "esdoc-standard-plugin": "^1.0.0"

core/package.json

@@ -0,0 +1,19 @@
+const fs = require('fs')
+let option;
+
+class EmbebDocsPlugin {
+  onStart(ev) {
+    option = ev.data.option
+  }
+
+  onHandleDocs(ev) {
+    if (option.enabled) {
+      const data = fs.readFileSync(option.path + '/index.json', 'utf-8')
+      const embedDocs = JSON.parse(data.toString())
+      ev.data.docs = [...ev.data.docs, ...embedDocs]
+    }
+  };
+
+}
+
+module.exports = new EmbebDocsPlugin();

docs/embed-docs.plugin.js

@@ -40,6 +40,13 @@
           "repository": "https://github.com/neo4j/neo4j-javascript-driver"
         }
       }
+    },
+    {
+      "name": "./docs/embed-docs.plugin.js",
+      "option": {
+        "enabled": true,
+        "path": "./core/docs"
+      }
     }
   ]
 }

esdoc.json

@@ -18,6 +18,7 @@
     "stop-neo4j": "gulp stop-neo4j",
     "run-stress-tests": "gulp run-stress-tests-without-jasmine",
     "run-ts-declaration-tests": "gulp run-ts-declaration-tests",
+    "predocs": "cd core && npm run docs",
     "docs": "esdoc -c esdoc.json",
     "versionRelease": "gulp set --x $VERSION && npm version $VERSION --no-git-tag-version",
     "browser": "gulp browser && gulp test-browser",