@nikovirtala/projen-typedoc 1.0.20 → 1.0.22

package/.jsii

@@ -1400,6 +1400,6 @@
       "symbolId": "src/typedoc-config:Visibility"
     }
   },
-  "version": "1.0.20",
-  "fingerprint": "nOJ8cmpOH+WR7/TG/B7NwI8CAkIGuD/qt47Bxfjxrz4="
+  "version": "1.0.22",
+  "fingerprint": "awjLvDYDVL07fD1nGpvh5Jt8RWzOLvBHJuG4ft5deSA="
 }

package/.kiro/steering/product.md

@@ -0,0 +1,19 @@
+# Product Overview
+
+This is a TypeDoc component for projen projects. It provides a reusable component that automatically configures TypeDoc documentation generation for Node.js projects managed by projen.
+
+## Purpose
+
+Simplifies adding TypeDoc documentation to projen projects by:
+- Installing TypeDoc as a dev dependency
+- Creating and managing `typedoc.jsonc` configuration
+- Adding a `typedoc` task to generate documentation
+- Providing sensible defaults while allowing full customization
+
+## Key Features
+
+- Automatic TypeDoc setup with zero configuration
+- Supports all TypeDoc configuration options
+- Default configuration excludes test files and private members
+- Generates documentation to `docs/api` by default
+- Integrates with projen's task system

package/.kiro/steering/structure.md

@@ -0,0 +1,51 @@
+# Project Structure
+
+## Source Code
+
+- `src/index.ts` - Main entry point, exports TypeDoc component class
+- `src/typedoc-config.ts` - TypeDoc configuration interfaces, enums, and type definitions
+
+## Tests
+
+- `test/typedoc.test.ts` - Component tests using Vitest
+- `test/__snapshots__/` - Vitest snapshot files
+
+## Configuration Files
+
+- `.projenrc.ts` - Projen project definition (source of truth for configuration)
+- `package.json` - Generated by projen, do not edit manually
+- `biome.jsonc` - Biome linter/formatter configuration (generated)
+- `vitest.config.ts` - Vitest test configuration (generated)
+- `typedoc.jsonc` - TypeDoc configuration for this project's own docs
+- `tsconfig.dev.json` - TypeScript configuration
+- `mise.toml` - Node.js version specification
+
+## Documentation
+
+- `README.md` - User-facing documentation
+- `API.md` - Generated API documentation (jsii-docgen)
+- `docs/api/` - Generated TypeDoc HTML documentation
+
+## Architecture Patterns
+
+### Component Design
+
+The TypeDoc class extends projen's `Component` base class and follows these patterns:
+
+1. **Static Factory**: `TypeDoc.of(project)` to retrieve existing instance
+2. **Configuration Merging**: User config merged with sensible defaults
+3. **Task Integration**: Automatically spawns from test task
+4. **File Generation**: Creates `typedoc.jsonc` as a JsonFile component
+
+### Configuration Strategy
+
+- Default configuration in `DEFAULT_CONFIG` constant
+- User configuration merged via `deepMerge` with array merging enabled
+- Type-safe configuration via TypeScript interfaces
+- JSON serialization removes undefined values
+
+### Testing Approach
+
+- Snapshot testing for generated configuration files
+- Unit tests for configuration merging behavior
+- Uses `synthSnapshot` helper from projen for testing generated files

package/.kiro/steering/tech.md

