Skip to content

Commit f5bd810

Browse files
committed
fix: Fix auto-doc
1 parent 0a201ca commit f5bd810

File tree

10 files changed

+237
-83
lines changed

10 files changed

+237
-83
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ Thumbs.db
3434
# Ignore built ts files
3535
dist/
3636
linker/
37-
build/
37+
build/
38+
docs/

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55
"scripts": {
66
"prepare": "husky",
77
"test": "lerna run test",
8-
"build": "lerna run build"
8+
"build": "lerna run build",
9+
"docs": "typedoc"
910
},
1011
"devDependencies": {
1112
"@commitlint/config-conventional": "^19.8.1",
1213
"commitlint": "^19.8.1",
1314
"husky": "^9.1.7",
14-
"lerna": "^8.2.2"
15+
"lerna": "^8.2.2",
16+
"typedoc": "^0.28.5",
17+
"typedoc-plugin-markdown": "^4.6.4"
1518
},
1619
"pnpm": {
1720
"peerDependencyRules": {

pnpm-lock.yaml

Lines changed: 137 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tsconfig.base.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"compilerOptions": {
3+
"outDir": "build",
4+
"module": "ESNext",
5+
"target": "ES2021",
6+
"jsx": "react",
7+
"jsxFactory": "window.SP_REACT.createElement",
8+
"jsxFragmentFactory": "window.SP_REACT.Fragment",
9+
"declaration": true,
10+
"moduleResolution": "node",
11+
"noUnusedLocals": true,
12+
"noUnusedParameters": true,
13+
"esModuleInterop": true,
14+
"noImplicitReturns": true,
15+
"noImplicitThis": true,
16+
"noImplicitAny": true,
17+
"strict": true,
18+
"ignoreDeprecations": "5.0",
19+
"allowSyntheticDefaultImports": true,
20+
"skipLibCheck": true
21+
},
22+
"files": [],
23+
"references": [{ "path": "./typescript-packages/client" }, { "path": "./typescript-packages/browser" }]
24+
}

typedoc.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"entryPoints": ["typescript-packages/client/src/index.ts", "typescript-packages/browser/src/index.ts"], // change to your main entry point
3+
"out": "docs",
4+
"plugin": ["typedoc-plugin-markdown"],
5+
"readme": "README.md", // or "none"
6+
"includeVersion": true,
7+
"tsconfig": "tsconfig.base.json" // path to your tsconfig file
8+
}

typescript-packages/browser/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ type IPC_types = string | number | boolean | void;
1111
*/
1212
type Millennium = {
1313
/**
14-
* @brief Call a method on the backend
14+
* Call a method on the backend
1515
* @deprecated Use `callable` instead.
1616
* Example usage:
1717
* ```typescript

0 commit comments

Comments
 (0)