@nikovirtala/projen-typedoc 0.0.0 → 1.0.0

package/.jsii

@@ -94,7 +94,7 @@
   },
   "name": "@nikovirtala/projen-typedoc",
   "readme": {
-    "markdown": "# projen-typedoc\n\nTypeDoc component for projen projects.\n\n## Installation\n\n```bash\nnpm install @nikovirtala/projen-typedoc\n```\n\n## Usage\n\nAdd the TypeDoc component to your projen project:\n\n```typescript\nimport { TypeDoc } from \"@nikovirtala/projen-typedoc\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n  name: \"my-project\",\n  defaultReleaseBranch: \"main\",\n});\n\nnew TypeDoc(project);\n\nproject.synth();\n```\n\n## Configuration\n\nCustomize TypeDoc configuration:\n\n```typescript\nimport { EntryPointStrategy, TypeDoc } from \"@nikovirtala/projen-typedoc\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n  name: \"my-project\",\n  defaultReleaseBranch: \"main\",\n});\n\nnew TypeDoc(project, {\n  version: \"^0.28\",\n  typeDocConfig: {\n    entryPointStrategy: EntryPointStrategy.EXPAND,\n    out: \"docs/api\",\n    exclude: [\"**/*.test.ts\"],\n    excludePrivate: true,\n    name: \"My Project\",\n    theme: \"default\",\n  },\n});\n\nproject.synth();\n```\n\n## Features\n\n- Automatically installs TypeDoc as a dev dependency\n- Creates `typedoc.jsonc` configuration file\n- Adds `typedoc` task to generate documentation\n- Supports all TypeDoc configuration options\n\n## Tasks\n\nThe component creates the following task:\n\n- `typedoc` - Generate TypeDoc documentation\n\n## License\n\nMIT\n"
+    "markdown": "# projen-typedoc\n\nTypeDoc component for projen projects.\n\n## Installation\n\n```bash\nnpm install @nikovirtala/projen-typedoc\n```\n\n## Usage\n\nAdd the TypeDoc component to your projen project:\n\n```typescript\nimport { TypeDoc } from \"@nikovirtala/projen-typedoc\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n  name: \"my-project\",\n  defaultReleaseBranch: \"main\",\n});\n\nnew TypeDoc(project);\n\nproject.synth();\n```\n\n## Default Configuration\n\nThe component uses the following default configuration:\n\n- `entryPointStrategy`: `expand` - Expects all entry points to be top-level directories\n- `out`: `docs/api` - Output directory for generated documentation\n- `exclude`: `[\"**/*.test.ts\"]` - Excludes test files from documentation\n- `excludePrivate`: `true` - Excludes private members from documentation\n- `disableSource`: `true` - Disable links to source (to ensure deterministic build)\n\n## Configuration\n\nCustomize TypeDoc configuration:\n\n```typescript\nimport { EntryPointStrategy, TypeDoc } from \"@nikovirtala/projen-typedoc\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n  name: \"my-project\",\n  defaultReleaseBranch: \"main\",\n});\n\nnew TypeDoc(project, {\n  version: \"^0.28\",\n  typeDocConfig: {\n    entryPointStrategy: EntryPointStrategy.EXPAND,\n    out: \"docs/api\",\n    exclude: [\"**/*.test.ts\"],\n    excludePrivate: true,\n    name: \"My Project\",\n    theme: \"default\",\n  },\n});\n\nproject.synth();\n```\n\n## Features\n\n- Automatically installs TypeDoc as a dev dependency\n- Creates `typedoc.jsonc` configuration file\n- Adds `typedoc` task to generate documentation\n- Supports all TypeDoc configuration options\n\n## Tasks\n\nThe component creates the following task:\n\n- `typedoc` - Generate TypeDoc documentation\n\n## License\n\nMIT\n"
   },
   "repository": {
     "type": "git",
@@ -110,7 +110,7 @@
     "@nikovirtala/projen-typedoc.CommentStyle": {
       "assembly": "@nikovirtala/projen-typedoc",
       "docs": {
-        "see": "https://typedoc.org/options/comments/#commentstyle",
+        "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
         "stability": "stable",
         "summary": "Specifies the documentation mode TypeDoc should use."
       },
@@ -152,7 +152,7 @@
     "@nikovirtala/projen-typedoc.EntryPointStrategy": {
       "assembly": "@nikovirtala/projen-typedoc",
       "docs": {
-        "see": "https://typedoc.org/options/input/#entrypointstrategy",
+        "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
         "stability": "stable",
         "summary": "Specifies the strategy to be used to convert entry points into documentation."
       },
@@ -198,7 +198,7 @@
     "@nikovirtala/projen-typedoc.LogLevel": {
       "assembly": "@nikovirtala/projen-typedoc",
       "docs": {
-        "see": "https://typedoc.org/options/other/#loglevel",
+        "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
         "stability": "stable",
         "summary": "Specifies the logger that should be used."
       },
@@ -257,7 +257,7 @@
         },
         "locationInModule": {
           "filename": "src/index.ts",
-          "line": 56
+          "line": 57
         },
         "parameters": [
           {
@@ -278,7 +278,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 38
+        "line": 39
       },
       "methods": [
         {
@@ -287,7 +287,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 39
+            "line": 40
           },
           "name": "of",
           "parameters": [
@@ -317,7 +317,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 54
+            "line": 55
           },
           "name": "file",
           "type": {
@@ -332,7 +332,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 49
+            "line": 50
           },
           "name": "task",
           "type": {
@@ -361,7 +361,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#basepath",
+            "see": "https://typedoc.org/documents/Options.Output.html#basepath",
             "stability": "stable",
             "summary": "Specify the base path for all urls."
           },
@@ -379,9 +379,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Output.html#cachebust",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Include the generation time in links to prevent browsers from using a cached version."
           },
           "immutable": true,
           "locationInModule": {
@@ -397,7 +397,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#categorizebygroup",
+            "see": "https://typedoc.org/documents/Options.Organization.html#categorizebygroup",
             "stability": "stable",
             "summary": "Specify the categories that will be used to group reflections."
           },
@@ -415,7 +415,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#cleanoutputdir",
+            "see": "https://typedoc.org/documents/Options.Output.html#cleanoutputdir",
             "stability": "stable",
             "summary": "Prevent TypeDoc from cleaning the output directory specified with --out."
           },
@@ -433,7 +433,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#commentstyle",
+            "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
             "stability": "stable",
             "summary": "Specify the documentation mode TypeDoc should use."
           },
@@ -451,7 +451,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#defaultcategory",
+            "see": "https://typedoc.org/documents/Options.Organization.html#defaultcategory",
             "stability": "stable",
             "summary": "Specify the default category for reflections without a category."
           },
@@ -469,7 +469,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#defaultgroup",
+            "see": "https://typedoc.org/documents/Options.Organization.html#defaultgroup",
             "stability": "stable",
             "summary": "Specify the default group for reflections without a group."
           },
