From d36f963b12ca264db2333d7a63a55dd5eac57c37 Mon Sep 17 00:00:00 2001 From: Jari Kolehmainen Date: Mon, 9 Jan 2023 09:31:51 +0200 Subject: [PATCH] fix typedoc generation Signed-off-by: Jari Kolehmainen --- .gitignore | 1 + docs/extensions/typedoc-readme.md.tpl | 10 +++++++--- .../src/common/user-store/preferences-helpers.ts | 2 +- packages/core/src/extensions/common-api/index.ts | 3 +++ .../update-button/update-button.tsx | 2 +- .../workload-overview-detail-injection-token.ts | 2 +- packages/core/tsconfig.json | 4 ++++ packages/extensions/package.json | 2 +- packages/extensions/tsconfig.json | 5 +++++ packages/extensions/typedoc.json | 12 ++++++++---- 10 files changed, 32 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 098d8fe3ac..b26f45b883 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ yarn-error.log coverage/ tmp/ site/ +docs/extensions/api/ \ No newline at end of file diff --git a/docs/extensions/typedoc-readme.md.tpl b/docs/extensions/typedoc-readme.md.tpl index 0f83a467a1..3b2e0f4176 100644 --- a/docs/extensions/typedoc-readme.md.tpl +++ b/docs/extensions/typedoc-readme.md.tpl @@ -1,7 +1,11 @@ # Extension API Reference +``` +npm install --save-dev @k8slens/extensions +``` + ## APIs -- [Common](modules/Common.md) -- [Main](modules/Main.md) -- [Renderer](modules/Renderer.md) +- [Common](modules/core_src_common_library.extensionApi.md) +- [Main](modules/core_src_main_library.extensionApi.md) +- [Renderer](modules/core_src_renderer_library.extensionApi.md) diff --git a/packages/core/src/common/user-store/preferences-helpers.ts b/packages/core/src/common/user-store/preferences-helpers.ts index 5bdc2a3852..ecb9108bee 100644 --- a/packages/core/src/common/user-store/preferences-helpers.ts +++ b/packages/core/src/common/user-store/preferences-helpers.ts @@ -23,7 +23,7 @@ export const defaultTerminalConfig: TerminalConfig = { fontFamily: defaultTerminalFontFamily, }; -interface BaseEditorConfiguration extends Required> { +export interface BaseEditorConfiguration extends Required> { lineNumbers: NonNullable>; } diff --git a/packages/core/src/extensions/common-api/index.ts b/packages/core/src/extensions/common-api/index.ts index 6e4b39b1b7..04a06a9be5 100644 --- a/packages/core/src/extensions/common-api/index.ts +++ b/packages/core/src/extensions/common-api/index.ts @@ -14,6 +14,9 @@ import * as Proxy from "./proxy"; import logger from "../../common/logger"; +/** + * @module Common + */ export { App, EventBus, diff --git a/packages/core/src/features/application-update/child-features/application-update-using-top-bar/renderer/update-application-top-bar-item/update-button/update-button.tsx b/packages/core/src/features/application-update/child-features/application-update-using-top-bar/renderer/update-application-top-bar-item/update-button/update-button.tsx index 317e64936b..970ca06fa4 100644 --- a/packages/core/src/features/application-update/child-features/application-update-using-top-bar/renderer/update-application-top-bar-item/update-button/update-button.tsx +++ b/packages/core/src/features/application-update/child-features/application-update-using-top-bar/renderer/update-application-top-bar-item/update-button/update-button.tsx @@ -17,7 +17,7 @@ import type { IComputedValue } from "mobx"; import restartAndInstallUpdateInjectable from "../../../../../renderer/restart-and-install-update.injectable"; import updateWarningLevelInjectable from "../update-warning-level.injectable"; -interface UpdateButtonProps extends HTMLAttributes {} +export interface UpdateButtonProps extends HTMLAttributes {} interface Dependencies { warningLevel: IComputedValue<"light" | "medium" | "high" | "">; diff --git a/packages/core/src/renderer/components/+workloads-overview/workload-overview-details/workload-overview-detail-injection-token.ts b/packages/core/src/renderer/components/+workloads-overview/workload-overview-details/workload-overview-detail-injection-token.ts index 746b815fd2..533322a0e2 100644 --- a/packages/core/src/renderer/components/+workloads-overview/workload-overview-details/workload-overview-detail-injection-token.ts +++ b/packages/core/src/renderer/components/+workloads-overview/workload-overview-details/workload-overview-detail-injection-token.ts @@ -6,7 +6,7 @@ import { getInjectionToken } from "@ogre-tools/injectable"; import type { IComputedValue } from "mobx"; import type React from "react"; -interface WorkloadOverviewDetail { +export interface WorkloadOverviewDetail { orderNumber: number; Component: React.ElementType<{}>; enabled: IComputedValue; diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json index b72aa9cb77..5273ac0ee1 100644 --- a/packages/core/tsconfig.json +++ b/packages/core/tsconfig.json @@ -1,6 +1,8 @@ { "extends": "../../tsconfig.json", "compilerOptions": { + "composite": true, + "outDir": "static/build/library/", "paths": { "*": [ "node_modules/*", @@ -17,6 +19,8 @@ ] }, "include": [ + "package.json", + "webpack/vars.ts", "src/**/*", "types/*.d.ts", ], diff --git a/packages/extensions/package.json b/packages/extensions/package.json index f42956586b..1fc3172d19 100644 --- a/packages/extensions/package.json +++ b/packages/extensions/package.json @@ -17,7 +17,7 @@ }, "scripts": { "build": "yarn run webpack --config webpack/extensions.ts", - "build-docs": "yarn run typedoc src/extension-api.ts", + "build-docs": "yarn run typedoc", "clean": "rm -rf dist/" }, "dependencies": { diff --git a/packages/extensions/tsconfig.json b/packages/extensions/tsconfig.json index 137d3d3d4b..12e7b819e1 100644 --- a/packages/extensions/tsconfig.json +++ b/packages/extensions/tsconfig.json @@ -23,5 +23,10 @@ "exclude": [ "node_modules", "../core/src/" + ], + "references": [ + { + "path": "../core" + } ] } diff --git a/packages/extensions/typedoc.json b/packages/extensions/typedoc.json index 7dc199be99..73dbad6ed3 100644 --- a/packages/extensions/typedoc.json +++ b/packages/extensions/typedoc.json @@ -1,11 +1,15 @@ { - "readme": "docs/extensions/typedoc-readme.md.tpl", + "readme": "../../docs/extensions/typedoc-readme.md.tpl", "name": "@k8slens/extensions", "out": "../../docs/extensions/api", "excludePrivate": true, - "includes": [ - "src/" + "entryPointStrategy": "expand", + "entryPoints": [ + "src/extension-api.ts", + "../core/src/common/library.ts", + "../core/src/main/library.ts", + "../core/src/renderer/library.ts" ], "hideBreadcrumbs": true, - "disableSources": true + "disableSources": true, }