Chris Farhood
ebbdb42c05
Set up TypeDoc to auto-generate comprehensive API reference documentation from TypeScript source code. Changes: - Installed typedoc and typedoc-plugin-markdown (v0.2.0 plugins) - Created typedoc.json configuration with 9 entry points - Added docs:api and docs:watch npm scripts - Fixed test file imports (validateNamespace → isValidNamespace) - Updated tsconfig.json to exclude test files from compilation - Generated markdown API documentation in docs/api-reference/generated/ Generated API documentation: - 9 modules documented (lib/, hooks/, types/) - lib/crypto - 14 encryption/certificate functions - lib/controller - 5 Kubernetes API functions - lib/validators - 6 validation functions - lib/retry - Exponential backoff utilities - lib/rbac - RBAC permission checking - types - Result types, branded types, interfaces - hooks/useSealedSecretEncryption - Encryption React hook - hooks/usePermissions - RBAC React hooks - hooks/useControllerHealth - Health monitoring hook Benefits: - Auto-generated from TypeScript source (stays in sync) - Markdown format for easy integration - Type signatures and JSDoc included - Function parameters and return types documented - Links between related types and functions Phase 2 deliverables (2-3 days estimated, completed in 1 session): ✅ TypeDoc installed and configured ✅ Entry points identified for all core modules ✅ API documentation generated (9 modules, 40+ functions) ✅ npm scripts added for docs generation ✅ Test files excluded from documentation Next: Phase 3 - User tutorials and guides Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
70 lines
1.8 KiB
JSON
70 lines
1.8 KiB
JSON
{
|
|
"name": "headlamp-sealed-secrets",
|
|
"version": "0.2.0",
|
|
"description": "Headlamp plugin for Bitnami Sealed Secrets - manage encrypted Kubernetes secrets",
|
|
"main": "dist/main.js",
|
|
"files": [
|
|
"dist",
|
|
"README.md",
|
|
"LICENSE"
|
|
],
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/cpfarhood/headlamp-sealed-secrets-plugin.git",
|
|
"directory": "headlamp-sealed-secrets"
|
|
},
|
|
"bugs": {
|
|
"url": "https://github.com/cpfarhood/headlamp-sealed-secrets-plugin/issues"
|
|
},
|
|
"homepage": "https://github.com/cpfarhood/headlamp-sealed-secrets-plugin#readme",
|
|
"author": "cpfarhood",
|
|
"license": "Apache-2.0",
|
|
"scripts": {
|
|
"start": "headlamp-plugin start",
|
|
"build": "headlamp-plugin build",
|
|
"format": "headlamp-plugin format",
|
|
"lint": "headlamp-plugin lint",
|
|
"lint-fix": "headlamp-plugin lint --fix",
|
|
"package": "headlamp-plugin package",
|
|
"tsc": "headlamp-plugin tsc",
|
|
"storybook": "headlamp-plugin storybook",
|
|
"storybook-build": "headlamp-plugin storybook-build",
|
|
"test": "headlamp-plugin test",
|
|
"i18n": "headlamp-plugin i18n",
|
|
"docs:api": "typedoc",
|
|
"docs:watch": "typedoc --watch"
|
|
},
|
|
"keywords": [
|
|
"headlamp",
|
|
"headlamp-plugin",
|
|
"kubernetes",
|
|
"kubernetes-ui",
|
|
"sealed-secrets",
|
|
"bitnami",
|
|
"encryption",
|
|
"secrets",
|
|
"security",
|
|
"k8s"
|
|
],
|
|
"prettier": "@headlamp-k8s/eslint-config/prettier-config",
|
|
"eslintConfig": {
|
|
"extends": [
|
|
"@headlamp-k8s",
|
|
"prettier",
|
|
"plugin:jsx-a11y/recommended"
|
|
]
|
|
},
|
|
"overrides": {
|
|
"typescript": "5.6.2"
|
|
},
|
|
"dependencies": {
|
|
"node-forge": "^1.3.1"
|
|
},
|
|
"devDependencies": {
|
|
"@kinvolk/headlamp-plugin": "^0.13.1",
|
|
"@types/node-forge": "^1.3.11",
|
|
"typedoc": "^0.28.16",
|
|
"typedoc-plugin-markdown": "^4.10.0"
|
|
}
|
|
}
|