From 82ca7fd73fc8d817efb324f390b8dc6fcd38be7e Mon Sep 17 00:00:00 2001 From: Antonio Barcelos Date: Wed, 3 Nov 2021 15:39:57 +0100 Subject: [PATCH] Update api docs generation scripts --- package.json | 1 + packages/core/src/session.ts | 4 +++- packages/neo4j-driver-lite/esdoc.json | 4 ++-- packages/neo4j-driver-lite/package.json | 2 +- packages/neo4j-driver/esdoc.json | 4 ++-- packages/neo4j-driver/package.json | 1 - 6 files changed, 9 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index ad2f5c7bb..099e7911c 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "scripts": { "clean": "lerna clean -y && lerna run clean", "build": "lerna bootstrap --ci", + "docs": "lerna run docs --stream --concurrency 1", "test::unit": "lerna run test::unit --stream", "test::integration": "lerna run test::integration --stream", "test::browser": "lerna run test::browser --stream", diff --git a/packages/core/src/session.ts b/packages/core/src/session.ts index 5aff5d06b..b790416fd 100644 --- a/packages/core/src/session.ts +++ b/packages/core/src/session.ts @@ -358,10 +358,12 @@ class Session { } /** + * Sets the resolved database name in the session context. * @private * @param {string|undefined} database The resolved database name + * @returns {void} */ - _onDatabaseNameResolved(database?: string): void{ + _onDatabaseNameResolved(database?: string): void { if (!this._databaseNameResolved) { const normalizedDatabase = database || '' this._database = normalizedDatabase diff --git a/packages/neo4j-driver-lite/esdoc.json b/packages/neo4j-driver-lite/esdoc.json index 34917b1c2..7936c503a 100644 --- a/packages/neo4j-driver-lite/esdoc.json +++ b/packages/neo4j-driver-lite/esdoc.json @@ -36,13 +36,13 @@ "enable": false }, "brand": { - "title": "Neo4j Bolt Driver 4.3 for JavaScript", + "title": "Neo4j Bolt Driver 4.4 for JavaScript", "repository": "https://github.com/neo4j/neo4j-javascript-driver" } } }, { - "name": "../docs/embed-docs.plugin.js", + "name": "../neo4j-driver/docs/embed-docs.plugin.js", "option": { "enabled": true, "path": "../core/docs" diff --git a/packages/neo4j-driver-lite/package.json b/packages/neo4j-driver-lite/package.json index 98ea840d1..c46607092 100644 --- a/packages/neo4j-driver-lite/package.json +++ b/packages/neo4j-driver-lite/package.json @@ -17,7 +17,7 @@ "version::set_version.ts": "sed 's/0.0.0-dev/'$VERSION'/g' src/version.ts > src/version.tmp && mv src/version.tmp src/version.ts", "versionRelease": "npm version $VERSION --no-git-tag-version && npm run version::set_version.ts", "build::es6": "tsc --target ES6 --outdir lib6", - "predocs": "cd ../core && npm run docs && cd ../neo4j-driver-lite && npm run build && npm run build::es6", + "predocs": "npm run build && npm run build::es6", "docs": "esdoc -c esdoc.json", "prepare": "npm run build && npm run build:browser", "clean": "rm -fr node_modules lib types" diff --git a/packages/neo4j-driver/esdoc.json b/packages/neo4j-driver/esdoc.json index 4f3ff9c40..0a31e34f1 100644 --- a/packages/neo4j-driver/esdoc.json +++ b/packages/neo4j-driver/esdoc.json @@ -36,7 +36,7 @@ "enable": true }, "brand": { - "title": "Neo4j Bolt Driver 4.3 for JavaScript", + "title": "Neo4j Bolt Driver 4.4 for JavaScript", "repository": "https://github.com/neo4j/neo4j-javascript-driver" } } @@ -45,7 +45,7 @@ "name": "./docs/embed-docs.plugin.js", "option": { "enabled": true, - "path": "./core/docs" + "path": "../core/docs" } } ] diff --git a/packages/neo4j-driver/package.json b/packages/neo4j-driver/package.json index 41ed857db..49da3e8e7 100644 --- a/packages/neo4j-driver/package.json +++ b/packages/neo4j-driver/package.json @@ -21,7 +21,6 @@ "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",