ci(models): add generated models to docs (#441)

Author: BioPhoton

examples/plugins/project.json

@@ -43,23 +43,32 @@
       "dependsOn": [
         "build",
         "^build",
-        { "projects": ["cli"], "target": "build" }
+        {
+          "projects": ["cli"],
+          "target": "build"
+        }
       ]
     },
     "run-print-config": {
       "command": "npx dist/packages/cli print-config --config=examples/plugins/code-pushup.config.ts",
       "dependsOn": [
         "build",
         "^build",
-        { "projects": ["cli"], "target": "build" }
+        {
+          "projects": ["cli"],
+          "target": "build"
+        }
       ]
     },
     "run-help": {
       "command": "npx dist/packages/cli help",
       "dependsOn": [
         "build",
         "^build",
-        { "projects": ["cli"], "target": "build" }
+        {
+          "projects": ["cli"],
+          "target": "build"
+        }
       ]
     }
   },

nx.json

@@ -49,6 +49,7 @@
       "!{projectRoot}/vite.config.@(unit|integration|e2e).[jt]s",
       "!{projectRoot}/@(test|mocks)/**/*",
       "!{projectRoot}/perf/**/*",
+      "!{projectRoot}/tools/**/*",
       "!{projectRoot}/code-pushup.config.?(m)[jt]s"
     ],
     "sharedGlobals": []

package-lock.json

@@ -123,7 +123,8 @@
     "typescript": "5.2.2",
     "verdaccio": "^5.0.4",
     "vite": "~4.3.9",
-    "vitest": "~0.32.0"
+    "vitest": "~0.32.0",
+    "zod-to-ts": "^1.2.0"
   },
   "optionalDependencies": {
     "@esbuild/darwin-arm64": "^0.19.4",

package.json

@@ -26,13 +26,13 @@ export default {
 
 ## Plugin Structure
 
-Every plugin is defined in [`PluginConfig`](@TODO - link models) object.
+Every plugin is defined in [`PluginConfig`](../../models/docs/core-config-types.md) object.
 
 The plugin configuration contains:
 
-- metadata about the plugin [`PluginMeta`](@TODO - link models)
-- metadata about the available [audit](#audits) [`Audit`](@TODO - link models)
-- a [runner](#plugin-runner) that maintains the internal logic that produces the [plugin output](#plugin-output) as [`AuditOutputs`](@TODO - link models).
+- metadata about the plugin [`PluginMeta`](../../models/docs/core-config-types.md)
+- metadata about the available [audit](#audits) [`Audit`](../../models/docs/core-config-types.md)
+- a [runner](#plugin-runner) that maintains the internal logic that produces the [plugin output](#plugin-output) as [`AuditOutputs`](../../models/docs/core-config-types.md).
 - optional [`groups`](#audit-groups) to pre score audits
 
 See the following example that shows a minimal implementation of a custom plugin containing all required fields:
@@ -121,7 +121,7 @@ const myAuditOutput: AuditOutput = {
 };
 ```
 
-- An audit output always includes the metadata of the audit. [`Audit`](@TODO - link models)
+- An audit output always includes the metadata of the audit. [`Audit`](../../models/docs/core-config-types.md)
 
 - `score` and `value` are important to calculate a score from a given metric and display it.
   Here you can read more about [audits and scoring](#audit-score).
@@ -140,7 +140,7 @@ const pluginOutput: AuditOutputs = [myAuditOutput];
 ## Plugin runner
 
 The `runner` property defines the core of a plugin.
-It also serves as the entry point of your plugin and is executed by the CLI. It should return the audit results as [`AuditOutputs`](@TODO - link models).
+It also serves as the entry point of your plugin and is executed by the CLI. It should return the audit results as [`AuditOutputs`](../../models/docs/core-config-types.md).
 
 A runner can be implemented in two ways:
 

packages/cli/docs/custom-plugins.md

@@ -1,6 +1,6 @@
 {
   "extends": ["../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
+  "ignorePatterns": ["!**/*", "**/tools/**/*.ts", "*.generated.ts"],
   "overrides": [
     {
       "files": ["*.ts", "*.tsx"],