@nikovirtala/projen-constructs 0.1.8 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/.jsii +2021 -157
  2. package/API.md +769 -52
  3. package/README.md +37 -8
  4. package/docs/api/.nojekyll +1 -0
  5. package/docs/api/assets/hierarchy.js +1 -0
  6. package/docs/api/assets/highlight.css +99 -0
  7. package/docs/api/assets/icons.js +18 -0
  8. package/docs/api/assets/icons.svg +1 -0
  9. package/docs/api/assets/main.js +60 -0
  10. package/docs/api/assets/navigation.js +1 -0
  11. package/docs/api/assets/search.js +1 -0
  12. package/docs/api/assets/style.css +1633 -0
  13. package/docs/api/classes/AwsCdkConstructLibraryProject.html +308 -0
  14. package/docs/api/classes/AwsCdkTypeScriptAppProject.html +306 -0
  15. package/docs/api/classes/JsiiProject.html +294 -0
  16. package/docs/api/classes/ProjectGenerator.html +38 -0
  17. package/docs/api/classes/TypeDoc.html +37 -0
  18. package/docs/api/classes/TypeScriptProject.html +294 -0
  19. package/docs/api/classes/Vitest.html +38 -0
  20. package/docs/api/enums/CommentStyle.html +11 -0
  21. package/docs/api/enums/CoverageProvider.html +7 -0
  22. package/docs/api/enums/CoverageReporter.html +11 -0
  23. package/docs/api/enums/EntryPointStrategy.html +11 -0
  24. package/docs/api/enums/Environment.html +12 -0
  25. package/docs/api/enums/LogLevel.html +13 -0
  26. package/docs/api/enums/Pool.html +17 -0
  27. package/docs/api/enums/ProjectType.html +47 -0
  28. package/docs/api/enums/Visibility.html +9 -0
  29. package/docs/api/functions/applyDefaults.html +1 -0
  30. package/docs/api/functions/toJson_TypeDocConfiguration.html +2 -0
  31. package/docs/api/hierarchy.html +1 -0
  32. package/docs/api/index.html +86 -0
  33. package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +1075 -0
  34. package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +1026 -0
  35. package/docs/api/interfaces/Component.html +13 -0
  36. package/docs/api/interfaces/ComponentOptions.html +8 -0
  37. package/docs/api/interfaces/JsiiProjectOptions.html +1003 -0
  38. package/docs/api/interfaces/ProjectGeneratorOptions.html +49 -0
  39. package/docs/api/interfaces/TypeDocConfiguration.html +141 -0
  40. package/docs/api/interfaces/TypeDocOptions.html +9 -0
  41. package/docs/api/interfaces/TypeScriptProjectOptions.html +899 -0
  42. package/docs/api/interfaces/ValidationOptions.html +9 -0
  43. package/docs/api/interfaces/VitestConfigOptions.html +111 -0
  44. package/docs/api/interfaces/VitestOptions.html +13 -0
  45. package/docs/api/modules.html +1 -0
  46. package/docs/api/variables/defaultOptions.html +1 -0
  47. package/docs/api/variables/defaults.html +1 -0
  48. package/docs/api/variables/projectDefaultOptions.html +1 -0
  49. package/lib/components/typedoc-config.d.ts +321 -0
  50. package/lib/components/typedoc-config.js +73 -1
  51. package/lib/components/typedoc.d.ts +19 -0
  52. package/lib/components/typedoc.js +14 -1
  53. package/lib/components/vitest.d.ts +197 -0
  54. package/lib/components/vitest.js +72 -2
  55. package/lib/config.d.ts +4 -4
  56. package/lib/errors.d.ts +16 -0
  57. package/lib/errors.js +26 -2
  58. package/lib/index.d.ts +2 -0
  59. package/lib/index.js +3 -1
  60. package/lib/project-generator.d.ts +87 -63
  61. package/lib/project-generator.js +344 -60
  62. package/lib/project-type.d.ts +78 -16
  63. package/lib/project-type.js +79 -17
  64. package/lib/projects/awscdk-construct-library.generated.js +4 -4
  65. package/lib/projects/awscdk-typescript-app.generated.js +4 -4
  66. package/lib/projects/jsii-options.generated.d.ts +11 -1
  67. package/lib/projects/jsii-options.generated.js +1 -1
  68. package/lib/projects/jsii.generated.js +5 -4
  69. package/lib/projects/typescript.generated.js +4 -4
  70. package/lib/utils.d.ts +2 -2
  71. package/lib/utils.js +3 -3
  72. package/package.json +3 -1
  73. package/scripts/generate-project-types.ts +103 -0
  74. package/typedoc.jsonc +10 -0
package/.jsii CHANGED
@@ -4190,7 +4190,7 @@
4190
4190
  },
4191
4191
  "name": "@nikovirtala/projen-constructs",
4192
4192
  "readme": {
4193
- "markdown": "# @nikovirtala/projen-constructs\n\nProjen project types with standard configuration for consistent project setup across all repositories.\n\n## Installation\n\n```bash\npnpm add -D @nikovirtala/projen-constructs projen constructs\n```\n\n## Standard Configuration\n\nAll project types include:\n\n- **Author**: Niko Virtala (niko.virtala@hey.com)\n- **Default Release Branch**: main\n- **Package Manager**: pnpm 10\n- **Node Version**: 22.21.1\n- **TypeScript**: 5.9.3\n- **Module Type**: ES modules (TypeScript and CDK App projects only; JSII projects use CommonJS)\n- **Code Quality**: Biome for formatting and linting\n- **Testing**: Vitest\n- **Auto-merge**: Enabled with auto-approve\n- **VSCode**: Recommended extensions and settings\n- **mise**: Node version management (via Homebrew)\n- **CDK Version**: 2.223.0 (for CDK projects)\n- **JSII Version**: ~5.9.3 (for JSII projects)\n\n## Customization\n\nOverride any option by passing it to the constructor:\n\n```typescript\nconst project = new JsiiProject({\n name: \"my-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-project.git\",\n minNodeVersion: \"20.0.0\",\n author: \"Custom Author\",\n authorAddress: \"custom@example.com\",\n mise: false,\n vitest: false,\n tsconfig: {\n compilerOptions: {\n noUnusedLocals: false,\n },\n },\n biomeOptions: {\n biomeConfig: {\n formatter: {\n lineWidth: 100,\n },\n },\n },\n});\n```\n\n## Usage\n\n### Projects\n\n#### AWS CDK Construct Library Project\n\n```typescript\nimport { AwsCdkConstructLibraryProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new AwsCdkConstructLibraryProject({\n name: \"my-cdk-construct\",\n repositoryUrl: \"https://github.com/nikovirtala/my-cdk-construct.git\",\n});\n\nproject.synth();\n```\n\n#### AWS CDK TypeScript App Project\n\n```typescript\nimport { AwsCdkTypeScriptAppProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new AwsCdkTypeScriptAppProject({\n name: \"my-cdk-app\",\n repositoryUrl: \"https://github.com/nikovirtala/my-cdk-app.git\",\n});\n\nproject.synth();\n```\n\n#### JSII Project\n\n```typescript\nimport { JsiiProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new JsiiProject({\n name: \"my-jsii-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-jsii-project.git\",\n});\n\nproject.synth();\n```\n\n#### TypeScript Project\n\n```typescript\nimport { TypeScriptProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new TypeScriptProject({\n name: \"my-typescript-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-typescript-project.git\",\n});\n\nproject.synth();\n```\n\n### Components\n\nThe package includes reusable components for common development tasks:\n\n#### Vitest\n\n[Vitest](https://vitest.dev) testing framework component.\n\n```typescript\nimport { Vitest } from \"@nikovirtala/projen-constructs\";\n\nnew Vitest(project, {\n vitestVersion: \"^4\",\n config: {\n coverageProvider: CoverageProvider.V8,\n coverageReporters: [CoverageReporter.TEXT, CoverageReporter.LCOV],\n },\n});\n```\n\n#### TypeDoc\n\n[TypeDoc](https://typedoc.org) documentation generation component.\n\n```typescript\nimport { TypeDoc, EntryPointStrategy } from \"@nikovirtala/projen-constructs\";\n\nnew TypeDoc(project, {\n version: \"^0.28\",\n typeDocConfig: {\n entryPointStrategy: EntryPointStrategy.EXPAND,\n out: \"docs/api\",\n exclude: [\"**/*.test.ts\"],\n },\n});\n```\n\n#### Mise\n\n[Mise](https://mise.jdx.dev) dev tools/runtimes management component.\n\n```typescript\nimport { Mise } from \"@nikovirtala/projen-constructs\";\n\nnew Mise(project, {\n nodeVersion: \"22.21.1\",\n});\n```\n\n#### Homebrew\n\n[Homebrew](https://brew.sh) package management component.\n\n```typescript\nimport { Homebrew } from \"@nikovirtala/projen-constructs\";\n\nconst homebrew = new Homebrew(project, {\n packages: [\"jq\", \"yq\"],\n});\n\nhomebrew.addPackage(\"gh\");\n```\n\n#### Colima\n\n[Colima](https://github.com/abiosoft/colima) container runtime component. Alternative for Docker.\n\n```typescript\nimport { Colima } from \"@nikovirtala/projen-constructs\";\n\nnew Colima(project);\n```\n\n#### LocalStack\n\n[LocalStack](https://www.localstack.cloud) AWS emulation component.\n\n```typescript\nimport { LocalStack } from \"@nikovirtala/projen-constructs\";\n\nnew LocalStack(project, {\n services: [\"s3\", \"lambda\", \"dynamodb\"],\n port: 4566,\n debug: true,\n});\n```\n\n#### LambdaFunctionConstructGenerator\n\nGenerates AWS CDK Lambda Function constructs and bundles their code.\n\n```typescript\nimport { LambdaFunctionConstructGenerator } from \"@nikovirtala/projen-constructs\";\n\nnew LambdaFunctionConstructGenerator(project, {\n sourceDir: \"src/handlers\",\n outputDir: \"src/constructs/lambda\",\n filePattern: \"*.lambda.ts\",\n esbuildOptions: {\n minify: true,\n sourcemap: true,\n },\n});\n```\n\n#### Bundler\n\nLow-level bundling utilities for Lambda functions.\n\n```typescript\nimport {\n Bundler,\n LambdaFunctionCodeBundle,\n} from \"@nikovirtala/projen-constructs\";\n\nconst bundler = new Bundler(project, {\n assetsDir: \"assets\",\n esbuildVersion: \"^0.25\",\n});\n\nnew LambdaFunctionCodeBundle(project, {\n entrypoint: \"src/my-function.lambda.ts\",\n extension: \".lambda.ts\",\n});\n```\n"
4193
+ "markdown": "# @nikovirtala/projen-constructs\n\nProjen project types with standard configuration for consistent project setup across all repositories.\n\n## Installation\n\n```bash\npnpm add -D @nikovirtala/projen-constructs projen constructs\n```\n\n## Features\n\n- **Standard Configuration**: Opinionated defaults for author, release branch, package manager, Node.js, TypeScript, and tooling\n- **Automatic Project Type Discovery**: Generates `ProjectType` enum from Projen's JSII manifest (18 project types)\n- **Component System**: Reusable components (Vitest, Mise, TypeDoc, LocalStack, etc.)\n- **Code Generation**: `ProjectGenerator` creates project classes with standard configuration\n- **ES Modules**: TypeScript and CDK App projects use ES modules (JSII uses CommonJS)\n- **Code Quality**: Biome for formatting and linting\n- **Testing**: Vitest with coverage\n- **Auto-merge**: Enabled with auto-approve\n- **VSCode**: Recommended extensions and settings\n- **mise**: Node version management\n\n## Standard Configuration\n\n- **Author**: Niko Virtala (niko.virtala@hey.com)\n- **Default Release Branch**: main\n- **Package Manager**: pnpm 10\n- **Node Version**: 22.21.1\n- **TypeScript**: 5.9.3\n- **CDK Version**: 2.223.0 (for CDK projects)\n- **JSII Version**: ~5.9.3 (for JSII projects)\n\n## Customization\n\nOverride any option by passing it to the constructor:\n\n```typescript\nconst project = new JsiiProject({\n name: \"my-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-project.git\",\n minNodeVersion: \"20.0.0\",\n author: \"Custom Author\",\n authorAddress: \"custom@example.com\",\n mise: false,\n vitest: false,\n tsconfig: {\n compilerOptions: {\n noUnusedLocals: false,\n },\n },\n biomeOptions: {\n biomeConfig: {\n formatter: {\n lineWidth: 100,\n },\n },\n },\n});\n```\n\n## Usage\n\n### Projects\n\n#### AWS CDK Construct Library Project\n\n```typescript\nimport { AwsCdkConstructLibraryProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new AwsCdkConstructLibraryProject({\n name: \"my-cdk-construct\",\n repositoryUrl: \"https://github.com/nikovirtala/my-cdk-construct.git\",\n});\n\nproject.synth();\n```\n\n#### AWS CDK TypeScript App Project\n\n```typescript\nimport { AwsCdkTypeScriptAppProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new AwsCdkTypeScriptAppProject({\n name: \"my-cdk-app\",\n repositoryUrl: \"https://github.com/nikovirtala/my-cdk-app.git\",\n});\n\nproject.synth();\n```\n\n#### JSII Project\n\n```typescript\nimport { JsiiProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new JsiiProject({\n name: \"my-jsii-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-jsii-project.git\",\n});\n\nproject.synth();\n```\n\n#### TypeScript Project\n\n```typescript\nimport { TypeScriptProject } from \"@nikovirtala/projen-constructs\";\n\nconst project = new TypeScriptProject({\n name: \"my-typescript-project\",\n repositoryUrl: \"https://github.com/nikovirtala/my-typescript-project.git\",\n});\n\nproject.synth();\n```\n\n### Components\n\nThe package includes reusable components for common development tasks:\n\n#### Vitest\n\n[Vitest](https://vitest.dev) testing framework component.\n\n```typescript\nimport { Vitest } from \"@nikovirtala/projen-constructs\";\n\nnew Vitest(project, {\n vitestVersion: \"^4\",\n config: {\n coverageProvider: CoverageProvider.V8,\n coverageReporters: [CoverageReporter.TEXT, CoverageReporter.LCOV],\n },\n});\n```\n\n#### TypeDoc\n\n[TypeDoc](https://typedoc.org) documentation generation component.\n\n```typescript\nimport { TypeDoc, EntryPointStrategy } from \"@nikovirtala/projen-constructs\";\n\nnew TypeDoc(project, {\n version: \"^0.28\",\n typeDocConfig: {\n entryPointStrategy: EntryPointStrategy.EXPAND,\n out: \"docs/api\",\n exclude: [\"**/*.test.ts\"],\n },\n});\n```\n\n#### Mise\n\n[Mise](https://mise.jdx.dev) dev tools/runtimes management component.\n\n```typescript\nimport { Mise } from \"@nikovirtala/projen-constructs\";\n\nnew Mise(project, {\n nodeVersion: \"22.21.1\",\n});\n```\n\n#### Homebrew\n\n[Homebrew](https://brew.sh) package management component.\n\n```typescript\nimport { Homebrew } from \"@nikovirtala/projen-constructs\";\n\nconst homebrew = new Homebrew(project, {\n packages: [\"jq\", \"yq\"],\n});\n\nhomebrew.addPackage(\"gh\");\n```\n\n#### Colima\n\n[Colima](https://github.com/abiosoft/colima) container runtime component. Alternative for Docker.\n\n```typescript\nimport { Colima } from \"@nikovirtala/projen-constructs\";\n\nnew Colima(project);\n```\n\n#### LocalStack\n\n[LocalStack](https://www.localstack.cloud) AWS emulation component.\n\n```typescript\nimport { LocalStack } from \"@nikovirtala/projen-constructs\";\n\nnew LocalStack(project, {\n services: [\"s3\", \"lambda\", \"dynamodb\"],\n port: 4566,\n debug: true,\n});\n```\n\n#### LambdaFunctionConstructGenerator\n\nGenerates AWS CDK Lambda Function constructs and bundles their code.\n\n```typescript\nimport { LambdaFunctionConstructGenerator } from \"@nikovirtala/projen-constructs\";\n\nnew LambdaFunctionConstructGenerator(project, {\n sourceDir: \"src/handlers\",\n outputDir: \"src/constructs/lambda\",\n filePattern: \"*.lambda.ts\",\n esbuildOptions: {\n minify: true,\n sourcemap: true,\n },\n});\n```\n\n#### Bundler\n\nLow-level bundling utilities for Lambda functions.\n\n```typescript\nimport {\n Bundler,\n LambdaFunctionCodeBundle,\n} from \"@nikovirtala/projen-constructs\";\n\nconst bundler = new Bundler(project, {\n assetsDir: \"assets\",\n esbuildVersion: \"^0.25\",\n});\n\nnew LambdaFunctionCodeBundle(project, {\n entrypoint: \"src/my-function.lambda.ts\",\n extension: \".lambda.ts\",\n});\n```\n\n#### ProjectGenerator\n\nGenerates TypeScript project classes with standard configuration.\n\n```typescript\nimport { ProjectGenerator, ProjectType } from \"@nikovirtala/projen-constructs\";\n\nnew ProjectGenerator(project, {\n name: \"TypeScriptProject\",\n projectType: ProjectType.TYPESCRIPT,\n filePath: \"./src/projects/typescript.generated.ts\",\n components: [\n { componentClass: Mise },\n { componentClass: Vitest }, // Auto-detects VitestOptions from JSII manifest\n ],\n});\n```\n\nFeatures:\n- Automatically generates the `ProjectType` enum from Projen's JSII manifest\n- Auto-detects component options types from JSII manifests\n- Validates paths to prevent directory traversal attacks\n- Structured error handling with custom error classes\n"
4194
4194
  },
