chore: fix documentation generation, fail on warnings

Author: mdevils

docs/interfaces/openapi_client.OpenApiClientGeneratorConfigClient.md

@@ -123,7 +123,7 @@ ___
 
 ### generateErrorJsDoc
 
-• `Optional` **generateErrorJsDoc**: `GenerateClientErrorJsDoc`
+• `Optional` **generateErrorJsDoc**: [`GenerateClientErrorJsDoc`](../modules/openapi_client.md#generateclienterrorjsdoc)
 
 Client error class JSDoc generation callback.
 

docs/modules/openapi_client.md

@@ -36,6 +36,7 @@
 - [CommonHttpClientFetchResponseBody](openapi_client.md#commonhttpclientfetchresponsebody)
 - [CommonHttpClientRequest](openapi_client.md#commonhttpclientrequest)
 - [CommonHttpClientResponseHeaders](openapi_client.md#commonhttpclientresponseheaders)
+- [GenerateClientErrorJsDoc](openapi_client.md#generateclienterrorjsdoc)
 - [GenerateClientJsDoc](openapi_client.md#generateclientjsdoc)
 - [GenerateModelJsDoc](openapi_client.md#generatemodeljsdoc)
 - [GenerateModelNameCallback](openapi_client.md#generatemodelnamecallback)
@@ -74,6 +75,41 @@ ___
 
 ___
 
+### GenerateClientErrorJsDoc
+
+Ƭ **GenerateClientErrorJsDoc**: (`params`: \{ `info`: [`OpenApiInfo`](../interfaces/openapi.OpenApiInfo.md) ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md)  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+#### Type declaration
+
+▸ (`params`): [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+Callback for generating the JSDoc of a client.
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | - |
+| `params.info` | [`OpenApiInfo`](../interfaces/openapi.OpenApiInfo.md) | OpenAPI Info Object. |
+| `params.suggestedJsDoc` | [`JsDocBlock`](../interfaces/index.JsDocBlock.md) | Suggested JSDoc block. Used by default if the callback is not specified. |
+
+##### Returns
+
+[`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+**`Example`**
+
+```ts
+function generateClientErrorJsDoc({suggestedJsDoc, info}) {
+        return {
+            ...suggestedJsDoc,
+            title: 'Error Class for ' + info.summary
+        };
+    }
+```
+
+___
+
 ### GenerateClientJsDoc
 
 Ƭ **GenerateClientJsDoc**: (`params`: \{ `info`: [`OpenApiInfo`](../interfaces/openapi.OpenApiInfo.md) ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md)  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)

package.json

@@ -39,7 +39,7 @@
   "scripts": {
     "precheck": "tsc --noEmit && jest && ",
     "build": "rimraf lib && tsc -p tsconfig.build.json && cp -R src/schema-to-typescript/common/core/* lib/schema-to-typescript/common/core && cp -R src/schema-to-typescript/common/validation-providers/zod-validation-provider/*-*.ts lib/schema-to-typescript/common/validation-providers/zod-validation-provider",
-    "build:docs": "rm -Rf docs && typedoc --exclude test --excludeInternal --excludeExternals --disableSources --plugin typedoc-plugin-markdown --entryDocument ../README.md --out docs src/index.ts src/openapi.ts src/openapi-client.ts && ts-node tools/cleanup-docs.ts",
+    "build:docs": "rm -Rf docs && typedoc && ts-node tools/cleanup-docs.ts",
     "prepublishOnly": "npm run build",
     "lint": "eslint {src,test,tools}/**/*.ts",
     "lint:fix": "eslint --fix {src,test,tools}/**/*.ts",

src/openapi-client.ts

@@ -12,6 +12,7 @@ export type {
     GenerateOperationResultDescription,
     GenerateServiceJsDoc,
     GenerateClientJsDoc,
+    GenerateClientErrorJsDoc,
     OpenApiClientBuiltinBinaryType,
     OpenApiClientCustomizableBinaryType,
     OpenApiClientExternalType,

typedoc.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "plugin": [
+    "typedoc-plugin-markdown"
+  ],
+  "entryPoints": ["src/index.ts", "src/openapi.ts", "src/openapi-client.ts"],
+  "exclude": ["test"],
+  "excludeExternals": true,
+  "excludeInternal": true,
+  "disableSources": true,
+  "entryDocument": "../README.md",
+  "out": "docs",
+  "treatWarningsAsErrors": true
+}