@@ -487,7 +487,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#defaultvisibility",
+            "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
             "stability": "stable",
             "summary": "Specify the default visibility for members without a visibility tag."
           },
@@ -505,9 +505,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Comments.html#disablegit",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Disables setting the source of reflections when documenting projects within a Git repository."
           },
           "immutable": true,
           "locationInModule": {
@@ -523,9 +523,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Comments.html#disablesources",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Disables automatically linking to source code."
           },
           "immutable": true,
           "locationInModule": {
@@ -541,7 +541,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#entrypoints",
+            "see": "https://typedoc.org/documents/Options.Input.html#entrypoints",
             "stability": "stable",
             "summary": "Specifies the entry points to be documented by TypeDoc."
           },
@@ -564,7 +564,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#entrypointstrategy",
+            "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
             "stability": "stable",
             "summary": "Specifies the strategy to be used to convert entry points into documentation."
           },
@@ -582,7 +582,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#exclude",
+            "see": "https://typedoc.org/documents/Options.Input.html#exclude",
             "stability": "stable",
             "summary": "Define patterns to be excluded when expanding directories."
           },
@@ -605,7 +605,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#excludeexternals",
+            "see": "https://typedoc.org/documents/Options.Input.html#excludeexternals",
             "stability": "stable",
             "summary": "Prevent externally resolved symbols from being documented."
           },