4195
4195
  "repository": {
4196
4196
  "type": "git",
@@ -4218,7 +4218,7 @@
4218
4218
  },
4219
4219
  "locationInModule": {
4220
4220
  "filename": "src/projects/awscdk-construct-library.generated.ts",
4221
- "line": 22
4221
+ "line": 20
4222
4222
  },
4223
4223
  "parameters": [
4224
4224
  {
@@ -4235,7 +4235,7 @@
4235
4235
  "kind": "class",
4236
4236
  "locationInModule": {
4237
4237
  "filename": "src/projects/awscdk-construct-library.generated.ts",
4238
- "line": 18
4238
+ "line": 16
4239
4239
  },
4240
4240
  "name": "AwsCdkConstructLibraryProject",
4241
4241
  "symbolId": "src/projects/awscdk-construct-library.generated:AwsCdkConstructLibraryProject"
@@ -7353,7 +7353,7 @@
7353
7353
  },
7354
7354
  "locationInModule": {
7355
7355
  "filename": "src/projects/awscdk-typescript-app.generated.ts",
7356
- "line": 22
7356
+ "line": 20
7357
7357
  },
7358
7358
  "parameters": [
7359
7359
  {
@@ -7370,7 +7370,7 @@
7370
7370
  "kind": "class",
7371
7371
  "locationInModule": {
7372
7372
  "filename": "src/projects/awscdk-typescript-app.generated.ts",
7373
- "line": 18
7373
+ "line": 16
7374
7374
  },
7375
7375
  "name": "AwsCdkTypeScriptAppProject",
7376
7376
  "symbolId": "src/projects/awscdk-typescript-app.generated:AwsCdkTypeScriptAppProject"
@@ -10373,6 +10373,186 @@
10373
10373
  ],
10374
10374
  "symbolId": "src/projects/awscdk-typescript-app-options.generated:AwsCdkTypeScriptAppProjectOptions"
10375
10375
  },
10376
+ "@nikovirtala/projen-constructs.CommentStyle": {
10377
+ "assembly": "@nikovirtala/projen-constructs",
10378
+ "docs": {
10379
+ "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
10380
+ "stability": "stable",
10381
+ "summary": "Specifies the documentation mode TypeDoc should use."
10382
+ },
10383
+ "fqn": "@nikovirtala/projen-constructs.CommentStyle",
10384
+ "kind": "enum",
10385
+ "locationInModule": {
10386
+ "filename": "src/components/typedoc-config.ts",
10387
+ "line": 454
10388
+ },
10389
+ "members": [
10390
+ {
10391
+ "docs": {
10392
+ "stability": "stable",
10393
+ "summary": "Parse JSDoc style comments only."
10394
+ },
10395
+ "name": "JSDOC"
10396
+ },
10397
+ {
10398
+ "docs": {
10399
+ "stability": "stable",
10400
+ "summary": "Parse block comments."
10401
+ },
10402
+ "name": "BLOCK"
10403
+ },
10404
+ {
10405
+ "docs": {
10406
+ "stability": "stable",
10407
+ "summary": "Parse line comments (//)."
10408
+ },
10409
+ "name": "LINE"
10410
+ },
10411
+ {
10412
+ "docs": {
10413
+ "stability": "stable",
10414
+ "summary": "Parse all comment styles."
10415
+ },
10416
+ "name": "ALL"
10417
+ }
10418
+ ],
10419
+ "name": "CommentStyle",
10420
+ "symbolId": "src/components/typedoc-config:CommentStyle"
10421
+ },
10422
+ "@nikovirtala/projen-constructs.Component": {
10423
+ "assembly": "@nikovirtala/projen-constructs",
10424
+ "datatype": true,
10425
+ "docs": {
10426
+ "stability": "stable",
10427
+ "summary": "Configuration for a component to be integrated into a generated project."
10428
+ },
10429
+ "fqn": "@nikovirtala/projen-constructs.Component",
10430
+ "kind": "interface",
10431
+ "locationInModule": {
10432
+ "filename": "src/project-generator.ts",
10433
+ "line": 36
10434
+ },
10435
+ "name": "Component",
10436
+ "properties": [
10437
+ {
10438
+ "abstract": true,
10439
+ "docs": {
10440
+ "remarks": "Optional - auto-detected by searching JSII manifests.",
10441
+ "stability": "stable",
10442
+ "summary": "Fully qualified name of the component class."
10443
+ },
10444
+ "immutable": true,
10445
+ "locationInModule": {
10446
+ "filename": "src/project-generator.ts",
10447
+ "line": 49
10448
+ },
10449
+ "name": "fqn",
10450
+ "optional": true,
10451
+ "type": {
10452
+ "primitive": "string"
10453
+ }
10454
+ },
10455
+ {
10456
+ "abstract": true,
10457
+ "docs": {
10458
+ "remarks": "Optional - auto-detected from component constructor.\nSet to false to disable options property generation.\nSet to string or object to customize the property name.",
10459
+ "stability": "stable",
10460
+ "summary": "Options property configuration for the generated options interface."
10461
+ },
10462
+ "immutable": true,
10463
+ "locationInModule": {
10464
+ "filename": "src/project-generator.ts",
10465
+ "line": 58
10466
+ },
10467
+ "name": "optionsProperty",
10468
+ "optional": true,
10469
+ "type": {
10470
+ "union": {
10471
+ "types": [
10472
+ {
10473
+ "primitive": "string"
10474
+ },
10475
+ {
10476
+ "primitive": "boolean"
10477
+ },
10478
+ {
10479
+ "fqn": "@nikovirtala/projen-constructs.ComponentOptions"
10480
+ }
10481
+ ]
10482
+ }
10483
+ }
10484
+ }
10485
+ ],
10486
+ "symbolId": "src/project-generator:Component"
10487
+ },
10488
+ "@nikovirtala/projen-constructs.ComponentOptions": {
10489
+ "assembly": "@nikovirtala/projen-constructs",
10490
+ "datatype": true,
10491
+ "docs": {
10492
+ "stability": "stable",
10493
+ "summary": "Options property configuration."
10494
+ },
10495
+ "fqn": "@nikovirtala/projen-constructs.ComponentOptions",
10496
+ "kind": "interface",
10497
+ "locationInModule": {
10498
+ "filename": "src/project-generator.ts",
10499
+ "line": 64
10500
+ },
10501
+ "name": "ComponentOptions",
10502
+ "properties": [
10503
+ {
10504
+ "abstract": true,
10505
+ "docs": {
10506
+ "stability": "stable",
10507
+ "summary": "Name of the options property."
10508
+ },
10509
+ "immutable": true,
10510
+ "locationInModule": {
10511
+ "filename": "src/project-generator.ts",
10512
+ "line": 68
10513
+ },
10514
+ "name": "name",
10515
+ "type": {
10516
+ "primitive": "string"
10517
+ }
10518
+ },
10519
+ {
10520
+ "abstract": true,
10521
+ "docs": {
10522
+ "stability": "stable",
10523
+ "summary": "Documentation summary (optional, auto-detected from component constructor)."
10524
+ },
10525
+ "immutable": true,
10526
+ "locationInModule": {
10527
+ "filename": "src/project-generator.ts",
10528
+ "line": 76
10529
+ },
10530
+ "name": "docs",
10531
+ "optional": true,
10532
+ "type": {
10533
+ "primitive": "string"
10534
+ }
10535
+ },
10536
+ {
10537
+ "abstract": true,
10538
+ "docs": {
10539
+ "stability": "stable",
10540
+ "summary": "Fully qualified type name (optional, auto-detected from component constructor)."
10541
+ },
10542
+ "immutable": true,
10543
+ "locationInModule": {
10544
+ "filename": "src/project-generator.ts",
10545
+ "line": 72
10546
+ },
10547
+ "name": "type",
10548
+ "optional": true,
10549
+ "type": {
10550
+ "primitive": "string"
10551
+ }
10552
+ }
10553
+ ],
10554
+ "symbolId": "src/project-generator:ComponentOptions"
10555
+ },
10376
10556
  "@nikovirtala/projen-constructs.CoverageProvider": {
10377
10557
  "assembly": "@nikovirtala/projen-constructs",
10378
10558
  "docs": {
@@ -10382,18 +10562,22 @@
10382
10562
  "kind": "enum",
10383
10563
  "locationInModule": {
10384
10564
  "filename": "src/components/vitest.ts",
10385
- "line": 21
10565
+ "line": 72
10386
10566
  },
10387
10567
  "members": [
10388
10568
  {
10389
10569
  "docs": {
10390
- "stability": "stable"
10570
+ "see": "https://istanbul.js.org",
10571
+ "stability": "stable",
10572
+ "summary": "Provide coverage report using istanbul."
10391
10573
  },
10392
10574
  "name": "ISTANBUL"
10393
10575
  },
10394
10576
  {
10395
10577
  "docs": {
10396
- "stability": "stable"
10578
+ "see": "https://v8.dev/blog/javascript-code-coverage",
10579
+ "stability": "stable",
10580
+ "summary": "Provide coverage reports using v8."
10397
10581
  },
10398
10582
  "name": "V8"
10399
10583
  }
@@ -10410,36 +10594,41 @@
10410
10594
  "kind": "enum",
10411
10595
  "locationInModule": {
10412
10596
  "filename": "src/components/vitest.ts",
10413
- "line": 26
10597
+ "line": 88
10414
10598
  },
10415
10599
  "members": [
10416
10600
  {
10417
10601
  "docs": {
10418
- "stability": "stable"
10602
+ "stability": "stable",
10603
+ "summary": "Provides `clover` report."
10419
10604
  },
10420
10605
  "name": "CLOVER"
10421
10606
  },
10422
10607
  {
10423
10608
  "docs": {
10424
- "stability": "stable"
10609
+ "stability": "stable",
10610
+ "summary": "Provides `HTML` report."
10425
10611
  },
10426
10612
  "name": "HTML"
10427
10613
  },
10428
10614
  {
10429
10615
  "docs": {
10430
- "stability": "stable"
10616
+ "stability": "stable",
10617
+ "summary": "Provides `JSON` report."
10431
10618
  },
10432
10619
  "name": "JSON"
10433
10620
  },
10434
10621
  {
10435
10622
  "docs": {
10436
- "stability": "stable"
10623
+ "stability": "stable",
10624
+ "summary": "Provides `LCOV` report."
10437
10625
  },
10438
10626
  "name": "LCOV"
10439
10627
  },
10440
10628
  {
10441
10629
  "docs": {
10442
- "stability": "stable"
10630
+ "stability": "stable",
10631
+ "summary": "Provides `text` report."
10443
10632
  },
10444
10633
  "name": "TEXT"
10445
10634
  }
@@ -10447,6 +10636,52 @@
10447
10636
  "name": "CoverageReporter",
10448
10637
  "symbolId": "src/components/vitest:CoverageReporter"
10449
10638
  },
10639
+ "@nikovirtala/projen-constructs.EntryPointStrategy": {
10640
+ "assembly": "@nikovirtala/projen-constructs",
10641
+ "docs": {
10642
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
10643
+ "stability": "stable",
10644
+ "summary": "Specifies the strategy to be used to convert entry points into documentation."
10645
+ },
10646
+ "fqn": "@nikovirtala/projen-constructs.EntryPointStrategy",
10647
+ "kind": "enum",
10648
+ "locationInModule": {
10649
+ "filename": "src/components/typedoc-config.ts",
10650
+ "line": 402
10651
+ },
10652
+ "members": [
10653
+ {
10654
+ "docs": {
10655
+ "stability": "stable",
10656
+ "summary": "Expects all entry points to be contained within a single package."
10657
+ },
10658
+ "name": "RESOLVE"
10659
+ },
10660
+ {
10661
+ "docs": {
10662
+ "stability": "stable",
10663
+ "summary": "Expects all entry points to be top-level directories."
10664
+ },
10665
+ "name": "EXPAND"
10666
+ },
10667
+ {
10668
+ "docs": {
10669
+ "stability": "stable",
10670
+ "summary": "Expects all entry points to be individual files."
10671
+ },
10672
+ "name": "PACKAGES"
10673
+ },
10674
+ {
10675
+ "docs": {
10676
+ "stability": "stable",
10677
+ "summary": "Merges multiple projects into a single documentation site."
10678
+ },
10679
+ "name": "MERGE"
10680
+ }
10681
+ ],
10682
+ "name": "EntryPointStrategy",
10683
+ "symbolId": "src/components/typedoc-config:EntryPointStrategy"
10684
+ },
10450
10685
  "@nikovirtala/projen-constructs.Environment": {
10451
10686
  "assembly": "@nikovirtala/projen-constructs",
10452
10687
  "docs": {
@@ -10461,25 +10696,32 @@
10461
10696
  "members": [
10462
10697
  {
10463
10698
  "docs": {
10464
- "stability": "stable"
10699
+ "see": "https://edge-runtime.vercel.app/packages/vm",
10700
+ "stability": "stable",
10701
+ "summary": "Run tests in Vercel's Edge Runtime VM."
10465
10702
  },
10466
10703
  "name": "EDGE_RUNTIME"
10467
10704
  },
10468
10705
  {
10469
10706
  "docs": {
10470
- "stability": "stable"
10707
+ "see": "https://github.com/capricorn86/happy-dom",
10708
+ "stability": "stable",
10709
+ "summary": "Run tests in `happy-dom` environment."
10471
10710
  },
10472
10711
  "name": "HAPPY_DOM"
10473
10712
  },
10474
10713
  {
10475
10714
  "docs": {
10476
- "stability": "stable"
10715
+ "see": "https://github.com/jsdom/jsdom",
10716
+ "stability": "stable",
10717
+ "summary": "Run tests in `jsdom` environment."
10477
10718
  },
10478
10719
  "name": "JSDOM"
10479
10720
  },
10480
10721
  {
10481
10722
  "docs": {
10482
- "stability": "stable"
10723
+ "stability": "stable",
10724
+ "summary": "Run tests in a Node.js environment."
10483
10725
  },
10484
10726
  "name": "NODE"
10485
10727
  }
@@ -10502,7 +10744,7 @@
10502
10744
  },
10503
10745
  "locationInModule": {
10504
10746
  "filename": "src/projects/jsii.generated.ts",
10505
- "line": 22
10747
+ "line": 21
10506
10748
  },
10507
10749
  "parameters": [
10508
10750
  {
@@ -10519,7 +10761,7 @@
10519
10761
  "kind": "class",
10520
10762
  "locationInModule": {
10521
10763
  "filename": "src/projects/jsii.generated.ts",
10522
- "line": 18
10764
+ "line": 17
10523
10765
  },
10524
10766
  "name": "JsiiProject",
10525
10767
  "symbolId": "src/projects/jsii.generated:JsiiProject"
@@ -13141,6 +13383,42 @@
13141
13383
  "primitive": "string"
13142
13384
  }
13143
13385
  },
13386
+ {
13387
+ "abstract": true,
13388
+ "docs": {
13389
+ "default": "true",
13390
+ "stability": "stable",
13391
+ "summary": "Enable TypeDoc component."
13392
+ },
13393
+ "immutable": true,
13394
+ "locationInModule": {
13395
+ "filename": "src/projects/jsii-options.generated.ts",
13396
+ "line": 1067
13397
+ },
13398
+ "name": "typeDoc",
13399
+ "optional": true,
13400
+ "type": {
13401
+ "primitive": "boolean"
13402
+ }
13403
+ },
13404
+ {
13405
+ "abstract": true,
13406
+ "docs": {
13407
+ "default": "- default TypeDoc configuration",
13408
+ "stability": "stable",
13409
+ "summary": "TypeDoc configuration."
13410
+ },
13411
+ "immutable": true,
13412
+ "locationInModule": {
13413
+ "filename": "src/projects/jsii-options.generated.ts",
13414
+ "line": 1072
13415
+ },
13416
+ "name": "typeDocOptions",
13417
+ "optional": true,
13418
+ "type": {
13419
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions"
13420
+ }
13421
+ },
13144
13422
  {
13145
13423
  "abstract": true,
13146
13424
  "docs": {
@@ -13374,125 +13652,1538 @@
13374
13652
  },
13375
13653
  "immutable": true,
13376
13654
  "locationInModule": {
13377
- "filename": "src/projects/jsii-options.generated.ts",
13378
- "line": 415
13655
+ "filename": "src/projects/jsii-options.generated.ts",
13656
+ "line": 415
13657
+ },
13658
+ "name": "workflowRunsOnGroup",
13659
+ "optional": true,
13660
+ "type": {
13661
+ "fqn": "projen.GroupRunnerOptions"
13662
+ }
13663
+ },
13664
+ {
13665
+ "abstract": true,
13666
+ "docs": {
13667
+ "default": "- Yarn Berry v4 with all default options",
13668
+ "stability": "experimental",
13669
+ "summary": "Options for Yarn Berry."
13670
+ },
13671
+ "immutable": true,
13672
+ "locationInModule": {
13673
+ "filename": "src/projects/jsii-options.generated.ts",
13674
+ "line": 607
13675
+ },
13676
+ "name": "yarnBerryOptions",
13677
+ "optional": true,
13678
+ "type": {
13679
+ "fqn": "projen.javascript.YarnBerryOptions"
13680
+ }
13681
+ }
13682
+ ],
13683
+ "symbolId": "src/projects/jsii-options.generated:JsiiProjectOptions"
13684
+ },
13685
+ "@nikovirtala/projen-constructs.LogLevel": {
13686
+ "assembly": "@nikovirtala/projen-constructs",
13687
+ "docs": {
13688
+ "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
13689
+ "stability": "stable",
13690
+ "summary": "Specifies the logger that should be used."
13691
+ },
13692
+ "fqn": "@nikovirtala/projen-constructs.LogLevel",
13693
+ "kind": "enum",
13694
+ "locationInModule": {
13695
+ "filename": "src/components/typedoc-config.ts",
13696
+ "line": 426
13697
+ },
13698
+ "members": [
13699
+ {
13700
+ "docs": {
13701
+ "stability": "stable",
13702
+ "summary": "Log all messages including verbose debug information."
13703
+ },
13704
+ "name": "VERBOSE"
13705
+ },
13706
+ {
13707
+ "docs": {
13708
+ "stability": "stable",
13709
+ "summary": "Log informational messages and above."
13710
+ },
13711
+ "name": "INFO"
13712
+ },
13713
+ {
13714
+ "docs": {
13715
+ "stability": "stable",
13716
+ "summary": "Log warnings and errors only."
13717
+ },
13718
+ "name": "WARN"
13719
+ },
13720
+ {
13721
+ "docs": {
13722
+ "stability": "stable",
13723
+ "summary": "Log errors only."
13724
+ },
13725
+ "name": "ERROR"
13726
+ },
13727
+ {
13728
+ "docs": {
13729
+ "stability": "stable",
13730
+ "summary": "Disable all logging."
13731
+ },
13732
+ "name": "NONE"
13733
+ }
13734
+ ],
13735
+ "name": "LogLevel",
13736
+ "symbolId": "src/components/typedoc-config:LogLevel"
13737
+ },
13738
+ "@nikovirtala/projen-constructs.Pool": {
13739
+ "assembly": "@nikovirtala/projen-constructs",
13740
+ "docs": {
13741
+ "stability": "stable"
13742
+ },
13743
+ "fqn": "@nikovirtala/projen-constructs.Pool",
13744
+ "kind": "enum",
13745
+ "locationInModule": {
13746
+ "filename": "src/components/vitest.ts",
13747
+ "line": 35
13748
+ },
13749
+ "members": [
13750
+ {
13751
+ "docs": {
13752
+ "remarks": "Test isolation (when enabled) is done by spawning a new child process for each test file.",
13753
+ "see": "https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options",
13754
+ "stability": "stable",
13755
+ "summary": "Run tests in `node:child_process` using fork()."
13756
+ },
13757
+ "name": "FORKS"
13758
+ },
13759
+ {
13760
+ "docs": {
13761
+ "remarks": "Test isolation (when enabled) is done by spawning a new thread for each test file.",
13762
+ "stability": "stable",
13763
+ "summary": "Run tests in `node:worker_threads`."
13764
+ },
13765
+ "name": "THREADS"
13766
+ },
13767
+ {
13768
+ "docs": {
13769
+ "remarks": "Test files are run parallel using `node:child_process` fork()\n\nThis makes tests run faster, but VM module is unstable. Your tests might leak memory.",
13770
+ "see": "https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options",
13771
+ "stability": "stable",
13772
+ "summary": "Run tests in isolated `node:vm`."
13773
+ },
13774
+ "name": "VMFORKS"
13775
+ },
13776
+ {
13777
+ "docs": {
13778
+ "remarks": "This makes tests run faster, but VM module is unstable. Your tests might leak memory.",
13779
+ "stability": "stable",
13780
+ "summary": "Run tests in isolated `node:vm`. Test files are run parallel using `node:worker_threads`."
13781
+ },
13782
+ "name": "VMTHREADS"
13783
+ }
13784
+ ],
13785
+ "name": "Pool",
13786
+ "symbolId": "src/components/vitest:Pool"
13787
+ },
13788
+ "@nikovirtala/projen-constructs.ProjectGenerator": {
13789
+ "assembly": "@nikovirtala/projen-constructs",
13790
+ "base": "projen.Component",
13791
+ "docs": {
13792
+ "remarks": "This component automates the creation of project classes that extend Projen base classes\nwith opinionated defaults and component integration.",
13793
+ "stability": "stable",
13794
+ "summary": "Projen component that generates TypeScript project classes with standard configuration."
13795
+ },
13796
+ "fqn": "@nikovirtala/projen-constructs.ProjectGenerator",
13797
+ "initializer": {
13798
+ "docs": {
13799
+ "stability": "stable"
13800
+ },
13801
+ "locationInModule": {
13802
+ "filename": "src/project-generator.ts",
13803
+ "line": 559
13804
+ },
13805
+ "parameters": [
13806
+ {
13807
+ "docs": {
13808
+ "summary": "- Projen project instance."
13809
+ },
13810
+ "name": "project",
13811
+ "type": {
13812
+ "fqn": "projen.Project"
13813
+ }
13814
+ },
13815
+ {
13816
+ "docs": {
13817
+ "summary": "- Generator configuration."
13818
+ },
13819
+ "name": "options",
13820
+ "type": {
13821
+ "fqn": "@nikovirtala/projen-constructs.ProjectGeneratorOptions"
13822
+ }
13823
+ }
13824
+ ]
13825
+ },
13826
+ "kind": "class",
13827
+ "locationInModule": {
13828
+ "filename": "src/project-generator.ts",
13829
+ "line": 551
13830
+ },
13831
+ "methods": [
13832
+ {
13833
+ "docs": {
13834
+ "remarks": "Called by Projen during the synthesis phase to generate the project class file.\nThe file is marked as readonly to prevent manual editing.",
13835
+ "stability": "stable",
13836
+ "summary": "Generates the TypeScript class file during Projen synthesis."
13837
+ },
13838
+ "locationInModule": {
13839
+ "filename": "src/project-generator.ts",
13840
+ "line": 688
13841
+ },
13842
+ "name": "preSynthesize",
13843
+ "overrides": "projen.Component"
13844
+ }
13845
+ ],
13846
+ "name": "ProjectGenerator",
13847
+ "symbolId": "src/project-generator:ProjectGenerator"
13848
+ },
13849
+ "@nikovirtala/projen-constructs.ProjectGeneratorOptions": {
13850
+ "assembly": "@nikovirtala/projen-constructs",
13851
+ "datatype": true,
13852
+ "docs": {
13853
+ "remarks": "Configures the generation of a TypeScript project class that extends a Projen base class\nwith standard configuration and component integration.",
13854
+ "stability": "stable",
13855
+ "summary": "Options for ProjectGenerator component."
13856
+ },
13857
+ "fqn": "@nikovirtala/projen-constructs.ProjectGeneratorOptions",
13858
+ "interfaces": [
13859
+ "projen.SourceCodeOptions"
13860
+ ],
13861
+ "kind": "interface",
13862
+ "locationInModule": {
13863
+ "filename": "src/project-generator.ts",
13864
+ "line": 85
13865
+ },
13866
+ "name": "ProjectGeneratorOptions",
13867
+ "properties": [
13868
+ {
13869
+ "abstract": true,
13870
+ "docs": {
13871
+ "example": "\"src/projects/typescript.generated.ts\"",
13872
+ "remarks": "Must contain a directory separator. The options interface will be generated\nin the same directory with a \".generated.ts\" suffix.",
13873
+ "stability": "stable",
13874
+ "summary": "Output file path for the generated class."
13875
+ },
13876
+ "immutable": true,
13877
+ "locationInModule": {
13878
+ "filename": "src/project-generator.ts",
13879
+ "line": 111
13880
+ },
13881
+ "name": "filePath",
13882
+ "type": {
13883
+ "primitive": "string"
13884
+ }
13885
+ },
13886
+ {
13887
+ "abstract": true,
13888
+ "docs": {
13889
+ "remarks": "The options interface will be named `${name}Options`.",
13890
+ "stability": "stable",
13891
+ "summary": "Name of the generated class (e.g., \"TypeScriptProject\")."
13892
+ },
13893
+ "immutable": true,
13894
+ "locationInModule": {
13895
+ "filename": "src/project-generator.ts",
13896
+ "line": 91
13897
+ },
13898
+ "name": "name",
13899
+ "type": {
13900
+ "primitive": "string"
13901
+ }
13902
+ },
13903
+ {
13904
+ "abstract": true,
13905
+ "docs": {
13906
+ "example": "ProjectType.JSII",
13907
+ "remarks": "Specifies which Projen base class to extend and which default configuration to apply.",
13908
+ "stability": "stable",
13909
+ "summary": "Project type identifier."
13910
+ },
13911
+ "immutable": true,
13912
+ "locationInModule": {
13913
+ "filename": "src/project-generator.ts",
13914
+ "line": 101
13915
+ },
13916
+ "name": "projectType",
13917
+ "type": {
13918
+ "fqn": "@nikovirtala/projen-constructs.ProjectType"
13919
+ }
13920
+ },
13921
+ {
13922
+ "abstract": true,
13923
+ "docs": {
13924
+ "default": "[{ component: Mise }, { component: Vitest, optionsProperty: { name: \"vitestOptions\", type: \"...\", docs: \"...\" } }]",
13925
+ "remarks": "Each component will be instantiated during project construction and can be\nconfigured via an optional options property in the generated interface.",
13926
+ "stability": "stable",
13927
+ "summary": "Components to integrate into the project."
13928
+ },
13929
+ "immutable": true,
13930
+ "locationInModule": {
13931
+ "filename": "src/project-generator.ts",
13932
+ "line": 121
13933
+ },
13934
+ "name": "components",
13935
+ "optional": true,
13936
+ "type": {
13937
+ "collection": {
13938
+ "elementtype": {
13939
+ "fqn": "@nikovirtala/projen-constructs.Component"
13940
+ },
13941
+ "kind": "array"
13942
+ }
13943
+ }
13944
+ },
13945
+ {
13946
+ "abstract": true,
13947
+ "docs": {
13948
+ "remarks": "Use this to hide base class options that should not be configurable\nin the generated project type.",
13949
+ "stability": "stable",
13950
+ "summary": "Property names to omit from the base options interface."
13951
+ },
13952
+ "immutable": true,
13953
+ "locationInModule": {
13954
+ "filename": "src/project-generator.ts",
13955
+ "line": 139
13956
+ },
13957
+ "name": "omitOptions",
13958
+ "optional": true,
13959
+ "type": {
13960
+ "collection": {
13961
+ "elementtype": {
13962
+ "primitive": "string"
13963
+ },
13964
+ "kind": "array"
13965
+ }
13966
+ }
13967
+ }
13968
+ ],
13969
+ "symbolId": "src/project-generator:ProjectGeneratorOptions"
13970
+ },
13971
+ "@nikovirtala/projen-constructs.ProjectType": {
13972
+ "assembly": "@nikovirtala/projen-constructs",
13973
+ "docs": {
13974
+ "custom": {
13975
+ "generated": "Automatically generated from Projen's JSII manifest"
13976
+ },
13977
+ "remarks": "Each project type corresponds to a generated project class and its configuration\nin the defaultOptions structure.",
13978
+ "stability": "stable",
13979
+ "summary": "Enum defining all supported project types."
13980
+ },
13981
+ "fqn": "@nikovirtala/projen-constructs.ProjectType",
13982
+ "kind": "enum",
13983
+ "locationInModule": {
13984
+ "filename": "src/project-type.ts",
13985
+ "line": 9
13986
+ },
13987
+ "members": [
13988
+ {
13989
+ "docs": {
13990
+ "stability": "stable",
13991
+ "summary": "AWS CDK construct library project."
13992
+ },
13993
+ "name": "AWS_CDK_CONSTRUCT_LIBRARY"
13994
+ },
13995
+ {
13996
+ "docs": {
13997
+ "stability": "stable",
13998
+ "summary": "AWS CDK app in Java."
13999
+ },
14000
+ "name": "AWS_CDK_JAVA_APP"
14001
+ },
14002
+ {
14003
+ "docs": {
14004
+ "stability": "stable",
14005
+ "summary": "AWS CDK app in Python."
14006
+ },
14007
+ "name": "AWS_CDK_PYTHON_APP"
14008
+ },
14009
+ {
14010
+ "docs": {
14011
+ "stability": "stable",
14012
+ "summary": "AWS CDK app in TypeScript."
14013
+ },
14014
+ "name": "AWS_CDK_TYPE_SCRIPT_APP"
14015
+ },
14016
+ {
14017
+ "docs": {
14018
+ "stability": "stable",
14019
+ "summary": "CDK8s app in Python."
14020
+ },
14021
+ "name": "CDK8S_PYTHON_APP"
14022
+ },
14023
+ {
14024
+ "docs": {
14025
+ "stability": "stable",
14026
+ "summary": "CDK8s app in TypeScript."
14027
+ },
14028
+ "name": "CDK8S_TYPE_SCRIPT_APP"
14029
+ },
14030
+ {
14031
+ "docs": {
14032
+ "stability": "stable",
14033
+ "summary": "ConstructLibraryAws."
14034
+ },
14035
+ "name": "CONSTRUCT_LIBRARY_AWS"
14036
+ },
14037
+ {
14038
+ "docs": {
14039
+ "stability": "stable",
14040
+ "summary": "CDK8s construct library project."
14041
+ },
14042
+ "name": "CONSTRUCT_LIBRARY_CDK8S"
14043
+ },
14044
+ {
14045
+ "docs": {
14046
+ "stability": "stable",
14047
+ "summary": "CDKTF construct library project."
14048
+ },
14049
+ "name": "CONSTRUCT_LIBRARY_CDKTF"
14050
+ },
14051
+ {
14052
+ "docs": {
14053
+ "stability": "stable",
14054
+ "summary": "GitHub-based project."
14055
+ },
14056
+ "name": "GIT_HUB_PROJECT"
14057
+ },
14058
+ {
14059
+ "docs": {
14060
+ "stability": "stable",
14061
+ "summary": "Java project."
14062
+ },
14063
+ "name": "JAVA_PROJECT"
14064
+ },
14065
+ {
14066
+ "docs": {
14067
+ "stability": "stable",
14068
+ "summary": "Multi-language jsii library project."
14069
+ },
14070
+ "name": "JSII_PROJECT"
14071
+ },
14072
+ {
14073
+ "docs": {
14074
+ "stability": "stable",
14075
+ "summary": "Next.js project using JavaScript."
14076
+ },
14077
+ "name": "NEXT_JS_PROJECT"
14078
+ },
14079
+ {
14080
+ "docs": {
14081
+ "stability": "stable",
14082
+ "summary": "Next.js project using TypeScript."
14083
+ },
14084
+ "name": "NEXT_JS_TYPE_SCRIPT_PROJECT"
14085
+ },
14086
+ {
14087
+ "docs": {
14088
+ "stability": "stable",
14089
+ "summary": "Node.js project."
14090
+ },
14091
+ "name": "NODE_PROJECT"
14092
+ },
14093
+ {
14094
+ "docs": {
14095
+ "stability": "stable",
14096
+ "summary": "Python project."
14097
+ },
14098
+ "name": "PYTHON_PROJECT"
14099
+ },
14100
+ {
14101
+ "docs": {
14102
+ "stability": "stable",
14103
+ "summary": "React project using JavaScript."
14104
+ },
14105
+ "name": "REACT_PROJECT"
14106
+ },
14107
+ {
14108
+ "docs": {
14109
+ "stability": "stable",
14110
+ "summary": "React project using TypeScript."
14111
+ },
14112
+ "name": "REACT_TYPE_SCRIPT_PROJECT"
14113
+ },
14114
+ {
14115
+ "docs": {
14116
+ "stability": "stable",
14117
+ "summary": "TypeScript app."
14118
+ },
14119
+ "name": "TYPE_SCRIPT_APP_PROJECT"
14120
+ },
14121
+ {
14122
+ "docs": {
14123
+ "stability": "stable",
14124
+ "summary": "TypeScriptLibraryProject."
14125
+ },
14126
+ "name": "TYPE_SCRIPT_LIBRARY_PROJECT"
14127
+ },
14128
+ {
14129
+ "docs": {
14130
+ "stability": "stable",
14131
+ "summary": "TypeScript project."
14132
+ },
14133
+ "name": "TYPE_SCRIPT_PROJECT"
14134
+ }
14135
+ ],
14136
+ "name": "ProjectType",
14137
+ "symbolId": "src/project-type:ProjectType"
14138
+ },
14139
+ "@nikovirtala/projen-constructs.TypeDoc": {
14140
+ "assembly": "@nikovirtala/projen-constructs",
14141
+ "base": "projen.Component",
14142
+ "docs": {
14143
+ "stability": "stable",
14144
+ "summary": "TypeDoc component for projen projects."
14145
+ },
14146
+ "fqn": "@nikovirtala/projen-constructs.TypeDoc",
14147
+ "initializer": {
14148
+ "docs": {
14149
+ "stability": "stable"
14150
+ },
14151
+ "locationInModule": {
14152
+ "filename": "src/components/typedoc.ts",
14153
+ "line": 57
14154
+ },
14155
+ "parameters": [
14156
+ {
14157
+ "name": "project",
14158
+ "type": {
14159
+ "fqn": "projen.javascript.NodeProject"
14160
+ }
14161
+ },
14162
+ {
14163
+ "name": "options",
14164
+ "optional": true,
14165
+ "type": {
14166
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions"
14167
+ }
14168
+ }
14169
+ ]
14170
+ },
14171
+ "kind": "class",
14172
+ "locationInModule": {
14173
+ "filename": "src/components/typedoc.ts",
14174
+ "line": 39
14175
+ },
14176
+ "methods": [
14177
+ {
14178
+ "docs": {
14179
+ "stability": "stable"
14180
+ },
14181
+ "locationInModule": {
14182
+ "filename": "src/components/typedoc.ts",
14183
+ "line": 40
14184
+ },
14185
+ "name": "of",
14186
+ "parameters": [
14187
+ {
14188
+ "name": "project",
14189
+ "type": {
14190
+ "fqn": "projen.Project"
14191
+ }
14192
+ }
14193
+ ],
14194
+ "returns": {
14195
+ "optional": true,
14196
+ "type": {
14197
+ "fqn": "@nikovirtala/projen-constructs.TypeDoc"
14198
+ }
14199
+ },
14200
+ "static": true
14201
+ }
14202
+ ],
14203
+ "name": "TypeDoc",
14204
+ "properties": [
14205
+ {
14206
+ "docs": {
14207
+ "stability": "stable",
14208
+ "summary": "TypeDoc configuration file."
14209
+ },
14210
+ "immutable": true,
14211
+ "locationInModule": {
14212
+ "filename": "src/components/typedoc.ts",
14213
+ "line": 55
14214
+ },
14215
+ "name": "file",
14216
+ "type": {
14217
+ "fqn": "projen.JsonFile"
14218
+ }
14219
+ },
14220
+ {
14221
+ "docs": {
14222
+ "stability": "stable",
14223
+ "summary": "TypeDoc task."
14224
+ },
14225
+ "immutable": true,
14226
+ "locationInModule": {
14227
+ "filename": "src/components/typedoc.ts",
14228
+ "line": 50
14229
+ },
14230
+ "name": "task",
14231
+ "type": {
14232
+ "fqn": "projen.Task"
14233
+ }
14234
+ }
14235
+ ],
14236
+ "symbolId": "src/components/typedoc:TypeDoc"
14237
+ },
14238
+ "@nikovirtala/projen-constructs.TypeDocConfiguration": {
14239
+ "assembly": "@nikovirtala/projen-constructs",
14240
+ "datatype": true,
14241
+ "docs": {
14242
+ "see": "https://typedoc.org/options/",
14243
+ "stability": "stable",
14244
+ "summary": "TypeDoc configuration."
14245
+ },
14246
+ "fqn": "@nikovirtala/projen-constructs.TypeDocConfiguration",
14247
+ "kind": "interface",
14248
+ "locationInModule": {
14249
+ "filename": "src/components/typedoc-config.ts",
14250
+ "line": 6
14251
+ },
14252
+ "name": "TypeDocConfiguration",
14253
+ "properties": [
14254
+ {
14255
+ "abstract": true,
14256
+ "docs": {
14257
+ "see": "https://typedoc.org/documents/Options.Output.html#basepath",
14258
+ "stability": "stable",
14259
+ "summary": "Specify the base path for all urls."
14260
+ },
14261
+ "immutable": true,
14262
+ "locationInModule": {
14263
+ "filename": "src/components/typedoc-config.ts",
14264
+ "line": 82
14265
+ },
14266
+ "name": "basePath",
14267
+ "optional": true,
14268
+ "type": {
14269
+ "primitive": "string"
14270
+ }
14271
+ },
14272
+ {
14273
+ "abstract": true,
14274
+ "docs": {
14275
+ "see": "https://typedoc.org/documents/Options.Output.html#cachebust",
14276
+ "stability": "stable",
14277
+ "summary": "Include the generation time in links to prevent browsers from using a cached version."
14278
+ },
14279
+ "immutable": true,
14280
+ "locationInModule": {
14281
+ "filename": "src/components/typedoc-config.ts",
14282
+ "line": 264
14283
+ },
14284
+ "name": "cacheBust",
14285
+ "optional": true,
14286
+ "type": {
14287
+ "primitive": "boolean"
14288
+ }
14289
+ },
14290
+ {
14291
+ "abstract": true,
14292
+ "docs": {
14293
+ "see": "https://typedoc.org/documents/Options.Organization.html#categorizebygroup",
14294
+ "stability": "stable",
14295
+ "summary": "Specify the categories that will be used to group reflections."
14296
+ },
14297
+ "immutable": true,
14298
+ "locationInModule": {
14299
+ "filename": "src/components/typedoc-config.ts",
14300
+ "line": 180
14301
+ },
14302
+ "name": "categorizeByGroup",
14303
+ "optional": true,
14304
+ "type": {
14305
+ "primitive": "boolean"
14306
+ }
14307
+ },
14308
+ {
14309
+ "abstract": true,
14310
+ "docs": {
14311
+ "see": "https://typedoc.org/documents/Options.Output.html#cleanoutputdir",
14312
+ "stability": "stable",
14313
+ "summary": "Prevent TypeDoc from cleaning the output directory specified with --out."
14314
+ },
14315
+ "immutable": true,
14316
+ "locationInModule": {
14317
+ "filename": "src/components/typedoc-config.ts",
14318
+ "line": 96
14319
+ },
14320
+ "name": "cleanOutputDir",
14321
+ "optional": true,
14322
+ "type": {
14323
+ "primitive": "boolean"
14324
+ }
14325
+ },
14326
+ {
14327
+ "abstract": true,
14328
+ "docs": {
14329
+ "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
14330
+ "stability": "stable",
14331
+ "summary": "Specify the documentation mode TypeDoc should use."
14332
+ },
14333
+ "immutable": true,
14334
+ "locationInModule": {
14335
+ "filename": "src/components/typedoc-config.ts",
14336
+ "line": 152
14337
+ },
14338
+ "name": "commentStyle",
14339
+ "optional": true,
14340
+ "type": {
14341
+ "fqn": "@nikovirtala/projen-constructs.CommentStyle"
14342
+ }
14343
+ },
14344
+ {
14345
+ "abstract": true,
14346
+ "docs": {
14347
+ "see": "https://typedoc.org/documents/Options.Organization.html#defaultcategory",
14348
+ "stability": "stable",
14349
+ "summary": "Specify the default category for reflections without a category."
14350
+ },
14351
+ "immutable": true,
14352
+ "locationInModule": {
14353
+ "filename": "src/components/typedoc-config.ts",
14354
+ "line": 166
14355
+ },
14356
+ "name": "defaultCategory",
14357
+ "optional": true,
14358
+ "type": {
14359
+ "primitive": "string"
14360
+ }
14361
+ },
14362
+ {
14363
+ "abstract": true,
14364
+ "docs": {
14365
+ "see": "https://typedoc.org/documents/Options.Organization.html#defaultgroup",
14366
+ "stability": "stable",
14367
+ "summary": "Specify the default group for reflections without a group."
14368
+ },
14369
+ "immutable": true,
14370
+ "locationInModule": {
14371
+ "filename": "src/components/typedoc-config.ts",
14372
+ "line": 173
14373
+ },
14374
+ "name": "defaultGroup",
14375
+ "optional": true,
14376
+ "type": {
14377
+ "primitive": "string"
14378
+ }
14379
+ },
14380
+ {
14381
+ "abstract": true,
14382
+ "docs": {
14383
+ "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
14384
+ "stability": "stable",
14385
+ "summary": "Specify the default visibility for members without a visibility tag."
14386
+ },
14387
+ "immutable": true,
14388
+ "locationInModule": {
14389
+ "filename": "src/components/typedoc-config.ts",
14390
+ "line": 159
14391
+ },
14392
+ "name": "defaultVisibility",
14393
+ "optional": true,
14394
+ "type": {
14395
+ "fqn": "@nikovirtala/projen-constructs.Visibility"
14396
+ }
14397
+ },
14398
+ {
14399
+ "abstract": true,
14400
+ "docs": {
14401
+ "see": "https://typedoc.org/documents/Options.Comments.html#disablegit",
14402
+ "stability": "stable",
14403
+ "summary": "Disables setting the source of reflections when documenting projects within a Git repository."
14404
+ },
14405
+ "immutable": true,
14406
+ "locationInModule": {
14407
+ "filename": "src/components/typedoc-config.ts",
14408
+ "line": 243
14409
+ },
14410
+ "name": "disableGit",
14411
+ "optional": true,
14412
+ "type": {
14413
+ "primitive": "boolean"
14414
+ }
14415
+ },
14416
+ {
14417
+ "abstract": true,
14418
+ "docs": {
14419
+ "see": "https://typedoc.org/documents/Options.Comments.html#disablesources",
14420
+ "stability": "stable",
14421
+ "summary": "Disables automatically linking to source code."
14422
+ },
14423
+ "immutable": true,
14424
+ "locationInModule": {
14425
+ "filename": "src/components/typedoc-config.ts",
14426
+ "line": 236
14427
+ },
14428
+ "name": "disableSources",
14429
+ "optional": true,
14430
+ "type": {
14431
+ "primitive": "boolean"
14432
+ }
14433
+ },
14434
+ {
14435
+ "abstract": true,
14436
+ "docs": {
14437
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypoints",
14438
+ "stability": "stable",
14439
+ "summary": "Specifies the entry points to be documented by TypeDoc."
14440
+ },
14441
+ "immutable": true,
14442
+ "locationInModule": {
14443
+ "filename": "src/components/typedoc-config.ts",
14444
+ "line": 12
14445
+ },
14446
+ "name": "entryPoints",
14447
+ "optional": true,
14448
+ "type": {
14449
+ "collection": {
14450
+ "elementtype": {
14451
+ "primitive": "string"
14452
+ },
14453
+ "kind": "array"
14454
+ }
14455
+ }
14456
+ },
14457
+ {
14458
+ "abstract": true,
14459
+ "docs": {
14460
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
14461
+ "stability": "stable",
14462
+ "summary": "Specifies the strategy to be used to convert entry points into documentation."
14463
+ },
14464
+ "immutable": true,
14465
+ "locationInModule": {
14466
+ "filename": "src/components/typedoc-config.ts",
14467
+ "line": 19
14468
+ },
14469
+ "name": "entryPointStrategy",
14470
+ "optional": true,
14471
+ "type": {
14472
+ "fqn": "@nikovirtala/projen-constructs.EntryPointStrategy"
14473
+ }
14474
+ },
14475
+ {
14476
+ "abstract": true,
14477
+ "docs": {
14478
+ "see": "https://typedoc.org/documents/Options.Input.html#exclude",
14479
+ "stability": "stable",
14480
+ "summary": "Define patterns to be excluded when expanding directories."
14481
+ },
14482
+ "immutable": true,
14483
+ "locationInModule": {
14484
+ "filename": "src/components/typedoc-config.ts",
14485
+ "line": 26
14486
+ },
14487
+ "name": "exclude",
14488
+ "optional": true,
14489
+ "type": {
14490
+ "collection": {
14491
+ "elementtype": {
14492
+ "primitive": "string"
14493
+ },
14494
+ "kind": "array"
14495
+ }
14496
+ }
14497
+ },
14498
+ {
14499
+ "abstract": true,
14500
+ "docs": {
14501
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeexternals",
14502
+ "stability": "stable",
14503
+ "summary": "Prevent externally resolved symbols from being documented."
14504
+ },
14505
+ "immutable": true,
14506
+ "locationInModule": {
14507
+ "filename": "src/components/typedoc-config.ts",
14508
+ "line": 33
14509
+ },
14510
+ "name": "excludeExternals",
14511
+ "optional": true,
14512
+ "type": {
14513
+ "primitive": "boolean"
14514
+ }
14515
+ },
14516
+ {
14517
+ "abstract": true,
14518
+ "docs": {
14519
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeinternal",
14520
+ "stability": "stable",
14521
+ "summary": "Prevent symbols that are not exported from being documented."
14522
+ },
14523
+ "immutable": true,
14524
+ "locationInModule": {
14525
+ "filename": "src/components/typedoc-config.ts",
14526
+ "line": 54
14527
+ },
14528
+ "name": "excludeInternal",
14529
+ "optional": true,
14530
+ "type": {
14531
+ "primitive": "boolean"
14532
+ }
14533
+ },
14534
+ {
14535
+ "abstract": true,
14536
+ "docs": {
14537
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeprivate",
14538
+ "stability": "stable",
14539
+ "summary": "Prevent private members from being included in the generated documentation."
14540
+ },
14541
+ "immutable": true,
14542
+ "locationInModule": {
14543
+ "filename": "src/components/typedoc-config.ts",
14544
+ "line": 40
14545
+ },
14546
+ "name": "excludePrivate",
14547
+ "optional": true,
14548
+ "type": {
14549
+ "primitive": "boolean"
14550
+ }
14551
+ },
14552
+ {
14553
+ "abstract": true,
14554
+ "docs": {
14555
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeprotected",
14556
+ "stability": "stable",
14557
+ "summary": "Prevent protected members from being included in the generated documentation."
14558
+ },
14559
+ "immutable": true,
14560
+ "locationInModule": {
14561
+ "filename": "src/components/typedoc-config.ts",
14562
+ "line": 47
14563
+ },
14564
+ "name": "excludeProtected",
14565
+ "optional": true,
14566
+ "type": {
14567
+ "primitive": "boolean"
14568
+ }
14569
+ },
14570
+ {
14571
+ "abstract": true,
14572
+ "docs": {
14573
+ "see": "https://typedoc.org/documents/Options.Input.html#externalpattern",
14574
+ "stability": "stable",
14575
+ "summary": "Define patterns for files that should be considered external."
14576
+ },
14577
+ "immutable": true,
14578
+ "locationInModule": {
14579
+ "filename": "src/components/typedoc-config.ts",
14580
+ "line": 320
14581
+ },
14582
+ "name": "externalPattern",
14583
+ "optional": true,
14584
+ "type": {
14585
+ "collection": {
14586
+ "elementtype": {
14587
+ "primitive": "string"
14588
+ },
14589
+ "kind": "array"
14590
+ }
14591
+ }
14592
+ },
14593
+ {
14594
+ "abstract": true,
14595
+ "docs": {
14596
+ "see": "https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings",
14597
+ "stability": "stable",
14598
+ "summary": "Define custom mappings for symbols in external packages."
14599
+ },
14600
+ "immutable": true,
14601
+ "locationInModule": {
14602
+ "filename": "src/components/typedoc-config.ts",
14603
+ "line": 327
14604
+ },
14605
+ "name": "externalSymbolLinkMappings",
14606
+ "optional": true,
14607
+ "type": {
14608
+ "collection": {
14609
+ "elementtype": {
14610
+ "collection": {
14611
+ "elementtype": {
14612
+ "primitive": "string"
14613
+ },
14614
+ "kind": "map"
14615
+ }
14616
+ },
14617
+ "kind": "map"
14618
+ }
14619
+ }
14620
+ },
14621
+ {
14622
+ "abstract": true,
14623
+ "docs": {
14624
+ "see": "https://typedoc.org/documents/Options.Comments.html#gitremote",
14625
+ "stability": "stable",
14626
+ "summary": "Specify the git remote that should be used to link to source files."
14627
+ },
14628
+ "immutable": true,
14629
+ "locationInModule": {
14630
+ "filename": "src/components/typedoc-config.ts",
14631
+ "line": 222
14632
+ },
14633
+ "name": "gitRemote",
14634
+ "optional": true,
14635
+ "type": {
14636
+ "primitive": "string"
14637
+ }
14638
+ },
14639
+ {
14640
+ "abstract": true,
14641
+ "docs": {
14642
+ "see": "https://typedoc.org/documents/Options.Comments.html#gitrevision",
14643
+ "stability": "stable",
14644
+ "summary": "Specify the git revision that should be used to link to source files."
14645
+ },
14646
+ "immutable": true,
14647
+ "locationInModule": {
14648
+ "filename": "src/components/typedoc-config.ts",
14649
+ "line": 215
14650
+ },
14651
+ "name": "gitRevision",
14652
+ "optional": true,
14653
+ "type": {
14654
+ "primitive": "string"
14655
+ }
14656
+ },
14657
+ {
14658
+ "abstract": true,
14659
+ "docs": {
14660
+ "see": "https://typedoc.org/documents/Options.Output.html#hidegenerator",
14661
+ "stability": "stable",
14662
+ "summary": "Do not print the TypeDoc link at the end of the page."
14663
+ },
14664
+ "immutable": true,
14665
+ "locationInModule": {
14666
+ "filename": "src/components/typedoc-config.ts",
14667
+ "line": 250
14668
+ },
14669
+ "name": "hideGenerator",
14670
+ "optional": true,
14671
+ "type": {
14672
+ "primitive": "boolean"
14673
+ }
14674
+ },
14675
+ {
14676
+ "abstract": true,
14677
+ "docs": {
14678
+ "see": "https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle",
14679
+ "stability": "stable",
14680
+ "summary": "Hide parameter types in the signature."
14681
+ },
14682
+ "immutable": true,
14683
+ "locationInModule": {
14684
+ "filename": "src/components/typedoc-config.ts",
14685
+ "line": 257
14686
+ },
14687
+ "name": "hideParameterTypesInTitle",
14688
+ "optional": true,
14689
+ "type": {
14690
+ "primitive": "boolean"
14691
+ }
14692
+ },
14693
+ {
14694
+ "abstract": true,
14695
+ "docs": {
14696
+ "see": "https://typedoc.org/documents/Options.Output.html#includes",
14697
+ "stability": "stable",
14698
+ "summary": "Specify the location to look for included documents."
14699
+ },
14700
+ "immutable": true,
14701
+ "locationInModule": {
14702
+ "filename": "src/components/typedoc-config.ts",
14703
+ "line": 103
14704
+ },
14705
+ "name": "includes",
14706
+ "optional": true,
14707
+ "type": {
14708
+ "primitive": "string"
14709
+ }
14710
+ },
14711
+ {
14712
+ "abstract": true,
14713
+ "docs": {
14714
+ "see": "https://typedoc.org/documents/Options.Validation.html#intentionallynotexported",
14715
+ "stability": "stable",
14716
+ "summary": "A list of types that should not produce warnings when not being exported."
14717
+ },
14718
+ "immutable": true,
14719
+ "locationInModule": {
14720
+ "filename": "src/components/typedoc-config.ts",
14721
+ "line": 313
14722
+ },
14723
+ "name": "intentionallyNotExported",
14724
+ "optional": true,
14725
+ "type": {
14726
+ "collection": {
14727
+ "elementtype": {
14728
+ "primitive": "string"
14729
+ },
14730
+ "kind": "array"
14731
+ }
14732
+ }
14733
+ },
14734
+ {
14735
+ "abstract": true,
14736
+ "docs": {
14737
+ "see": "https://typedoc.org/documents/Options.Output.html#json",
14738
+ "stability": "stable",
14739
+ "summary": "Specify the location the documentation should be written to."
14740
+ },
14741
+ "immutable": true,
14742
+ "locationInModule": {
14743
+ "filename": "src/components/typedoc-config.ts",
14744
+ "line": 68
14745
+ },
14746
+ "name": "json",
14747
+ "optional": true,
14748
+ "type": {
14749
+ "primitive": "string"
14750
+ }
14751
+ },
14752
+ {
14753
+ "abstract": true,
14754
+ "docs": {
14755
+ "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
14756
+ "stability": "stable",
14757
+ "summary": "Specify the logger that should be used."
14758
+ },
14759
+ "immutable": true,
14760
+ "locationInModule": {
14761
+ "filename": "src/components/typedoc-config.ts",
14762
+ "line": 131
14763
+ },
14764
+ "name": "logLevel",
14765
+ "optional": true,
14766
+ "type": {
14767
+ "fqn": "@nikovirtala/projen-constructs.LogLevel"
14768
+ }
14769
+ },
14770
+ {
14771
+ "abstract": true,
14772
+ "docs": {
14773
+ "see": "https://typedoc.org/documents/Options.Output.html#media",
14774
+ "stability": "stable",
14775
+ "summary": "Specify the location with media files that should be copied to the output directory."
14776
+ },
14777
+ "immutable": true,
14778
+ "locationInModule": {
14779
+ "filename": "src/components/typedoc-config.ts",
14780
+ "line": 110
14781
+ },
14782
+ "name": "media",
14783
+ "optional": true,
14784
+ "type": {
14785
+ "primitive": "string"
14786
+ }
14787
+ },
14788
+ {
14789
+ "abstract": true,
14790
+ "docs": {
14791
+ "see": "https://typedoc.org/documents/Options.Output.html#name",
14792
+ "stability": "stable",
14793
+ "summary": "Set the name of the project that will be used in the header of the template."
14794
+ },
14795
+ "immutable": true,
14796
+ "locationInModule": {
14797
+ "filename": "src/components/typedoc-config.ts",
14798
+ "line": 89
14799
+ },
14800
+ "name": "name",
14801
+ "optional": true,
14802
+ "type": {
14803
+ "primitive": "string"
14804
+ }
14805
+ },
14806
+ {
14807
+ "abstract": true,
14808
+ "docs": {
14809
+ "see": "https://typedoc.org/documents/Options.Output.html#out",
14810
+ "stability": "stable",
14811
+ "summary": "Specifies the output directory the documentation should be written to."
14812
+ },
14813
+ "immutable": true,
14814
+ "locationInModule": {
14815
+ "filename": "src/components/typedoc-config.ts",
14816
+ "line": 61
14817
+ },
14818
+ "name": "out",
14819
+ "optional": true,
14820
+ "type": {
14821
+ "primitive": "string"
14822
+ }
14823
+ },
14824
+ {
14825
+ "abstract": true,
14826
+ "docs": {
14827
+ "see": "https://typedoc.org/documents/Options.Input.html#packagejson",
14828
+ "stability": "stable",
14829
+ "summary": "Specify the package.json file that should be used to determine the package name."
14830
+ },
14831
+ "immutable": true,
14832
+ "locationInModule": {
14833
+ "filename": "src/components/typedoc-config.ts",
14834
+ "line": 208
14835
+ },
14836
+ "name": "packageJson",
14837
+ "optional": true,
14838
+ "type": {
14839
+ "primitive": "string"
14840
+ }
14841
+ },
14842
+ {
14843
+ "abstract": true,
14844
+ "docs": {
14845
+ "see": "https://typedoc.org/documents/Options.Input.html#readme",
14846
+ "stability": "stable",
14847
+ "summary": "Specify the readme file that should be displayed on the index page."
14848
+ },
14849
+ "immutable": true,
14850
+ "locationInModule": {
14851
+ "filename": "src/components/typedoc-config.ts",
14852
+ "line": 201
14853
+ },
14854
+ "name": "readme",
14855
+ "optional": true,
14856
+ "type": {
14857
+ "primitive": "string"
14858
+ }
14859
+ },
14860
+ {
14861
+ "abstract": true,
14862
+ "docs": {
14863
+ "see": "https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented",
14864
+ "stability": "stable",
14865
+ "summary": "Specify the type of reflections that must be documented."
14866
+ },
14867
+ "immutable": true,
14868
+ "locationInModule": {
14869
+ "filename": "src/components/typedoc-config.ts",
14870
+ "line": 292
14871
+ },
14872
+ "name": "requiredToBeDocumented",
14873
+ "optional": true,
14874
+ "type": {
14875
+ "collection": {
14876
+ "elementtype": {
14877
+ "primitive": "string"
14878
+ },
14879
+ "kind": "array"
14880
+ }
14881
+ }
14882
+ },
14883
+ {
14884
+ "abstract": true,
14885
+ "docs": {
14886
+ "see": "https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts",
14887
+ "stability": "stable",
14888
+ "summary": "Specify the search category boosts."
14889
+ },
14890
+ "immutable": true,
14891
+ "locationInModule": {
14892
+ "filename": "src/components/typedoc-config.ts",
14893
+ "line": 194
14894
+ },
14895
+ "name": "searchCategoryBoosts",
14896
+ "optional": true,
14897
+ "type": {
14898
+ "collection": {
14899
+ "elementtype": {
14900
+ "primitive": "number"
14901
+ },
14902
+ "kind": "map"
14903
+ }
14904
+ }
14905
+ },
14906
+ {
14907
+ "abstract": true,
14908
+ "docs": {
14909
+ "see": "https://typedoc.org/documents/Options.Organization.html#searchgroupboosts",
14910
+ "stability": "stable",
14911
+ "summary": "Specify the search group boosts."
14912
+ },
14913
+ "immutable": true,
14914
+ "locationInModule": {
14915
+ "filename": "src/components/typedoc-config.ts",
14916
+ "line": 187
14917
+ },
14918
+ "name": "searchGroupBoosts",
14919
+ "optional": true,
14920
+ "type": {
14921
+ "collection": {
14922
+ "elementtype": {
14923
+ "primitive": "number"
14924
+ },
14925
+ "kind": "map"
14926
+ }
14927
+ }
14928
+ },
14929
+ {
14930
+ "abstract": true,
14931
+ "docs": {
14932
+ "see": "https://typedoc.org/documents/Options.Output.html#searchincomments",
14933
+ "stability": "stable",
14934
+ "summary": "If set, the search index will also include comments."
14935
+ },
14936
+ "immutable": true,
14937
+ "locationInModule": {
14938
+ "filename": "src/components/typedoc-config.ts",
14939
+ "line": 271
14940
+ },
14941
+ "name": "searchInComments",
14942
+ "optional": true,
14943
+ "type": {
14944
+ "primitive": "boolean"
14945
+ }
14946
+ },
14947
+ {
14948
+ "abstract": true,
14949
+ "docs": {
14950
+ "see": "https://typedoc.org/documents/Options.Output.html#searchindocuments",
14951
+ "stability": "stable",
14952
+ "summary": "If set, the search index will also include documents."
14953
+ },
14954
+ "immutable": true,
14955
+ "locationInModule": {
14956
+ "filename": "src/components/typedoc-config.ts",
14957
+ "line": 278
14958
+ },
14959
+ "name": "searchInDocuments",
14960
+ "optional": true,
14961
+ "type": {
14962
+ "primitive": "boolean"
14963
+ }
14964
+ },
14965
+ {
14966
+ "abstract": true,
14967
+ "docs": {
14968
+ "see": "https://typedoc.org/documents/Options.Organization.html#sort",
14969
+ "stability": "stable",
14970
+ "summary": "Specify the sort strategy for documented values."
14971
+ },
14972
+ "immutable": true,
14973
+ "locationInModule": {
14974
+ "filename": "src/components/typedoc-config.ts",
14975
+ "line": 138
14976
+ },
14977
+ "name": "sort",
14978
+ "optional": true,
14979
+ "type": {
14980
+ "collection": {
14981
+ "elementtype": {
14982
+ "primitive": "string"
14983
+ },
14984
+ "kind": "array"
14985
+ }
14986
+ }
14987
+ },
14988
+ {
14989
+ "abstract": true,
14990
+ "docs": {
14991
+ "see": "https://typedoc.org/documents/Options.Organization.html#sortentrypoints",
14992
+ "stability": "stable",
14993
+ "summary": "Specify the sort strategy for static and instance members."
14994
+ },
14995
+ "immutable": true,
14996
+ "locationInModule": {
14997
+ "filename": "src/components/typedoc-config.ts",
14998
+ "line": 145
14999
+ },
15000
+ "name": "sortEntryPoints",
15001
+ "optional": true,
15002
+ "type": {
15003
+ "primitive": "boolean"
15004
+ }
15005
+ },
15006
+ {
15007
+ "abstract": true,
15008
+ "docs": {
15009
+ "see": "https://typedoc.org/documents/Options.Input.html#sourcelinktemplate",
15010
+ "stability": "stable",
15011
+ "summary": "Specify a link template to be used when generating source urls."
15012
+ },
15013
+ "immutable": true,
15014
+ "locationInModule": {
15015
+ "filename": "src/components/typedoc-config.ts",
15016
+ "line": 229
15017
+ },
15018
+ "name": "sourceLinkTemplate",
15019
+ "optional": true,
15020
+ "type": {
15021
+ "primitive": "string"
15022
+ }
15023
+ },
15024
+ {
15025
+ "abstract": true,
15026
+ "docs": {
15027
+ "see": "https://typedoc.org/documents/Options.Output.html#theme",
15028
+ "stability": "stable",
15029
+ "summary": "Specify a theme name to use."
15030
+ },
15031
+ "immutable": true,
15032
+ "locationInModule": {
15033
+ "filename": "src/components/typedoc-config.ts",
15034
+ "line": 75
15035
+ },
15036
+ "name": "theme",
15037
+ "optional": true,
15038
+ "type": {
15039
+ "primitive": "string"
15040
+ }
15041
+ },
15042
+ {
15043
+ "abstract": true,
15044
+ "docs": {
15045
+ "see": "https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors",
15046
+ "stability": "stable",
15047
+ "summary": "If set, validation warnings will be treated as errors."
15048
+ },
15049
+ "immutable": true,
15050
+ "locationInModule": {
15051
+ "filename": "src/components/typedoc-config.ts",
15052
+ "line": 306
15053
+ },
15054
+ "name": "treatValidationWarningsAsErrors",
15055
+ "optional": true,
15056
+ "type": {
15057
+ "primitive": "boolean"
15058
+ }
15059
+ },
15060
+ {
15061
+ "abstract": true,
15062
+ "docs": {
15063
+ "see": "https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors",
15064
+ "stability": "stable",
15065
+ "summary": "If set, warnings will be treated as errors."
15066
+ },
15067
+ "immutable": true,
15068
+ "locationInModule": {
15069
+ "filename": "src/components/typedoc-config.ts",
15070
+ "line": 299
15071
+ },
15072
+ "name": "treatWarningsAsErrors",
15073
+ "optional": true,
15074
+ "type": {
15075
+ "primitive": "boolean"
15076
+ }
15077
+ },
15078
+ {
15079
+ "abstract": true,
15080
+ "docs": {
15081
+ "see": "https://typedoc.org/documents/Options.Input.html#tsbuildinfo",
15082
+ "stability": "stable",
15083
+ "summary": "Specify the location and filename a .tsbuildinfo file should be written to."
15084
+ },
15085
+ "immutable": true,
15086
+ "locationInModule": {
15087
+ "filename": "src/components/typedoc-config.ts",
15088
+ "line": 117
13379
15089
  },
13380
- "name": "workflowRunsOnGroup",
15090
+ "name": "tsBuildInfo",
13381
15091
  "optional": true,
13382
15092
  "type": {
13383
- "fqn": "projen.GroupRunnerOptions"
15093
+ "primitive": "string"
13384
15094
  }
13385
15095
  },
13386
15096
  {
13387
15097
  "abstract": true,
13388
15098
  "docs": {
13389
- "default": "- Yarn Berry v4 with all default options",
13390
- "stability": "experimental",
13391
- "summary": "Options for Yarn Berry."
15099
+ "see": "https://typedoc.org/documents/Options.Input.html#tsconfig",
15100
+ "stability": "stable",
15101
+ "summary": "Specify a TypeScript config file that should be used to load TypeScript configuration."
13392
15102
  },
13393
15103
  "immutable": true,
13394
15104
  "locationInModule": {
13395
- "filename": "src/projects/jsii-options.generated.ts",
13396
- "line": 607
15105
+ "filename": "src/components/typedoc-config.ts",
15106
+ "line": 124
13397
15107
  },
13398
- "name": "yarnBerryOptions",
15108
+ "name": "tsconfig",
13399
15109
  "optional": true,
13400
15110
  "type": {
13401
- "fqn": "projen.javascript.YarnBerryOptions"
15111
+ "primitive": "string"
13402
15112
  }
13403
- }
13404
- ],
13405
- "symbolId": "src/projects/jsii-options.generated:JsiiProjectOptions"
13406
- },
13407
- "@nikovirtala/projen-constructs.Pool": {
13408
- "assembly": "@nikovirtala/projen-constructs",
13409
- "docs": {
13410
- "stability": "stable"
13411
- },
13412
- "fqn": "@nikovirtala/projen-constructs.Pool",
13413
- "kind": "enum",
13414
- "locationInModule": {
13415
- "filename": "src/components/vitest.ts",
13416
- "line": 14
13417
- },
13418
- "members": [
13419
- {
13420
- "docs": {
13421
- "stability": "stable"
13422
- },
13423
- "name": "FORKS"
13424
- },
13425
- {
13426
- "docs": {
13427
- "stability": "stable"
13428
- },
13429
- "name": "THREADS"
13430
15113
  },
13431
15114
  {
15115
+ "abstract": true,
13432
15116
  "docs": {
13433
- "stability": "stable"
15117
+ "see": "https://typedoc.org/documents/Options.Validation.html",
15118
+ "stability": "stable",
15119
+ "summary": "Specify validation options."
13434
15120
  },
13435
- "name": "VMFORKS"
13436
- },
13437
- {
13438
- "docs": {
13439
- "stability": "stable"
15121
+ "immutable": true,
15122
+ "locationInModule": {
15123
+ "filename": "src/components/typedoc-config.ts",
15124
+ "line": 285
13440
15125
  },
13441
- "name": "VMTHREADS"
15126
+ "name": "validation",
15127
+ "optional": true,
15128
+ "type": {
15129
+ "fqn": "@nikovirtala/projen-constructs.ValidationOptions"
15130
+ }
13442
15131
  }
13443
15132
  ],
13444
- "name": "Pool",
13445
- "symbolId": "src/components/vitest:Pool"
15133
+ "symbolId": "src/components/typedoc-config:TypeDocConfiguration"
13446
15134
  },
13447
- "@nikovirtala/projen-constructs.ProjectType": {
15135
+ "@nikovirtala/projen-constructs.TypeDocOptions": {
13448
15136
  "assembly": "@nikovirtala/projen-constructs",
15137
+ "datatype": true,
13449
15138
  "docs": {
13450
- "remarks": "Each project type corresponds to a generated project class and its configuration\nin the defaultOptions structure.",
13451
- "stability": "stable",
13452
- "summary": "Enum defining all supported project types."
15139
+ "stability": "stable"
13453
15140
  },
13454
- "fqn": "@nikovirtala/projen-constructs.ProjectType",
13455
- "kind": "enum",
15141
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions",
15142
+ "kind": "interface",
13456
15143
  "locationInModule": {
13457
- "filename": "src/project-type.ts",
13458
- "line": 7
15144
+ "filename": "src/components/typedoc.ts",
15145
+ "line": 20
13459
15146
  },
13460
- "members": [
15147
+ "name": "TypeDocOptions",
15148
+ "properties": [
13461
15149
  {
15150
+ "abstract": true,
13462
15151
  "docs": {
13463
- "see": "https://projen.io/docs/api/typescript#typescriptproject-",
15152
+ "remarks": "This configuration will be merged with the default configuration",
13464
15153
  "stability": "stable",
13465
- "summary": "TypeScript project with ES modules support."
15154
+ "summary": "Full TypeDoc configuration."
13466
15155
  },
13467
- "name": "TYPESCRIPT"
13468
- },
13469
- {
13470
- "docs": {
13471
- "see": "https://projen.io/docs/api/cdk#jsiiproject-",
13472
- "stability": "stable",
13473
- "summary": "JSII project for publishing multi-language libraries."
15156
+ "immutable": true,
15157
+ "locationInModule": {
15158
+ "filename": "src/components/typedoc.ts",
15159
+ "line": 33
13474
15160
  },
13475
- "name": "JSII"
15161
+ "name": "typeDocConfig",
15162
+ "optional": true,
15163
+ "type": {
15164
+ "fqn": "@nikovirtala/projen-constructs.TypeDocConfiguration"
15165
+ }
13476
15166
  },
13477
15167
  {
15168
+ "abstract": true,
13478
15169
  "docs": {
13479
- "see": "https://projen.io/docs/api/awscdk#awscdktypescriptapp-",
15170
+ "default": "\"^0.28\"",
13480
15171
  "stability": "stable",
13481
- "summary": "AWS CDK TypeScript application project with ES modules support."
15172
+ "summary": "Version of TypeDoc to use."
13482
15173
  },
13483
- "name": "AWS_CDK_TYPESCRIPT_APP"
13484
- },
13485
- {
13486
- "docs": {
13487
- "see": "https://projen.io/docs/api/awscdk/#awscdkconstructlibrary-",
13488
- "stability": "stable",
13489
- "summary": "AWS CDK construct library project for publishing reusable constructs."
15174
+ "immutable": true,
15175
+ "locationInModule": {
15176
+ "filename": "src/components/typedoc.ts",
15177
+ "line": 26
13490
15178
  },
13491
- "name": "AWS_CDK_CONSTRUCT_LIBRARY"
15179
+ "name": "version",
15180
+ "optional": true,
15181
+ "type": {
15182
+ "primitive": "string"
15183
+ }
13492
15184
  }
13493
15185
  ],
13494
- "name": "ProjectType",
13495
- "symbolId": "src/project-type:ProjectType"
15186
+ "symbolId": "src/components/typedoc:TypeDocOptions"
13496
15187
  },
13497
15188
  "@nikovirtala/projen-constructs.TypeScriptProject": {
13498
15189
  "assembly": "@nikovirtala/projen-constructs",
@@ -13509,7 +15200,7 @@
13509
15200
  },
13510
15201
  "locationInModule": {
13511
15202
  "filename": "src/projects/typescript.generated.ts",
13512
- "line": 22
15203
+ "line": 20
13513
15204
  },
13514
15205
  "parameters": [
13515
15206
  {
@@ -13526,7 +15217,7 @@
13526
15217
  "kind": "class",
13527
15218
  "locationInModule": {
13528
15219
  "filename": "src/projects/typescript.generated.ts",
13529
- "line": 18
15220
+ "line": 16
13530
15221
  },
13531
15222
  "name": "TypeScriptProject",
13532
15223
  "symbolId": "src/projects/typescript.generated:TypeScriptProject"
@@ -16153,6 +17844,115 @@
16153
17844
  ],
16154
17845
  "symbolId": "src/projects/typescript-options.generated:TypeScriptProjectOptions"
16155
17846
  },
17847
+ "@nikovirtala/projen-constructs.ValidationOptions": {
17848
+ "assembly": "@nikovirtala/projen-constructs",
17849
+ "datatype": true,
17850
+ "docs": {
17851
+ "see": "https://typedoc.org/documents/Options.Validation.html",
17852
+ "stability": "stable",
17853
+ "summary": "Validation options."
17854
+ },
17855
+ "fqn": "@nikovirtala/projen-constructs.ValidationOptions",
17856
+ "kind": "interface",
17857
+ "locationInModule": {
17858
+ "filename": "src/components/typedoc-config.ts",
17859
+ "line": 498
17860
+ },
17861
+ "name": "ValidationOptions",
17862
+ "properties": [
17863
+ {
17864
+ "abstract": true,
17865
+ "docs": {
17866
+ "stability": "stable",
17867
+ "summary": "If set, TypeDoc will produce warnings about \\@link tags which will produce broken links."
17868
+ },
17869
+ "immutable": true,
17870
+ "locationInModule": {
17871
+ "filename": "src/components/typedoc-config.ts",
17872
+ "line": 510
17873
+ },
17874
+ "name": "invalidLink",
17875
+ "optional": true,
17876
+ "type": {
17877
+ "primitive": "boolean"
17878
+ }
17879
+ },
17880
+ {
17881
+ "abstract": true,
17882
+ "docs": {
17883
+ "stability": "stable",
17884
+ "summary": "If set, TypeDoc will produce warnings when an exported symbol is not documented."
17885
+ },
17886
+ "immutable": true,
17887
+ "locationInModule": {
17888
+ "filename": "src/components/typedoc-config.ts",
17889
+ "line": 506
17890
+ },
17891
+ "name": "notDocumented",
17892
+ "optional": true,
17893
+ "type": {
17894
+ "primitive": "boolean"
17895
+ }
17896
+ },
17897
+ {
17898
+ "abstract": true,
17899
+ "docs": {
17900
+ "stability": "stable",
17901
+ "summary": "If set, TypeDoc will produce warnings when a symbol is referenced by the documentation."
17902
+ },
17903
+ "immutable": true,
17904
+ "locationInModule": {
17905
+ "filename": "src/components/typedoc-config.ts",
17906
+ "line": 502
17907
+ },
17908
+ "name": "notExported",
17909
+ "optional": true,
17910
+ "type": {
17911
+ "primitive": "boolean"
17912
+ }
17913
+ }
17914
+ ],
17915
+ "symbolId": "src/components/typedoc-config:ValidationOptions"
17916
+ },
17917
+ "@nikovirtala/projen-constructs.Visibility": {
17918
+ "assembly": "@nikovirtala/projen-constructs",
17919
+ "docs": {
17920
+ "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
17921
+ "stability": "stable",
17922
+ "summary": "Specifies the default visibility for members without a visibility tag."
17923
+ },
17924
+ "fqn": "@nikovirtala/projen-constructs.Visibility",
17925
+ "kind": "enum",
17926
+ "locationInModule": {
17927
+ "filename": "src/components/typedoc-config.ts",
17928
+ "line": 478
17929
+ },
17930
+ "members": [
17931
+ {
17932
+ "docs": {
17933
+ "stability": "stable",
17934
+ "summary": "Public visibility - accessible from anywhere."
17935
+ },
17936
+ "name": "PUBLIC"
17937
+ },
17938
+ {
17939
+ "docs": {
17940
+ "stability": "stable",
17941
+ "summary": "Protected visibility - accessible from class and subclasses."
17942
+ },
17943
+ "name": "PROTECTED"
17944
+ },
17945
+ {
17946
+ "docs": {
17947
+ "stability": "stable",
17948
+ "summary": "Private visibility - accessible only within the class."
17949
+ },
17950
+ "name": "PRIVATE"
17951
+ }
17952
+ ],
17953
+ "name": "Visibility",
17954
+ "symbolId": "src/components/typedoc-config:Visibility"
17955
+ },
16156
17956
  "@nikovirtala/projen-constructs.Vitest": {
16157
17957
  "assembly": "@nikovirtala/projen-constructs",
16158
17958
  "base": "projen.Component",
@@ -16166,7 +17966,7 @@
16166
17966
  },
16167
17967
  "locationInModule": {
16168
17968
  "filename": "src/components/vitest.ts",
16169
- "line": 88
17969
+ "line": 315
16170
17970
  },
16171
17971
  "parameters": [
16172
17972
  {
@@ -16187,7 +17987,7 @@
16187
17987
  "kind": "class",
16188
17988
  "locationInModule": {
16189
17989
  "filename": "src/components/vitest.ts",
16190
- "line": 61
17990
+ "line": 288
16191
17991
  },
16192
17992
  "methods": [
16193
17993
  {
@@ -16196,7 +17996,7 @@
16196
17996
  },
16197
17997
  "locationInModule": {
16198
17998
  "filename": "src/components/vitest.ts",
16199
- "line": 62
17999
+ "line": 289
16200
18000
  },
16201
18001
  "name": "of",
16202
18002
  "parameters": [
@@ -16221,7 +18021,7 @@
16221
18021
  },
16222
18022
  "locationInModule": {
16223
18023
  "filename": "src/components/vitest.ts",
16224
- "line": 150
18024
+ "line": 377
16225
18025
  },
16226
18026
  "name": "addExclude",
16227
18027
  "parameters": [
@@ -16239,7 +18039,7 @@
16239
18039
  },
16240
18040
  "locationInModule": {
16241
18041
  "filename": "src/components/vitest.ts",
16242
- "line": 145
18042
+ "line": 372
16243
18043
  },
16244
18044
  "name": "addInclude",
16245
18045
  "parameters": [
@@ -16257,7 +18057,7 @@
16257
18057
  },
16258
18058
  "locationInModule": {
16259
18059
  "filename": "src/components/vitest.ts",
16260
- "line": 160
18060
+ "line": 387
16261
18061
  },
16262
18062
  "name": "configureCoverageProvider",
16263
18063
  "parameters": [
@@ -16275,7 +18075,7 @@
16275
18075
  },
16276
18076
  "locationInModule": {
16277
18077
  "filename": "src/components/vitest.ts",
16278
- "line": 179
18078
+ "line": 406
16279
18079
  },
16280
18080
  "name": "configureCoverageReporters",
16281
18081
  "parameters": [
@@ -16298,7 +18098,7 @@
16298
18098
  },
16299
18099
  "locationInModule": {
16300
18100
  "filename": "src/components/vitest.ts",
16301
- "line": 155
18101
+ "line": 382
16302
18102
  },
16303
18103
  "name": "configureEnvironment",
16304
18104
  "parameters": [
@@ -16316,7 +18116,7 @@
16316
18116
  },
16317
18117
  "locationInModule": {
16318
18118
  "filename": "src/components/vitest.ts",
16319
- "line": 184
18119
+ "line": 411
16320
18120
  },
16321
18121
  "name": "configureGlobals"
16322
18122
  },
@@ -16327,7 +18127,7 @@
16327
18127
  },
16328
18128
  "locationInModule": {
16329
18129
  "filename": "src/components/vitest.ts",
16330
- "line": 135
18130
+ "line": 362
16331
18131
  },
16332
18132
  "name": "preSynthesize",
16333
18133
  "overrides": "projen.Component"
@@ -16340,25 +18140,30 @@
16340
18140
  "assembly": "@nikovirtala/projen-constructs",
16341
18141
  "datatype": true,
16342
18142
  "docs": {
16343
- "stability": "stable"
18143
+ "see": "https://vitest.dev/config/",
18144
+ "stability": "stable",
18145
+ "summary": "Vitest Config."
16344
18146
  },
16345
18147
  "fqn": "@nikovirtala/projen-constructs.VitestConfigOptions",
16346
18148
  "kind": "interface",
16347
18149
  "locationInModule": {
16348
18150
  "filename": "src/components/vitest.ts",
16349
- "line": 34
18151
+ "line": 120
16350
18152
  },
16351
18153
  "name": "VitestConfigOptions",
16352
18154
  "properties": [
16353
18155
  {
16354
18156
  "abstract": true,
16355
18157
  "docs": {
16356
- "stability": "stable"
18158
+ "default": "0",
18159
+ "see": "https://vitest.dev/config/#bail",
18160
+ "stability": "stable",
18161
+ "summary": "Stop running tests after certain number of failures."
16357
18162
  },
16358
18163
  "immutable": true,
16359
18164
  "locationInModule": {
16360
18165
  "filename": "src/components/vitest.ts",
16361
- "line": 49
18166
+ "line": 240
16362
18167
  },
16363
18168
  "name": "bail",
16364
18169
  "optional": true,
@@ -16369,12 +18174,14 @@
16369
18174
  {
16370
18175
  "abstract": true,
16371
18176
  "docs": {
16372
- "stability": "stable"
18177
+ "default": "\"coverage\"",
18178
+ "stability": "stable",
18179
+ "summary": "Coverage output directory."
16373
18180
  },
16374
18181
  "immutable": true,
16375
18182
  "locationInModule": {
16376
18183
  "filename": "src/components/vitest.ts",
16377
- "line": 44
18184
+ "line": 200
16378
18185
  },
16379
18186
  "name": "coverageDirectory",
16380
18187
  "optional": true,
@@ -16385,12 +18192,15 @@
16385
18192
  {
16386
18193
  "abstract": true,
16387
18194
  "docs": {
16388
- "stability": "stable"
18195
+ "default": "true",
18196
+ "see": "https://vitest.dev/config/#coverage-enabled",
18197
+ "stability": "stable",
18198
+ "summary": "Coverage enabled."
16389
18199
  },
16390
18200
  "immutable": true,
16391
18201
  "locationInModule": {
16392
18202
  "filename": "src/components/vitest.ts",
16393
- "line": 41
18203
+ "line": 177
16394
18204
  },
16395
18205
  "name": "coverageEnabled",
16396
18206
  "optional": true,
@@ -16401,12 +18211,15 @@
16401
18211
  {
16402
18212
  "abstract": true,
16403
18213
  "docs": {
16404
- "stability": "stable"
18214
+ "default": "\"v8\"",
18215
+ "see": "https://vitest.dev/config/#coverage-provider",
18216
+ "stability": "stable",
18217
+ "summary": "Coverage provider type."
16405
18218
  },
16406
18219
  "immutable": true,
16407
18220
  "locationInModule": {
16408
18221
  "filename": "src/components/vitest.ts",
16409
- "line": 42
18222
+ "line": 185
16410
18223
  },
16411
18224
  "name": "coverageProvider",
16412
18225
  "optional": true,
@@ -16417,12 +18230,15 @@
16417
18230
  {
16418
18231
  "abstract": true,
16419
18232
  "docs": {
16420
- "stability": "stable"
18233
+ "default": "'[\"text\", \"lcov\"]'",
18234
+ "see": "https://vitest.dev/config/#coverage-reporter",
18235
+ "stability": "stable",
18236
+ "summary": "Coverage reporters."
16421
18237
  },
16422
18238
  "immutable": true,
16423
18239
  "locationInModule": {
16424
18240
  "filename": "src/components/vitest.ts",
16425
- "line": 43
18241
+ "line": 193
16426
18242
  },
16427
18243
  "name": "coverageReporters",
16428
18244
  "optional": true,
@@ -16438,12 +18254,15 @@
16438
18254
  {
16439
18255
  "abstract": true,
16440
18256
  "docs": {
16441
- "stability": "stable"
18257
+ "default": "\"node\"",
18258
+ "see": "https://vitest.dev/config/#environment",
18259
+ "stability": "stable",
18260
+ "summary": "The environment that will be used for testing."
16442
18261
  },
16443
18262
  "immutable": true,
16444
18263
  "locationInModule": {
16445
18264
  "filename": "src/components/vitest.ts",
16446
- "line": 37
18265
+ "line": 143
16447
18266
  },
16448
18267
  "name": "environment",
16449
18268
  "optional": true,
@@ -16454,12 +18273,15 @@
16454
18273
  {
16455
18274
  "abstract": true,
16456
18275
  "docs": {
16457
- "stability": "stable"
18276
+ "default": "- Vitest's `configDefaults.exclude`",
18277
+ "see": "https://vitest.dev/config/#exclude",
18278
+ "stability": "stable",
18279
+ "summary": "A list of glob patterns that should be excluded from your test files."
16458
18280
  },
16459
18281
  "immutable": true,
16460
18282
  "locationInModule": {
16461
18283
  "filename": "src/components/vitest.ts",
16462
- "line": 36
18284
+ "line": 135
16463
18285
  },
16464
18286
  "name": "exclude",
16465
18287
  "optional": true,
@@ -16475,12 +18297,16 @@
16475
18297
  {
16476
18298
  "abstract": true,
16477
18299
  "docs": {
16478
- "stability": "stable"
18300
+ "default": "false",
18301
+ "remarks": "If you prefer to use the APIs globally like Jest, set to `true`.",
18302
+ "see": "https://vitest.dev/config/#globals",
18303
+ "stability": "stable",
18304
+ "summary": "Register apis globally."
16479
18305
  },
16480
18306
  "immutable": true,
16481
18307
  "locationInModule": {
16482
18308
  "filename": "src/components/vitest.ts",
16483
- "line": 40
18309
+ "line": 169
16484
18310
  },
16485
18311
  "name": "globals",
16486
18312
  "optional": true,
@@ -16491,12 +18317,15 @@
16491
18317
  {
16492
18318
  "abstract": true,
16493
18319
  "docs": {
16494
- "stability": "stable"
18320
+ "default": "- Vitest's `configDefaults.include`",
18321
+ "see": "https://vitest.dev/config/#include",
18322
+ "stability": "stable",
18323
+ "summary": "A list of glob patterns that match your test files."
16495
18324
  },
16496
18325
  "immutable": true,
16497
18326
  "locationInModule": {
16498
18327
  "filename": "src/components/vitest.ts",
16499
- "line": 35
18328
+ "line": 127
16500
18329
  },
16501
18330
  "name": "include",
16502
18331
  "optional": true,
@@ -16512,12 +18341,16 @@
16512
18341
  {
16513
18342
  "abstract": true,
16514
18343
  "docs": {
16515
- "stability": "stable"
18344
+ "default": "true",
18345
+ "remarks": "Disabling this option might improve performance if your code doesn't rely on side effects.",
18346
+ "see": "https://vitest.dev/config/#isolate",
18347
+ "stability": "stable",
18348
+ "summary": "Run tests in an isolated environment. This option has no effect on vmThreads pool."
16516
18349
  },
16517
18350
  "immutable": true,
16518
18351
  "locationInModule": {
16519
18352
  "filename": "src/components/vitest.ts",
16520
- "line": 38
18353
+ "line": 153
16521
18354
  },
16522
18355
  "name": "isolate",
16523
18356
  "optional": true,
@@ -16528,12 +18361,15 @@
16528
18361
  {
16529
18362
  "abstract": true,
16530
18363
  "docs": {
16531
- "stability": "stable"
18364
+ "default": "true",
18365
+ "see": "https://vitest.dev/config/#passwithnotests",
18366
+ "stability": "stable",
18367
+ "summary": "Vitest will not fail, if no tests will be found."
16532
18368
  },
16533
18369
  "immutable": true,
16534
18370
  "locationInModule": {
16535
18371
  "filename": "src/components/vitest.ts",
16536
- "line": 48
18372
+ "line": 232
16537
18373
  },
16538
18374
  "name": "passWithNoTests",
16539
18375
  "optional": true,
@@ -16544,12 +18380,15 @@
16544
18380
  {
16545
18381
  "abstract": true,
16546
18382
  "docs": {
16547
- "stability": "stable"
18383
+ "default": "\"forks\"",
18384
+ "see": "https://vitest.dev/config/#pool",
18385
+ "stability": "stable",
18386
+ "summary": "Pool used to run tests in."
16548
18387
  },
16549
18388
  "immutable": true,
16550
18389
  "locationInModule": {
16551
18390
  "filename": "src/components/vitest.ts",
16552
- "line": 39
18391
+ "line": 161
16553
18392
  },
16554
18393
  "name": "pool",
16555
18394
  "optional": true,
@@ -16560,12 +18399,15 @@
16560
18399
  {
16561
18400
  "abstract": true,
16562
18401
  "docs": {
16563
- "stability": "stable"
18402
+ "default": "true",
18403
+ "see": "https://vitest.dev/config/#consoletrace",
18404
+ "stability": "stable",
18405
+ "summary": "Always print console traces when calling any console method."
16564
18406
  },
16565
18407
  "immutable": true,
16566
18408
  "locationInModule": {
16567
18409
  "filename": "src/components/vitest.ts",
16568
- "line": 51
18410
+ "line": 256
16569
18411
  },
16570
18412
  "name": "printConsoleTrace",
16571
18413
  "optional": true,
@@ -16576,12 +18418,15 @@
16576
18418
  {
16577
18419
  "abstract": true,
16578
18420
  "docs": {
16579
- "stability": "stable"
18421
+ "default": "300",
18422
+ "see": "https://vitest.dev/config/#slowtestthreshold",
18423
+ "stability": "stable",
18424
+ "summary": "The number of milliseconds after which a test or suite is considered slow."
16580
18425
  },
16581
18426
  "immutable": true,
16582
18427
  "locationInModule": {
16583
18428
  "filename": "src/components/vitest.ts",
16584
- "line": 52
18429
+ "line": 264
16585
18430
  },
16586
18431
  "name": "slowTestThreshold",
16587
18432
  "optional": true,
@@ -16592,12 +18437,16 @@
16592
18437
  {
16593
18438
  "abstract": true,
16594
18439
  "docs": {
16595
- "stability": "stable"
18440
+ "default": "\"tsc --noEmit\"",
18441
+ "remarks": "Checker should implement the same output format as `tsc`.",
18442
+ "see": "https://vitest.dev/config/#typecheck-checker",
18443
+ "stability": "stable",
18444
+ "summary": "Tool to use for type checking."
16596
18445
  },
16597
18446
  "immutable": true,
16598
18447
  "locationInModule": {
16599
18448
  "filename": "src/components/vitest.ts",
16600
- "line": 46
18449
+ "line": 216
16601
18450
  },
16602
18451
  "name": "typecheckChecker",
16603
18452
  "optional": true,
@@ -16608,12 +18457,15 @@
16608
18457
  {
16609
18458
  "abstract": true,
16610
18459
  "docs": {
16611
- "stability": "stable"
18460
+ "default": "true (for TypeScript projects)",
18461
+ "see": "https://vitest.dev/config/#typecheck-enabled",
18462
+ "stability": "stable",
18463
+ "summary": "Enable typechecking alongside your regular tests."
16612
18464
  },
16613
18465
  "immutable": true,
16614
18466
  "locationInModule": {
16615
18467
  "filename": "src/components/vitest.ts",
16616
- "line": 45
18468
+ "line": 208
16617
18469
  },
16618
18470
  "name": "typecheckEnabled",
16619
18471
  "optional": true,
@@ -16624,12 +18476,15 @@
16624
18476
  {
16625
18477
  "abstract": true,
16626
18478
  "docs": {
16627
- "stability": "stable"
18479
+ "default": "\"tsconfig.dev.json\"",
18480
+ "see": "https://vitest.dev/config/#typecheck-tsconfig",
18481
+ "stability": "stable",
18482
+ "summary": "Path to custom tsconfig, relative to the project root."
16628
18483
  },
16629
18484
  "immutable": true,
16630
18485
  "locationInModule": {
16631
18486
  "filename": "src/components/vitest.ts",
16632
- "line": 47
18487
+ "line": 224
16633
18488
  },
16634
18489
  "name": "typecheckTsconfig",
16635
18490
  "optional": true,
@@ -16640,12 +18495,16 @@
16640
18495
  {
16641
18496
  "abstract": true,
16642
18497
  "docs": {
16643
- "stability": "stable"
18498
+ "default": "true",
18499
+ "remarks": "This will update all changed snapshots and delete obsolete ones.",
18500
+ "see": "https://vitest.dev/guide/snapshot.html#updating-snapshots",
18501
+ "stability": "stable",
18502
+ "summary": "Update snapshot files."
16644
18503
  },
16645
18504
  "immutable": true,
16646
18505
  "locationInModule": {
16647
18506
  "filename": "src/components/vitest.ts",
16648
- "line": 50
18507
+ "line": 248
16649
18508
  },
16650
18509
  "name": "updateSnapshots",
16651
18510
  "optional": true,
@@ -16666,19 +18525,20 @@
16666
18525
  "kind": "interface",
16667
18526
  "locationInModule": {
16668
18527
  "filename": "src/components/vitest.ts",
16669
- "line": 55
18528
+ "line": 267
16670
18529
  },
16671
18530
  "name": "VitestOptions",
16672
18531
  "properties": [
16673
18532
  {
16674
18533
  "abstract": true,
16675
18534
  "docs": {
16676
- "stability": "stable"
18535
+ "stability": "stable",
18536
+ "summary": "Initial config options."
16677
18537
  },
16678
18538
  "immutable": true,
16679
18539
  "locationInModule": {
16680
18540
  "filename": "src/components/vitest.ts",
16681
- "line": 57
18541
+ "line": 278
16682
18542
  },
16683
18543
  "name": "config",
16684
18544
  "optional": true,
@@ -16689,12 +18549,14 @@
16689
18549
  {
16690
18550
  "abstract": true,
16691
18551
  "docs": {
16692
- "stability": "stable"
18552
+ "default": "\"vitest.config.ts\"",
18553
+ "stability": "stable",
18554
+ "summary": "Config file path."
16693
18555
  },
16694
18556
  "immutable": true,
16695
18557
  "locationInModule": {
16696
18558
  "filename": "src/components/vitest.ts",
16697
- "line": 56
18559
+ "line": 273
16698
18560
  },
16699
18561
  "name": "configFilePath",
16700
18562
  "optional": true,
@@ -16705,12 +18567,14 @@
16705
18567
  {
16706
18568
  "abstract": true,
16707
18569
  "docs": {
16708
- "stability": "stable"
18570
+ "default": "\"^4\"",
18571
+ "stability": "stable",
18572
+ "summary": "Vitest version."
16709
18573
  },
16710
18574
  "immutable": true,
16711
18575
  "locationInModule": {
16712
18576
  "filename": "src/components/vitest.ts",
16713
- "line": 58
18577
+ "line": 285
16714
18578
  },
16715
18579
  "name": "vitestVersion",
16716
18580
  "optional": true,
@@ -16722,6 +18586,6 @@
16722
18586
  "symbolId": "src/components/vitest:VitestOptions"
16723
18587
  }
16724
18588
  },
16725
- "version": "0.1.8",
16726
- "fingerprint": "AuVCeOtv0O0ZLGVa6UBbewG7QH3rHriJ2CXjqE/uIpk="
18589
+ "version": "0.2.1",
18590
+ "fingerprint": "MmJoALhvzUbdxIS5uwcMqwuIdmw3FXeDKbXv6f4v3ao="
16727
18591
  }