oceanprotocol/squid-js
1
0
Fork 0
mirror of https://github.com/oceanprotocol-archive/squid-js.git synced 2024-02-02 15:31:51 +01:00
Code Releases Activity

hotfix for typedoc spec generation

Browse Source 
* initializing the TypeDoc app changed with typedoc v0.16+
* adapt the script to generate the spec used in our docs to the new syntax
This commit is contained in:
Matthias Kretschmann 2020-01-22 17:44:38 +01:00
parent 9512504862
commit 5e569f5f5d
Signed by: m
GPG Key ID: 606EEEF3C479A91F
3 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
package-lock.json generated
View File

@ -7191,13 +7191,10 @@
"dev": true "dev": true
}, },
"highlight.js": { "highlight.js": {
"version": "9.17.1", "version": "9.18.0",
"resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-9.17.1.tgz", "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-9.18.0.tgz",
"integrity": "sha512-TA2/doAur5Ol8+iM3Ov7qy3jYcr/QiJ2eDTdRF4dfbjG7AaaB99J5G+zSl11ljbl6cIcahgPY6SKb3sC3EJ0fw==", "integrity": "sha512-A97kI1KAUzKoAiEoaGcf2O9YPS8nbDTCRFokaaeBhnqjQTvbAuAJrQMm21zw8s8xzaMtCQBtgbyGXLGxdxQyqQ==",
"dev": true, "dev": true
"requires": {
"handlebars": "^4.5.3"
}
}, },
"hmac-drbg": { "hmac-drbg": {
"version": "1.0.1", "version": "1.0.1",
@ -12893,9 +12890,9 @@
} }
}, },
"typedoc": { "typedoc": {
"version": "0.16.6", "version": "0.16.8",
"resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.16.6.tgz", "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.16.8.tgz",
"integrity": "sha512-1k4HXW5o6/rk5U3NEXEM+UVMPWaM0xW1/WJo1wlptb0gzsqtahymLDFSBX8Nqi7cToKOuiJPUr8j8UU368UNoA==", "integrity": "sha512-KO5z33qZ/+dXY5e87YtrD6sr7/BjrD70L0EwzwvQEvS0vuzQRHbXfeeJHschYjpMp3D2BmX4bwEKUMEN8dHDAA==",
"dev": true, "dev": true,
"requires": { "requires": {
"@types/minimatch": "3.0.3", "@types/minimatch": "3.0.3",
@ -12907,7 +12904,7 @@
"minimatch": "^3.0.0", "minimatch": "^3.0.0",
"progress": "^2.0.3", "progress": "^2.0.3",
"shelljs": "^0.8.3", "shelljs": "^0.8.3",
"typedoc-default-themes": "^0.7.1", "typedoc-default-themes": "^0.7.2",
"typescript": "3.7.x" "typescript": "3.7.x"
}, },
"dependencies": { "dependencies": {
@ -12943,9 +12940,9 @@
} }
}, },
"typedoc-default-themes": { "typedoc-default-themes": {
"version": "0.7.1", "version": "0.7.2",
"resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.7.1.tgz", "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.7.2.tgz",
"integrity": "sha512-s3jeUHc4EY8snIta6lNkUu9+36WMDUnkKm0UQ59w5iPo/4Y2d4+M9CDIKoenYKT5hkg/UnTc3oX48VZZytv8Xw==", "integrity": "sha512-fiFKlFO6VTqjcno8w6WpTsbCgXmfPHVjnLfYkmByZE7moaz+E2DSpAT+oHtDHv7E0BM5kAhPrHJELP2J2Y2T9A==",
"dev": true, "dev": true,
"requires": { "requires": {
"backbone": "^1.4.0", "backbone": "^1.4.0",
@ -12955,9 +12952,9 @@
} }
}, },
"typescript": { "typescript": {
"version": "3.7.3", "version": "3.7.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.3.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.5.tgz",
"integrity": "sha512-Mcr/Qk7hXqFBXMN7p7Lusj1ktCBydylfQM/FZCk5glCNQJrCUKPkMHdo9R0MTFWsC/4kPFvDS0fDPvukfCkFsw==", "integrity": "sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==",
"dev": true "dev": true
}, },
"uglify-js": { "uglify-js": {

4
package.json
View File

@ -87,8 +87,8 @@
"prettier": "^1.19.1", "prettier": "^1.19.1",
"source-map-support": "^0.5.16", "source-map-support": "^0.5.16",
"ts-node": "^8.5.4", "ts-node": "^8.5.4",
"typedoc": "^0.16.5", "typedoc": "^0.16.8",
"typescript": "^3.7.3", "typescript": "^3.7.5",
"uglifyjs-webpack-plugin": "^2.2.0", "uglifyjs-webpack-plugin": "^2.2.0",
"webpack": "^4.41.3", "webpack": "^4.41.3",
"webpack-cli": "^3.3.10", "webpack-cli": "^3.3.10",

8
scripts/typedoc.js
View File

@ -3,7 +3,7 @@
/* eslint-disable security/detect-non-literal-fs-filename */ /* eslint-disable security/detect-non-literal-fs-filename */
const fs = require('fs') const fs = require('fs')
const typedoc = require('typedoc') const TypeDoc = require('typedoc')
const typescript = require('typescript') const typescript = require('typescript')
const ora = require('ora') const ora = require('ora')
const squidJsPackage = require('../package.json') const squidJsPackage = require('../package.json')
@ -21,7 +21,11 @@ const generateJson = () => {
const spinnerTypedoc = ora('Generating TypeDoc json...').start() const spinnerTypedoc = ora('Generating TypeDoc json...').start()
// Setup our TypeDoc app // Setup our TypeDoc app
const app = new typedoc.Application({ const app = new TypeDoc.Application()
app.options.addReader(new TypeDoc.TSConfigReader())
app.options.addReader(new TypeDoc.TypeDocReader())
app.bootstrap({
tsconfig: config tsconfig: config
}) })