@@ -0,0 +1,54 @@
+# Technology Stack
+
+## ⚠️ Projen-Managed Project
+
+This project is **entirely managed by projen**. Key implications:
+
+- **DO NOT** manually edit generated files (package.json, tsconfig.json, etc.)
+- **ALL** configuration changes must be made in `.projenrc.ts`
+- After modifying `.projenrc.ts`, run `npx projen` to regenerate files
+- Dependencies, scripts, and tooling are defined in `.projenrc.ts`, not package.json
+
+## Build System
+
+- **projen**: Project configuration and build orchestration
+- **JSII**: Enables multi-language support for the component
+- **pnpm**: Package manager (v10, hoisted node-linker)
+- **TypeScript**: v5.9.3
+
+## Core Dependencies
+
+- `projen`: ^0.98.28 (peer dependency and runtime dependency)
+- `constructs`: ^10.4.3 (peer dependency)
+
+## Development Tools
+
+- **Biome**: Linting and formatting (replaces ESLint/Prettier)
+  - 4 space indentation
+  - 120 character line width
+  - Double quotes for JavaScript/TypeScript
+- **Vitest**: Testing framework (v4) with coverage via v8
+- **TypeDoc**: v0.28 for API documentation generation
+- **mise**: Node.js version management (22.21.1)
+
+## Common Commands
+
+### Development
+- `pnpm projen` - Synthesize project configuration
+- `pnpm build` - Compile TypeScript and run tests
+- `pnpm compile` - Compile TypeScript only
+- `pnpm test` - Run tests with Vitest
+- `pnpm test:watch` - Run tests in watch mode
+- `pnpm test:update` - Update test snapshots
+
+### Code Quality
+- `pnpm biome` - Run Biome linter and formatter
+- `pnpm typedoc` - Generate API documentation
+
+### Release
+- `pnpm release` - Create a new release
+- `pnpm package` - Build distribution packages
+
+## Node.js Version
+
+Minimum: 22.21.1 (managed via mise.toml)

package/lib/index.js

@@ -66,6 +66,6 @@ class TypeDoc extends component_1.Component {
 }
 exports.TypeDoc = TypeDoc;
 _a = JSII_RTTI_SYMBOL_1;
