From ffe0ddd431089f3d46d901784c5b3b515d47269c Mon Sep 17 00:00:00 2001 From: Simon Hofmann Date: Sun, 25 Feb 2024 20:58:10 +0100 Subject: [PATCH] Fixed typedoc setup for monorepo --- core/nut.js/README.md | 2 +- core/nut.js/package.json | 2 +- core/nut.js/typedoc.js | 14 -------------- core/nut.js/typedoc.json | 4 ++++ core/provider-interfaces/README.md | 3 +++ core/provider-interfaces/package.json | 3 ++- core/provider-interfaces/typedoc.json | 4 ++++ core/shared/README.md | 3 +++ core/shared/package.json | 3 ++- core/shared/typedoc.json | 4 ++++ package.json | 5 +++-- typedoc.base.json | 16 ++++++++++++++++ typedoc.json | 10 ++++++++++ 13 files changed, 53 insertions(+), 20 deletions(-) delete mode 100644 core/nut.js/typedoc.js create mode 100644 core/nut.js/typedoc.json create mode 100644 core/provider-interfaces/README.md create mode 100644 core/provider-interfaces/typedoc.json create mode 100644 core/shared/README.md create mode 100644 core/shared/typedoc.json create mode 100644 typedoc.base.json create mode 100644 typedoc.json diff --git a/core/nut.js/README.md b/core/nut.js/README.md index b63a55e5..8515c0d8 100644 --- a/core/nut.js/README.md +++ b/core/nut.js/README.md @@ -1,3 +1,3 @@ -# nut.js (Native UI Toolkit) +# @nut-tree/nut-js This is the core package for nut.js, the one package that keeps all the other packages together. It provides the basic functionality to interact with the screen, the keyboard, and the mouse. \ No newline at end of file diff --git a/core/nut.js/package.json b/core/nut.js/package.json index 1f3b6902..83a628b3 100644 --- a/core/nut.js/package.json +++ b/core/nut.js/package.json @@ -54,7 +54,7 @@ "publish:next": "pnpm publish --tag next --no-git-checks", "publish:release": "pnpm publish --no-git-checks", "prepublishOnly": "pnpm run compile", - "typedoc": "typedoc --options ./typedoc.js --entryPointStrategy expand ./lib" + "typedoc": "typedoc --out docs" }, "dependencies": { "@nut-tree/default-clipboard-provider": "workspace:*", diff --git a/core/nut.js/typedoc.js b/core/nut.js/typedoc.js deleted file mode 100644 index e3e98cde..00000000 --- a/core/nut.js/typedoc.js +++ /dev/null @@ -1,14 +0,0 @@ -module.exports = { - exclude: [ - "**/dist/**", - "**/node_modules/**", - "**/*.spec.ts", - "**/__mocks__/**", - ], - readme: "README.md", - excludePrivate: true, - excludeExternals: true, - excludeProtected: true, - hideGenerator: true, - theme: "default", -}; diff --git a/core/nut.js/typedoc.json b/core/nut.js/typedoc.json new file mode 100644 index 00000000..b369a23b --- /dev/null +++ b/core/nut.js/typedoc.json @@ -0,0 +1,4 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["index.ts"] +} diff --git a/core/provider-interfaces/README.md b/core/provider-interfaces/README.md new file mode 100644 index 00000000..a4f8b0ba --- /dev/null +++ b/core/provider-interfaces/README.md @@ -0,0 +1,3 @@ +# @nut-tree/provider-interfaces + +This package contains all defined provider interfaces which can be used for custom implementations. diff --git a/core/provider-interfaces/package.json b/core/provider-interfaces/package.json index c2f3a0bd..99fad5c9 100644 --- a/core/provider-interfaces/package.json +++ b/core/provider-interfaces/package.json @@ -9,7 +9,8 @@ "compile": "pnpm run clean && tsc -p .", "publish:next": "pnpm publish --tag next --no-git-checks", "publish:release": "pnpm publish --no-git-checks", - "prepublishOnly": "pnpm run compile" + "prepublishOnly": "pnpm run compile", + "typedoc": "typedoc --out docs" }, "keywords": [ "nut-js", diff --git a/core/provider-interfaces/typedoc.json b/core/provider-interfaces/typedoc.json new file mode 100644 index 00000000..b369a23b --- /dev/null +++ b/core/provider-interfaces/typedoc.json @@ -0,0 +1,4 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["index.ts"] +} diff --git a/core/shared/README.md b/core/shared/README.md new file mode 100644 index 00000000..ee257bad --- /dev/null +++ b/core/shared/README.md @@ -0,0 +1,3 @@ +# @nut-tree/shared + +This package contains shared code to be used by the @nut-tree/nut-js and e.g. provider implementations. \ No newline at end of file diff --git a/core/shared/package.json b/core/shared/package.json index a7baae93..fb528cf7 100644 --- a/core/shared/package.json +++ b/core/shared/package.json @@ -12,7 +12,8 @@ "compile": "pnpm run clean && tsc -p .", "publish:next": "pnpm publish --tag next --no-git-checks", "publish:release": "pnpm publish --no-git-checks", - "prepublishOnly": "pnpm run compile" + "prepublishOnly": "pnpm run compile", + "typedoc": "typedoc --out docs" }, "dependencies": { "node-abort-controller": "3.1.1", diff --git a/core/shared/typedoc.json b/core/shared/typedoc.json new file mode 100644 index 00000000..91b350d9 --- /dev/null +++ b/core/shared/typedoc.json @@ -0,0 +1,4 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["index.ts"] +} \ No newline at end of file diff --git a/package.json b/package.json index 37ce4845..85bdf261 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,9 @@ "coverage:clean": "pnpm -r run coverage:clean", "prepare": "husky install", "publish:next": "pnpm -r run publish:next", - "publish:release": "pnpm -r run publish:release" + "publish:release": "pnpm -r run publish:release", + "typedoc-all": "pnpm -r run typedoc", + "typedoc": "pnpm run typedoc-all && typedoc" }, "packageManager": "pnpm@8.15.2", "workspaces": [ @@ -18,7 +20,6 @@ "examples/*", "e2e/*" ], - "dependencies": {}, "devDependencies": { "@types/jest": "29.5.12", "@types/node": "20.11.17", diff --git a/typedoc.base.json b/typedoc.base.json new file mode 100644 index 00000000..5e90edef --- /dev/null +++ b/typedoc.base.json @@ -0,0 +1,16 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "exclude": [ + "**/dist/**", + "**/node_modules/**", + "**/*.spec.ts", + "**/__mocks__/**" + ], + "excludePrivate": true, + "excludeExternals": true, + "excludeProtected": true, + "hideGenerator": true, + "entryPointStrategy": "expand", + "includeVersion": true, + "theme": "default" +} \ No newline at end of file diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..01639f29 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,10 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPointStrategy": "packages", + "entryPoints": [ + "core/nut.js", + "core/provider-interfaces", + "core/shared" + ], + "includeVersion": false +} \ No newline at end of file