From fa786e9ddfdada0728d17069e810b00294790559 Mon Sep 17 00:00:00 2001 From: divdavem Date: Fri, 22 Dec 2023 16:32:51 +0100 Subject: [PATCH] docs: migrate from api-documenter to typedoc (#488) --- .github/workflows/release.yml | 2 +- README.md | 8 +- package-lock.json | 214 +++++++++++++++++++++---- package.json | 6 +- packages/api-extractor.json | 3 +- packages/app/configuration/model.ts | 2 +- packages/app/mocking/checksum/model.ts | 1 + packages/app/mocking/model.ts | 9 +- packages/app/server/impl.ts | 2 +- packages/app/server/model.ts | 8 +- packages/app/server/proxy/model.ts | 2 +- typedoc.json | 10 ++ 12 files changed, 218 insertions(+), 49 deletions(-) create mode 100644 typedoc.json diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 605db716..f939f99c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,7 +36,7 @@ jobs: - name: Updating API documentation in gh-pages branch run: | rm -rf * - cp -a ../apidoc/output/* . + cp -a ../apidoc/* . git add . git commit --allow-empty -a -m "Updating from ${{ github.sha }}" git push origin gh-pages diff --git a/README.md b/README.md index a71df3a8..23a5f87e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![codecov](https://codecov.io/gh/AmadeusITGroup/kassette/branch/master/graph/badge.svg)](https://codecov.io/gh/AmadeusITGroup/kassette)

- kassette-logo + kassette-logo
kassette is a development server, used mainly for testing, which proxies requests and
is able to easily manage local mocks. @@ -46,7 +46,7 @@ With this configuration, input requests targeting URLs starting with `/api/` wil Note that kassette can also be configured to run as a browser proxy, reading the target URL from the request, and intercepting HTTPS communications. -Check [_Getting started_](./doc/getting-started.md) to learn more. +Check [_Getting started_](https://github.com/AmadeusITGroup/kassette/blob/master/doc/getting-started.md) to learn more. ## Main features @@ -85,8 +85,8 @@ If you want to install it locally though, you need to add one more step. You won ## User documentation -It is advised to start with the [_Getting started_](./doc/getting-started.md) article which describes a few practical usage examples, then check the [configuration guide](./doc/configuration.md) and the [API guide](./doc/api.md). The [API reference](https://amadeusitgroup.github.io/kassette/kassette.html) is also available. +It is advised to start with the [_Getting started_](https://github.com/AmadeusITGroup/kassette/blob/master/doc/getting-started.md) article which describes a few practical usage examples, then check the [configuration guide](https://github.com/AmadeusITGroup/kassette/blob/master/doc/configuration.md) and the [API guide](https://github.com/AmadeusITGroup/kassette/blob/master/doc/api.md). The [API reference](https://amadeusitgroup.github.io/kassette/) is also available. ## Developing / Contributing -See [developer guide](./DEVELOPER.md) for details. +See [developer guide](https://github.com/AmadeusITGroup/kassette/blob/master/DEVELOPER.md) for details. diff --git a/package-lock.json b/package-lock.json index f8604e0f..de666755 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,7 +29,6 @@ "@babel/plugin-syntax-typescript": "^7.22.5", "@commitlint/cli": "^18.2.0", "@commitlint/config-conventional": "^18.1.0", - "@microsoft/api-documenter": "^7.23.10", "@microsoft/api-extractor": "^7.38.1", "@rollup/plugin-replace": "^5.0.5", "@rollup/plugin-typescript": "^11.1.5", @@ -60,6 +59,7 @@ "rollup": "^4.2.0", "ts-jest": "^29.1.1", "ts-node": "^10.9.1", + "typedoc": "^0.25.4", "typescript": "^5.2.2" }, "engines": { @@ -2166,24 +2166,6 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, - "node_modules/@microsoft/api-documenter": { - "version": "7.23.10", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.10.tgz", - "integrity": "sha512-9jPlK5EeScxmkhaAyhQI+C84zJ34sjD/k/dEEsJGOrgrLfS8G/wlkVEJZdTz3oBxtWd9SqsxopvcQECUlnoicQ==", - "dev": true, - "dependencies": { - "@microsoft/api-extractor-model": "7.28.2", - "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.61.0", - "@rushstack/ts-command-line": "4.17.0", - "colors": "~1.2.1", - "js-yaml": "~3.13.1", - "resolve": "~1.22.1" - }, - "bin": { - "api-documenter": "bin/api-documenter" - } - }, "node_modules/@microsoft/api-extractor": { "version": "7.38.1", "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.1.tgz", @@ -3490,6 +3472,12 @@ "node": ">=8" } }, + "node_modules/ansi-sequence-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", + "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", + "dev": true + }, "node_modules/ansi-styles": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", @@ -7923,6 +7911,12 @@ "node": ">=6" } }, + "node_modules/jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -8337,6 +8331,12 @@ "yallist": "^3.0.2" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "node_modules/magic-string": { "version": "0.30.5", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.5.tgz", @@ -8424,6 +8424,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -10220,6 +10232,18 @@ "node": ">=8" } }, + "node_modules/shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "dependencies": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -10952,6 +10976,51 @@ "is-typedarray": "^1.0.0" } }, + "node_modules/typedoc": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.4.tgz", + "integrity": "sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.3", + "shiki": "^0.14.1" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 16" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/typescript": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", @@ -11082,6 +11151,18 @@ "node": ">= 0.8" } }, + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "node_modules/walker": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", @@ -12961,21 +13042,6 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, - "@microsoft/api-documenter": { - "version": "7.23.10", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.10.tgz", - "integrity": "sha512-9jPlK5EeScxmkhaAyhQI+C84zJ34sjD/k/dEEsJGOrgrLfS8G/wlkVEJZdTz3oBxtWd9SqsxopvcQECUlnoicQ==", - "dev": true, - "requires": { - "@microsoft/api-extractor-model": "7.28.2", - "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.61.0", - "@rushstack/ts-command-line": "4.17.0", - "colors": "~1.2.1", - "js-yaml": "~3.13.1", - "resolve": "~1.22.1" - } - }, "@microsoft/api-extractor": { "version": "7.38.1", "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.1.tgz", @@ -13962,6 +14028,12 @@ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" }, + "ansi-sequence-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", + "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", + "dev": true + }, "ansi-styles": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", @@ -17189,6 +17261,12 @@ "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, + "jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -17533,6 +17611,12 @@ "yallist": "^3.0.2" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "magic-string": { "version": "0.30.5", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.5.tgz", @@ -17598,6 +17682,12 @@ "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", "dev": true }, + "marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true + }, "media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -18895,6 +18985,18 @@ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", "dev": true }, + "shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "requires": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -19424,6 +19526,38 @@ "is-typedarray": "^1.0.0" } }, + "typedoc": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.4.tgz", + "integrity": "sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==", + "dev": true, + "requires": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.3", + "shiki": "^0.14.1" + }, + "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, "typescript": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", @@ -19512,6 +19646,18 @@ "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", "dev": true }, + "vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "walker": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", diff --git a/package.json b/package.json index 7aca36c8..5a8ea44b 100644 --- a/package.json +++ b/package.json @@ -11,9 +11,9 @@ "ut": "jest", "ut:watch": "jest --watch", "ut:coverage": "jest --coverage", - "build": "rimraf ./dist ./build && rollup --failAfterWarnings -c ./packages/rollup.config.js && tsc -p ./packages/tsconfig.dts.json", + "build": "rimraf ./dist ./build && rollup --failAfterWarnings -c ./packages/rollup.config.js && tsc -p ./packages/tsconfig.dts.json && api-extractor run --config ./packages/api-extractor.json --verbose", "build:coverage": "rimraf ./dist && rollup --failAfterWarnings -c ./packages/rollup.cov.config.js", - "apidoc": "rimraf ./build/apidoc && api-extractor run --config ./packages/api-extractor.json --verbose && api-documenter markdown -i build/apidoc/input -o build/apidoc/output", + "apidoc": "typedoc", "e2e": "npm run build && mocha packages/e2e/run.js", "e2e:coverage": "npm run build:coverage && nyc mocha packages/e2e/run.js" }, @@ -55,7 +55,6 @@ "@babel/plugin-syntax-typescript": "^7.22.5", "@commitlint/cli": "^18.2.0", "@commitlint/config-conventional": "^18.1.0", - "@microsoft/api-documenter": "^7.23.10", "@microsoft/api-extractor": "^7.38.1", "@rollup/plugin-replace": "^5.0.5", "@rollup/plugin-typescript": "^11.1.5", @@ -86,6 +85,7 @@ "rollup": "^4.2.0", "ts-jest": "^29.1.1", "ts-node": "^10.9.1", + "typedoc": "^0.25.4", "typescript": "^5.2.2" }, "dependencies": { diff --git a/packages/api-extractor.json b/packages/api-extractor.json index 532eaff1..c8d956b9 100644 --- a/packages/api-extractor.json +++ b/packages/api-extractor.json @@ -22,7 +22,6 @@ "publicTrimmedFilePath": "/../dist/index.d.ts" }, "docModel": { - "enabled": true, - "apiJsonFilePath": "/../build/apidoc/input/kassette.api.json" + "enabled": false } } diff --git a/packages/app/configuration/model.ts b/packages/app/configuration/model.ts index a027e601..11172ac6 100644 --- a/packages/app/configuration/model.ts +++ b/packages/app/configuration/model.ts @@ -1,6 +1,6 @@ // ------------------------------------------------------------------------- app -import { HookAPI } from '../mocking'; +import { HookAPI, IMock, MockData } from '../mocking'; import { IProxyConnectAPI } from '../server/proxy'; import { ConsoleSpec } from '../logger'; diff --git a/packages/app/mocking/checksum/model.ts b/packages/app/mocking/checksum/model.ts index bd367722..3b707033 100644 --- a/packages/app/mocking/checksum/model.ts +++ b/packages/app/mocking/checksum/model.ts @@ -1,4 +1,5 @@ import * as crypto from 'crypto'; +import type { IMock } from '../model'; //////////////////////////////////////////////////////////////////////////////// // diff --git a/packages/app/mocking/model.ts b/packages/app/mocking/model.ts index a818d45a..19b34462 100644 --- a/packages/app/mocking/model.ts +++ b/packages/app/mocking/model.ts @@ -5,7 +5,14 @@ import { RecursiveArray } from '../../lib/array'; // ------------------------------------------------------------------------- app -import { IMergedConfiguration, Mode, Delay, MocksFormat } from '../configuration'; +import { + IMergedConfiguration, + Mode, + Delay, + MocksFormat, + ConfigurationSpec, + CLIConfigurationSpec, +} from '../configuration'; import { Status, IFetchedRequest, IResponse, RequestPayload } from '../server/model'; diff --git a/packages/app/server/impl.ts b/packages/app/server/impl.ts index 3ad8ff65..0fed15da 100644 --- a/packages/app/server/impl.ts +++ b/packages/app/server/impl.ts @@ -15,7 +15,7 @@ import { readAll } from '../../lib/stream'; import { createGlobalLogger, logInfo, logSeparator, getConsole, logError } from '../logger'; -import { IMergedConfiguration } from '../configuration'; +import { IMergedConfiguration, ConfigurationSpec } from '../configuration'; import { Mock } from '../mocking'; diff --git a/packages/app/server/model.ts b/packages/app/server/model.ts index 918d2a57..48d576c5 100644 --- a/packages/app/server/model.ts +++ b/packages/app/server/model.ts @@ -1,6 +1,12 @@ // ------------------------------------------------------------------------- app -import { ConfigurationSpec, CLIConfigurationSpec, IMergedConfiguration } from '../configuration'; +import { + ConfigurationSpec, + CLIConfigurationSpec, + IMergedConfiguration, + IConfigurationFile, + GetConfigurationProps, +} from '../configuration'; //////////////////////////////////////////////////////////////////////////////// // diff --git a/packages/app/server/proxy/model.ts b/packages/app/server/proxy/model.ts index b6ea3bcc..42e89249 100644 --- a/packages/app/server/proxy/model.ts +++ b/packages/app/server/proxy/model.ts @@ -1,7 +1,7 @@ import { IncomingMessage } from 'http'; import { ServerHttp2Stream, Http2ServerRequest } from 'http2'; import { Socket } from 'net'; -import { ProxyConnectMode } from '../../configuration'; +import { ProxyConnectMode, ConfigurationSpec, CLIConfigurationSpec } from '../../configuration'; import { Connection } from '../request'; /** diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..e3c7d598 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,10 @@ +{ + "entryPoints": ["packages/index.ts"], + "excludeInternal": true, + "excludePrivate": true, + "out": "build/apidoc", + "readme": "README.md", + "treatValidationWarningsAsErrors": true, + "tsconfig": "packages/tsconfig.dts.json", + "visibilityFilters": {} +}