-TypeDoc[_a] = { fqn: "@nikovirtala/projen-typedoc.TypeDoc", version: "1.0.20" };
+TypeDoc[_a] = { fqn: "@nikovirtala/projen-typedoc.TypeDoc", version: "1.0.22" };
 __exportStar(require("./typedoc-config"), exports);
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUFpRDtBQUVqRCwwQ0FBMkM7QUFHM0MsMENBQTRDO0FBQzVDLHFEQUE4RztBQUU5Rzs7R0FFRztBQUNILE1BQU0sY0FBYyxHQUF5QjtJQUN6QyxrQkFBa0IsRUFBRSxtQ0FBa0IsQ0FBQyxNQUFNO0lBQzdDLEdBQUcsRUFBRSxVQUFVO0lBQ2YsT0FBTyxFQUFFLENBQUMsY0FBYyxDQUFDO0lBQ3pCLGNBQWMsRUFBRSxJQUFJO0lBQ3BCLGNBQWMsRUFBRSxJQUFJO0NBQ3ZCLENBQUM7QUFrQkY7O0dBRUc7QUFDSCxNQUFhLE9BQVEsU0FBUSxxQkFBUztJQUMzQixNQUFNLENBQUMsRUFBRSxDQUFDLE9BQWdCO1FBQzdCLE1BQU0sU0FBUyxHQUFHLENBQUMsQ0FBWSxFQUFnQixFQUFFLENBQUMsQ0FBQyxZQUFZLE9BQU8sQ0FBQztRQUN2RSxPQUFPLE9BQU8sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFjRCxZQUFZLE9BQW9CLEVBQUUsVUFBMEIsRUFBRTtRQUMxRCxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFZixNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUM7UUFDMUIsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxJQUFJLE9BQU8sRUFBRSxDQUFDLENBQUM7UUFFL0Q7O1dBRUc7UUFDSCxJQUFJLENBQUMsb0JBQW9CLEdBQUcsSUFBQSxnQkFBUyxFQUNqQyxDQUFDLElBQUEsNENBQTJCLEVBQUMsY0FBYyxDQUFDLEVBQUUsSUFBQSw0Q0FBMkIsRUFBQyxPQUFPLENBQUMsYUFBYSxJQUFJLEVBQUUsQ0FBQyxDQUFDLEVBQ3ZHLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxDQUN4QixDQUFDO1FBRUYsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLGVBQVEsQ0FBQyxJQUFJLEVBQUUsZUFBZSxFQUFFO1lBQzVDLEdBQUcsRUFBRSxJQUFJLENBQUMsb0JBQW9CO1lBQzlCLGFBQWEsRUFBRSxJQUFJO1lBQ25CLE1BQU0sRUFBRSxJQUFJO1lBQ1osUUFBUSxFQUFFLEtBQUs7U0FDbEIsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRTtZQUNuQyxXQUFXLEVBQUUsZ0NBQWdDO1lBQzdDLEtBQUssRUFBRTtnQkFDSDtvQkFDSSxJQUFJLEVBQUUsU0FBUztpQkFDbEI7YUFDSjtTQUNKLENBQUMsQ0FBQztRQUNILE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN0QyxDQUFDOztBQWhETCwwQkFpREM7OztBQUVELG1EQUFpQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbXBvbmVudCB9IGZyb20gXCJwcm9qZW4vbGliL2NvbXBvbmVudFwiO1xuaW1wb3J0IHR5cGUgeyBOb2RlUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL2phdmFzY3JpcHQvbm9kZS1wcm9qZWN0XCI7XG5pbXBvcnQgeyBKc29uRmlsZSB9IGZyb20gXCJwcm9qZW4vbGliL2pzb25cIjtcbmltcG9ydCB0eXBlIHsgUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL3Byb2plY3RcIjtcbmltcG9ydCB0eXBlIHsgVGFzayB9IGZyb20gXCJwcm9qZW4vbGliL3Rhc2tcIjtcbmltcG9ydCB7IGRlZXBNZXJnZSB9IGZyb20gXCJwcm9qZW4vbGliL3V0aWxcIjtcbmltcG9ydCB7IEVudHJ5UG9pbnRTdHJhdGVneSwgdHlwZSBUeXBlRG9jQ29uZmlndXJhdGlvbiwgdG9Kc29uX1R5cGVEb2NDb25maWd1cmF0aW9uIH0gZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcblxuLyoqXG4gKiBEZWZhdWx0IFR5cGVEb2MgY29uZmlndXJhdGlvblxuICovXG5jb25zdCBERUZBVUxUX0NPTkZJRzogVHlwZURvY0NvbmZpZ3VyYXRpb24gPSB7XG4gICAgZW50cnlQb2ludFN0cmF0ZWd5OiBFbnRyeVBvaW50U3RyYXRlZ3kuRVhQQU5ELFxuICAgIG91dDogXCJkb2NzL2FwaVwiLFxuICAgIGV4Y2x1ZGU6IFtcIioqLyoudGVzdC50c1wiXSxcbiAgICBleGNsdWRlUHJpdmF0ZTogdHJ1ZSxcbiAgICBkaXNhYmxlU291cmNlczogdHJ1ZSxcbn07XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY09wdGlvbnMge1xuICAgIC8qKlxuICAgICAqIFZlcnNpb24gb2YgVHlwZURvYyB0byB1c2VcbiAgICAgKlxuICAgICAqIEBkZWZhdWx0IFwiXjAuMjhcIlxuICAgICAqL1xuICAgIHJlYWRvbmx5IHZlcnNpb24/OiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBGdWxsIFR5cGVEb2MgY29uZmlndXJhdGlvblxuICAgICAqXG4gICAgICogVGhpcyBjb25maWd1cmF0aW9uIHdpbGwgYmUgbWVyZ2VkIHdpdGggdGhlIGRlZmF1bHQgY29uZmlndXJhdGlvblxuICAgICAqL1xuICAgIHJlYWRvbmx5IHR5cGVEb2NDb25maWc/OiBUeXBlRG9jQ29uZmlndXJhdGlvbjtcbn1cblxuLyoqXG4gKiBUeXBlRG9jIGNvbXBvbmVudCBmb3IgcHJvamVuIHByb2plY3RzXG4gKi9cbmV4cG9ydCBjbGFzcyBUeXBlRG9jIGV4dGVuZHMgQ29tcG9uZW50IHtcbiAgICBwdWJsaWMgc3RhdGljIG9mKHByb2plY3Q6IFByb2plY3QpOiBUeXBlRG9jIHwgdW5kZWZpbmVkIHtcbiAgICAgICAgY29uc3QgaXNUeXBlRG9jID0gKGM6IENvbXBvbmVudCk6IGMgaXMgVHlwZURvYyA9PiBjIGluc3RhbmNlb2YgVHlwZURvYztcbiAgICAgICAgcmV0dXJuIHByb2plY3QuY29tcG9uZW50cy5maW5kKGlzVHlwZURvYyk7XG4gICAgfVxuXG4gICAgcHJpdmF0ZSByZWFkb25seSB0eXBlRG9jQ29uZmlndXJhdGlvbjogUmVjb3JkPHN0cmluZywgdW5rbm93bj47XG5cbiAgICAvKipcbiAgICAgKiBUeXBlRG9jIHRhc2tcbiAgICAgKi9cbiAgICBwdWJsaWMgcmVhZG9ubHkgdGFzazogVGFzaztcblxuICAgIC8qKlxuICAgICAqIFR5cGVEb2MgY29uZmlndXJhdGlvbiBmaWxlXG4gICAgICovXG4gICAgcHVibGljIHJlYWRvbmx5IGZpbGU6IEpzb25GaWxlO1xuXG4gICAgY29uc3RydWN0b3IocHJvamVjdDogTm9kZVByb2plY3QsIG9wdGlvbnM6IFR5cGVEb2NPcHRpb25zID0ge30pIHtcbiAgICAgICAgc3VwZXIocHJvamVjdCk7XG5cbiAgICAgICAgY29uc3QgdHlwZWRvYyA9IFwidHlwZWRvY1wiO1xuICAgICAgICBwcm9qZWN0LmFkZERldkRlcHMoYCR7dHlwZWRvY31AJHtvcHRpb25zLnZlcnNpb24gPz8gXCJeMC4yOFwifWApO1xuXG4gICAgICAgIC8qXG4gICAgICAgICAqIE1lcmdlIGRlZmF1bHQgY29uZmlndXJhdGlvbiB3aXRoIHVzZXItcHJvdmlkZWQgY29uZmlndXJhdGlvblxuICAgICAgICAgKi9cbiAgICAgICAgdGhpcy50eXBlRG9jQ29uZmlndXJhdGlvbiA9IGRlZXBNZXJnZShcbiAgICAgICAgICAgIFt0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24oREVGQVVMVF9DT05GSUcpLCB0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24ob3B0aW9ucy50eXBlRG9jQ29uZmlnID8/IHt9KV0sXG4gICAgICAgICAgICB7IG1lcmdlQXJyYXlzOiB0cnVlIH0sXG4gICAgICAgICk7XG5cbiAgICAgICAgdGhpcy5maWxlID0gbmV3IEpzb25GaWxlKHRoaXMsIFwidHlwZWRvYy5qc29uY1wiLCB7XG4gICAgICAgICAgICBvYmo6IHRoaXMudHlwZURvY0NvbmZpZ3VyYXRpb24sXG4gICAgICAgICAgICBhbGxvd0NvbW1lbnRzOiB0cnVlLFxuICAgICAgICAgICAgbWFya2VyOiB0cnVlLFxuICAgICAgICAgICAgcmVhZG9ubHk6IGZhbHNlLFxuICAgICAgICB9KTtcblxuICAgICAgICB0aGlzLnRhc2sgPSBwcm9qZWN0LmFkZFRhc2soXCJ0eXBlZG9jXCIsIHtcbiAgICAgICAgICAgIGRlc2NyaXB0aW9uOiBcIkdlbmVyYXRlIFR5cGVEb2MgZG9jdW1lbnRhdGlvblwiLFxuICAgICAgICAgICAgc3RlcHM6IFtcbiAgICAgICAgICAgICAgICB7XG4gICAgICAgICAgICAgICAgICAgIGV4ZWM6IFwidHlwZWRvY1wiLFxuICAgICAgICAgICAgICAgIH0sXG4gICAgICAgICAgICBdLFxuICAgICAgICB9KTtcbiAgICAgICAgcHJvamVjdC50ZXN0VGFzay5zcGF3bih0aGlzLnRhc2spO1xuICAgIH1cbn1cblxuZXhwb3J0ICogZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcbiJdfQ==

package/package.json

@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^2",
-    "@nikovirtala/projen-vitest": "^2.1.20",
+    "@nikovirtala/projen-vitest": "^2.1.22",
     "@types/node": "^22",
     "@vitest/coverage-v8": "^4",
     "commit-and-tag-version": "^12",
@@ -43,7 +43,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.20",
+  "version": "1.0.22",
   "types": "lib/index.d.ts",
   "stability": "stable",
   "jsii": {