docs: include internal types (#121)

Include internal types, not exposed.
For this purpose the typedoc plugin `typedoc-plugin-missing-exports` is
utilized,

It looks like there is trouble with the type export in general.
This commit is contained in:
Ulf Gebhardt 2025-02-18 15:04:24 +01:00 committed by GitHub
parent f9b079c2bf
commit 5e628d6e4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions

11
package-lock.json generated
View File

@ -76,6 +76,7 @@
"tailwindcss": "^3.3.1",
"typedoc": "^0.27.6",
"typedoc-plugin-coverage": "^3.4.1",
"typedoc-plugin-missing-exports": "^3.1.0",
"typescript": "^5.7.3",
"vite": "^6.0.11",
"vitest": "^3.0.5"
@ -11954,6 +11955,16 @@
"typedoc": "0.25.x || 0.26.x || 0.27.x"
}
},
"node_modules/typedoc-plugin-missing-exports": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-3.1.0.tgz",
"integrity": "sha512-Sogbaj+qDa21NjB3SlIw4JXSwmcl/WOjwiPNaVEcPhpNG/MiRTtpwV81cT7h1cbu9StpONFPbddYWR0KV/fTWA==",
"dev": true,
"license": "MIT",
"peerDependencies": {
"typedoc": "0.26.x || 0.27.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",

View File

@ -24,7 +24,7 @@
"test:component": "cypress run --component --browser electron",
"test:unit": "npm run test:unit:dev -- run --coverage",
"test:unit:dev": "vitest",
"docs:generate": "typedoc --includeVersion --navigation.includeCategories true --plugin typedoc-plugin-coverage src/index.tsx",
"docs:generate": "typedoc --includeVersion --navigation.includeCategories true --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-coverage src/index.tsx",
"update": "npx npm-check-updates"
},
"files": [
@ -78,6 +78,7 @@
"tailwindcss": "^3.3.1",
"typedoc": "^0.27.6",
"typedoc-plugin-coverage": "^3.4.1",
"typedoc-plugin-missing-exports": "^3.1.0",
"typescript": "^5.7.3",
"vite": "^6.0.11",
"vitest": "^3.0.5"