@@ -623,7 +623,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#excludeinternal",
+            "see": "https://typedoc.org/documents/Options.Input.html#excludeinternal",
             "stability": "stable",
             "summary": "Prevent symbols that are not exported from being documented."
           },
@@ -641,7 +641,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#excludeprivate",
+            "see": "https://typedoc.org/documents/Options.Input.html#excludeprivate",
             "stability": "stable",
             "summary": "Prevent private members from being included in the generated documentation."
           },
@@ -659,7 +659,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#excludeprotected",
+            "see": "https://typedoc.org/documents/Options.Input.html#excludeprotected",
             "stability": "stable",
             "summary": "Prevent protected members from being included in the generated documentation."
           },
@@ -677,9 +677,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Input.html#externalpattern",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Define patterns for files that should be considered external."
           },
           "immutable": true,
           "locationInModule": {
@@ -700,9 +700,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Define custom mappings for symbols in external packages."
           },
           "immutable": true,
           "locationInModule": {
@@ -728,7 +728,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#gitremote",
+            "see": "https://typedoc.org/documents/Options.Comments.html#gitremote",
             "stability": "stable",
             "summary": "Specify the git remote that should be used to link to source files."
           },
@@ -746,7 +746,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#gitrevision",
+            "see": "https://typedoc.org/documents/Options.Comments.html#gitrevision",
             "stability": "stable",
             "summary": "Specify the git revision that should be used to link to source files."
           },
@@ -764,9 +764,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Output.html#hidegenerator",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Do not print the TypeDoc link at the end of the page."
           },
           "immutable": true,
           "locationInModule": {
@@ -782,9 +782,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Hide parameter types in the signature."
           },
           "immutable": true,
           "locationInModule": {
@@ -800,7 +800,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#includes",
+            "see": "https://typedoc.org/documents/Options.Output.html#includes",
             "stability": "stable",
             "summary": "Specify the location to look for included documents."
           },
@@ -818,9 +818,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Validation.html#intentionallynotexported",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "A list of types that should not produce warnings when not being exported."
           },
           "immutable": true,
           "locationInModule": {
@@ -841,7 +841,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#json",
+            "see": "https://typedoc.org/documents/Options.Output.html#json",
             "stability": "stable",
             "summary": "Specify the location the documentation should be written to."
           },
@@ -859,7 +859,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/other/#loglevel",
+            "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
             "stability": "stable",
             "summary": "Specify the logger that should be used."
           },
@@ -877,7 +877,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#media",
+            "see": "https://typedoc.org/documents/Options.Output.html#media",
             "stability": "stable",
             "summary": "Specify the location with media files that should be copied to the output directory."
           },
@@ -895,7 +895,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#name",
+            "see": "https://typedoc.org/documents/Options.Output.html#name",
             "stability": "stable",
             "summary": "Set the name of the project that will be used in the header of the template."
           },
@@ -913,7 +913,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#out",
+            "see": "https://typedoc.org/documents/Options.Output.html#out",
             "stability": "stable",
             "summary": "Specifies the output directory the documentation should be written to."
           },
@@ -931,7 +931,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#packagejson",
+            "see": "https://typedoc.org/documents/Options.Input.html#packagejson",
             "stability": "stable",
             "summary": "Specify the package.json file that should be used to determine the package name."
           },
@@ -949,7 +949,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#readme",
+            "see": "https://typedoc.org/documents/Options.Input.html#readme",
             "stability": "stable",
             "summary": "Specify the readme file that should be displayed on the index page."
           },
@@ -967,9 +967,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Specify the type of reflections that must be documented."
           },
           "immutable": true,
           "locationInModule": {
@@ -990,7 +990,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#searchcategoryboosts",
+            "see": "https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts",
             "stability": "stable",
             "summary": "Specify the search category boosts."
           },
@@ -1013,7 +1013,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#searchgroupboosts",
+            "see": "https://typedoc.org/documents/Options.Organization.html#searchgroupboosts",
             "stability": "stable",
             "summary": "Specify the search group boosts."
           },
