chore: setup documentation generation with TypeDoc

ArkEcosystem · Aug 26, 2019 · 01e4744 · 01e4744
1 parent 583f5a9
commit 01e4744
Show file tree

Hide file tree

Showing 35 changed files with 136 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -9,6 +9,7 @@
         "bootstrap": "yarn lerna bootstrap",
         "clean": "yarn lerna clean --yes",
         "build": "yarn lerna run build",
+        "build:docs": "yarn lerna run build:docs",
         "lint": "./node_modules/eslint/bin/eslint.js packages --ext .js,.ts --fix",
         "format": "yarn lint && yarn prettier",
         "prettier": "prettier --write \"./*.{ts,js,json,md}\" \"./packages/**/*.{ts,js,json,md}\" \"./__tests__/**/*.{ts,js,json,md}\"",
@@ -91,6 +92,7 @@
         "rimraf": "^2.6.3",
         "snyk": "^1.193.1",
         "ts-jest": "^24.0.2",
+        "typedoc": "^0.15.0",
         "typescript": "^3.5.3",
         "typesync": "^0.5.1",
         "uuid": "^3.3.2"

diff --git a/packages/core-api/package.json b/packages/core-api/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-blockchain/package.json b/packages/core-blockchain/package.json
@@ -16,6 +16,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-database-postgres/package.json b/packages/core-database-postgres/package.json
@@ -14,6 +14,7 @@
     "scripts": {
         "build": "yarn clean && yarn copy && yarn compile",
         "build:watch": "yarn clean && yarn copy && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "copy": "cd src/ && cpy './**/*.sql' --parents ../dist/ && cd ../",

diff --git a/packages/core-database/package.json b/packages/core-database/package.json
@@ -16,6 +16,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-elasticsearch/package.json b/packages/core-elasticsearch/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-error-tracker-airbrake/package.json b/packages/core-error-tracker-airbrake/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-error-tracker-bugsnag/package.json b/packages/core-error-tracker-bugsnag/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-error-tracker-raygun/package.json b/packages/core-error-tracker-raygun/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-error-tracker-rollbar/package.json b/packages/core-error-tracker-rollbar/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-error-tracker-sentry/package.json b/packages/core-error-tracker-sentry/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-exchange-json-rpc/package.json b/packages/core-exchange-json-rpc/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-explorer/package.json b/packages/core-explorer/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-forger/package.json b/packages/core-forger/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-http-utils/package.json b/packages/core-http-utils/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-jest-matchers/package.json b/packages/core-jest-matchers/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-kernel/package.json b/packages/core-kernel/package.json
@@ -17,6 +17,7 @@
         "compile": "../../node_modules/typescript/bin/tsc",
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist"
     },
     "dependencies": {

diff --git a/packages/core-logger-pino/package.json b/packages/core-logger-pino/package.json
@@ -14,6 +14,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-logger-signale/package.json b/packages/core-logger-signale/package.json
@@ -14,6 +14,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-logger-winston/package.json b/packages/core-logger-winston/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-new-relic/package.json b/packages/core-new-relic/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-p2p/package.json b/packages/core-p2p/package.json
@@ -17,6 +17,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-snapshots/package.json b/packages/core-snapshots/package.json
@@ -14,6 +14,7 @@
     "scripts": {
         "build": "yarn clean && yarn copy && yarn compile",
         "build:watch": "yarn clean && yarn copy && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "copy": "cd src/ && cpy './**/*.sql' --parents ../dist/ && cd ../",

diff --git a/packages/core-state/package.json b/packages/core-state/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-tester-cli/package.json b/packages/core-tester-cli/package.json
@@ -19,6 +19,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepack": "../../node_modules/.bin/oclif-dev manifest && npm shrinkwrap",

diff --git a/packages/core-transaction-pool/package.json b/packages/core-transaction-pool/package.json
@@ -18,6 +18,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-transactions/package.json b/packages/core-transactions/package.json
@@ -14,6 +14,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-utils/package.json b/packages/core-utils/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-vote-report/package.json b/packages/core-vote-report/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile && cp -r src/templates dist/templates",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/packages/core-wallet-api/package.json b/packages/core-wallet-api/package.json
@@ -15,6 +15,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core-webhooks/package.json b/packages/core-webhooks/package.json
@@ -13,6 +13,7 @@
     "scripts": {
         "build": "yarn clean && yarn compile",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -23,6 +23,7 @@
         "ark": "./bin/run",
         "build": "yarn clean && yarn compile && yarn copy",
         "build:watch": "yarn clean && yarn copy && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "copy": "cd ./src && cpy './config' '../dist/' --parents && cd ..",

diff --git a/packages/crypto/package.json b/packages/crypto/package.json
@@ -22,6 +22,7 @@
         "build": "yarn clean && tsc",
         "build:rollup": "yarn clean && tsc && rollup -c",
         "build:watch": "yarn clean && yarn compile -w",
+        "build:docs": "../../node_modules/typedoc/bin/typedoc --out docs src",
         "clean": "del dist",
         "compile": "../../node_modules/typescript/bin/tsc",
         "prepublishOnly": "yarn build"

diff --git a/tsconfig.json b/tsconfig.json
@@ -5,7 +5,6 @@
         "emitDecoratorMetadata": true,
         "esModuleInterop": true,
         "experimentalDecorators": true,
-        "incremental": true,
         "lib": ["es2019"],
         "module": "commonjs",
         "moduleResolution": "node",