Skip to content

Commit ffe0ddd

Browse files
committed
Fixed typedoc setup for monorepo
1 parent 2d9267c commit ffe0ddd

13 files changed

+53
-20
lines changed

core/nut.js/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# nut.js (Native UI Toolkit)
1+
# @nut-tree/nut-js
22

33
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.

core/nut.js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"publish:next": "pnpm publish --tag next --no-git-checks",
5555
"publish:release": "pnpm publish --no-git-checks",
5656
"prepublishOnly": "pnpm run compile",
57-
"typedoc": "typedoc --options ./typedoc.js --entryPointStrategy expand ./lib"
57+
"typedoc": "typedoc --out docs"
5858
},
5959
"dependencies": {
6060
"@nut-tree/default-clipboard-provider": "workspace:*",

core/nut.js/typedoc.js

Lines changed: 0 additions & 14 deletions
This file was deleted.

core/nut.js/typedoc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": ["../../typedoc.base.json"],
3+
"entryPoints": ["index.ts"]
4+
}

core/provider-interfaces/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# @nut-tree/provider-interfaces
2+
3+
This package contains all defined provider interfaces which can be used for custom implementations.

core/provider-interfaces/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"compile": "pnpm run clean && tsc -p .",
1010
"publish:next": "pnpm publish --tag next --no-git-checks",
1111
"publish:release": "pnpm publish --no-git-checks",
12-
"prepublishOnly": "pnpm run compile"
12+
"prepublishOnly": "pnpm run compile",
13+
"typedoc": "typedoc --out docs"
1314
},
1415
"keywords": [
1516
"nut-js",

core/provider-interfaces/typedoc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": ["../../typedoc.base.json"],
3+
"entryPoints": ["index.ts"]
4+
}

core/shared/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# @nut-tree/shared
2+
3+
This package contains shared code to be used by the @nut-tree/nut-js and e.g. provider implementations.

core/shared/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"compile": "pnpm run clean && tsc -p .",
1313
"publish:next": "pnpm publish --tag next --no-git-checks",
1414
"publish:release": "pnpm publish --no-git-checks",
15-
"prepublishOnly": "pnpm run compile"
15+
"prepublishOnly": "pnpm run compile",
16+
"typedoc": "typedoc --out docs"
1617
},
1718
"dependencies": {
1819
"node-abort-controller": "3.1.1",

core/shared/typedoc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": ["../../typedoc.base.json"],
3+
"entryPoints": ["index.ts"]
4+
}

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
"coverage:clean": "pnpm -r run coverage:clean",
1010
"prepare": "husky install",
1111
"publish:next": "pnpm -r run publish:next",
12-
"publish:release": "pnpm -r run publish:release"
12+
"publish:release": "pnpm -r run publish:release",
13+
"typedoc-all": "pnpm -r run typedoc",
14+
"typedoc": "pnpm run typedoc-all && typedoc"
1315
},
1416
"packageManager": "pnpm@8.15.2",
1517
"workspaces": [
@@ -18,7 +20,6 @@
1820
"examples/*",
1921
"e2e/*"
2022
],
21-
"dependencies": {},
2223
"devDependencies": {
2324
"@types/jest": "29.5.12",
2425
"@types/node": "20.11.17",

typedoc.base.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"$schema": "https://typedoc.org/schema.json",
3+
"exclude": [
4+
"**/dist/**",
5+
"**/node_modules/**",
6+
"**/*.spec.ts",
7+
"**/__mocks__/**"
8+
],
9+
"excludePrivate": true,
10+
"excludeExternals": true,
11+
"excludeProtected": true,
12+
"hideGenerator": true,
13+
"entryPointStrategy": "expand",
14+
"includeVersion": true,
15+
"theme": "default"
16+
}

typedoc.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"$schema": "https://typedoc.org/schema.json",
3+
"entryPointStrategy": "packages",
4+
"entryPoints": [
5+
"core/nut.js",
6+
"core/provider-interfaces",
7+
"core/shared"
8+
],
9+
"includeVersion": false
10+
}

0 commit comments

Comments
 (0)