@@ -1036,9 +1036,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Output.html#searchincomments",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "If set, the search index will also include comments."
           },
           "immutable": true,
           "locationInModule": {
@@ -1054,9 +1054,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Output.html#searchindocuments",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "If set, the search index will also include documents."
           },
           "immutable": true,
           "locationInModule": {
@@ -1072,7 +1072,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#sort",
+            "see": "https://typedoc.org/documents/Options.Organization.html#sort",
             "stability": "stable",
             "summary": "Specify the sort strategy for documented values."
           },
@@ -1095,7 +1095,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/organization/#sortentrypoints",
+            "see": "https://typedoc.org/documents/Options.Organization.html#sortentrypoints",
             "stability": "stable",
             "summary": "Specify the sort strategy for static and instance members."
           },
@@ -1113,16 +1113,16 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Input.html#sourcelinktemplate",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Specify a link template to be used when generating source urls."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/typedoc-config.ts",
             "line": 229
           },
-          "name": "sourceUrlTemplate",
+          "name": "sourceLinkTemplate",
           "optional": true,
           "type": {
             "primitive": "string"
@@ -1131,7 +1131,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/output/#theme",
+            "see": "https://typedoc.org/documents/Options.Output.html#theme",
             "stability": "stable",
             "summary": "Specify a theme name to use."
           },
@@ -1149,9 +1149,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "If set, validation warnings will be treated as errors."
           },
           "immutable": true,
           "locationInModule": {
@@ -1167,9 +1167,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "If set, warnings will be treated as errors."
           },
           "immutable": true,
           "locationInModule": {
@@ -1185,7 +1185,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#tsbuildinfo",
+            "see": "https://typedoc.org/documents/Options.Input.html#tsbuildinfo",
             "stability": "stable",
             "summary": "Specify the location and filename a .tsbuildinfo file should be written to."
           },
@@ -1203,7 +1203,7 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/input/#tsconfig",
+            "see": "https://typedoc.org/documents/Options.Input.html#tsconfig",
             "stability": "stable",
             "summary": "Specify a TypeScript config file that should be used to load TypeScript configuration."
           },
@@ -1221,9 +1221,9 @@
         {
           "abstract": true,
           "docs": {
-            "see": "https://typedoc.org/options/comments/#sourceurltemplate",
+            "see": "https://typedoc.org/documents/Options.Validation.html",
             "stability": "stable",
-            "summary": "Specify the base URL for links to source files."
+            "summary": "Specify validation options."
           },
           "immutable": true,
           "locationInModule": {
@@ -1249,7 +1249,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 19
+        "line": 20
       },
       "name": "TypeDocOptions",
       "properties": [
@@ -1263,7 +1263,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 32
+            "line": 33
           },
           "name": "typeDocConfig",
           "optional": true,
@@ -1281,7 +1281,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 25
+            "line": 26
           },
           "name": "version",
           "optional": true,
@@ -1296,7 +1296,7 @@
       "assembly": "@nikovirtala/projen-typedoc",
       "datatype": true,
       "docs": {
-        "see": "https://typedoc.org/options/validation/",
+        "see": "https://typedoc.org/documents/Options.Validation.html",
         "stability": "stable",
         "summary": "Validation options."
       },
@@ -1365,7 +1365,7 @@
     "@nikovirtala/projen-typedoc.Visibility": {
       "assembly": "@nikovirtala/projen-typedoc",
       "docs": {
-        "see": "https://typedoc.org/options/comments/#defaultvisibility",
+        "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
         "stability": "stable",
         "summary": "Specifies the default visibility for members without a visibility tag."
       },
@@ -1399,6 +1399,6 @@
       "symbolId": "src/typedoc-config:Visibility"
     }
   },
-  "version": "0.0.0",
-  "fingerprint": "54AHwE5ru6OF/iNSpTumtk0ui3DFT+4OjZz41wFIQ7E="
+  "version": "1.0.0",
+  "fingerprint": "gF/hkkg+PBvOLIn5GdBwa50LedtT29zG20o2LCLZ2go="
 }