chore: move transformers to new project (#1163)

This PR moves the transformer logic into tools and makes it configurable

Followup PR: #1162

---------

Co-authored-by: John Doe <john.doe@example.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Author: 3 people

packages/models/project.json

@@ -21,7 +21,7 @@
       "dependsOn": [
         "^build",
         "generate-docs",
-        { "projects": "models-transformers", "target": "build" }
+        { "projects": "zod2md-jsdocs", "target": "build" }
       ]
     },
     "lint": {},

packages/models/tsconfig.lib.json

@@ -6,8 +6,9 @@
     "types": ["node"],
     "plugins": [
       {
-        "transform": "./packages/models/transformers/dist",
-        "afterDeclarations": true
+        "transform": "./tools/zod2md-jsdocs/dist",
+        "afterDeclarations": true,
+        "baseUrl": "https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md"
       }
     ]
   },

tools/zod2md-jsdocs/README.md

@@ -0,0 +1,71 @@
+# @code-pushup/zod2md-jsdocs
+
+TypeScript transformer plugin that automatically enhances type definitions with JSDoc comments and schema metadata.
+
+## Purpose
+
+This package provides a TypeScript compiler transformer that automatically adds JSDoc documentation to type aliases and interfaces during compilation. It's designed to improve developer experience by injecting helpful metadata and documentation links directly into generated type definitions.
+
+## How It Works
+
+The [TS transformer](https://github.com/itsdouges/typescript-transformer-handbook) hooks into the TypeScript compilation process using `ts-patch` and automatically adds JSDoc comments above type definitions. Each comment includes:
+
+- The type name
+- A description explaining the type is derived from a Zod schema
+- A link to the type reference documentation
+
+## Example
+
+Given a type definition like:
+
+```typescript
+export type Report = {
+  // ... type properties
+};
+```
+
+The transformer automatically generates:
+
+```typescript
+/**
+ * Type Definition: `Report`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Report` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#report}
+ */
+export type Report = {
+  // ... type properties
+};
+```
+
+## Usage
+
+1. `ts-patch install`
+
+2. Add the transformer to your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "transform": "./path/to/transformer/dist",
+        "afterDeclarations": true,
+        "baseUrl": "https://example.com/docs/api-reference.md"
+      }
+    ]
+  }
+}
+```
+
+3. Build your TypeScript project. The transformer will run automatically and add JSDoc comments to your type definitions.
+
+### Options
+
+| Option              | Type      | Required | Description                                                                                                                                                         |
+| ------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transform`         | `string`  | Yes      | Path to the transformer module                                                                                                                                      |
+| `afterDeclarations` | `boolean` | No       | Set to `true` to run the transformer after TypeScript generates declaration files (`.d.ts`). This ensures JSDoc comments are added to the emitted type definitions. |
+| `baseUrl`           | `string`  | Yes      | Base URL for documentation links (e.g., `https://example.com/docs/api-reference.md`)                                                                                |

packages/models/transformers/eslint.config.cjs renamed to tools/zod2md-jsdocs/eslint.config.cjs

@@ -1,4 +1,4 @@
-const baseConfig = require('../../../eslint.config.js').default;
+const baseConfig = require('../../eslint.config.js').default;
 
 module.exports = [
   ...baseConfig,

packages/models/transformers/package.json renamed to tools/zod2md-jsdocs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@code-pushup/models-transformers",
+  "name": "@code-pushup/zod2md-jsdocs",
   "version": "0.0.0",
   "description": "TypeScript transformers enhancing models with JSDoc and schema metadata",
   "type": "commonjs",

packages/models/transformers/project.json renamed to tools/zod2md-jsdocs/project.json

@@ -1,17 +1,17 @@
 {
-  "name": "models-transformers",
-  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/models/transformers/src",
+  "name": "zod2md-jsdocs",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "tools/zod2md-jsdocs/src",
   "projectType": "library",
   "targets": {
     "build": {
       "executor": "@nx/js:tsc",
       "outputs": ["{options.outputPath}"],
       "dependsOn": ["pre-build"],
       "options": {
-        "outputPath": "packages/models/transformers/dist",
-        "main": "packages/models/transformers/src/index.ts",
-        "tsConfig": "packages/models/transformers/tsconfig.lib.json"
+        "outputPath": "tools/zod2md-jsdocs/dist",
+        "main": "tools/zod2md-jsdocs/src/index.ts",
+        "tsConfig": "tools/zod2md-jsdocs/tsconfig.lib.json"
       }
     },
     "pre-build": {

packages/models/transformers/src/index.ts renamed to tools/zod2md-jsdocs/src/index.ts

@@ -3,34 +3,39 @@ import type * as ts from 'typescript';
 
 const tsInstance: typeof ts = require('typescript');
 
-const BASE_URL =
-  'https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md';
-
-function generateJSDocComment(typeName: string): string {
-  const markdownLink = `${BASE_URL}#${typeName.toLowerCase()}`;
+function generateJSDocComment(typeName: string, baseUrl: string): string {
+  const markdownLink = `${baseUrl}#${typeName.toLowerCase()}`;
   return `*
  * Type Definition: \`${typeName}\`
- * 
- * This type is derived from a Zod schema and represents 
+ *
+ * This type is derived from a Zod schema and represents
  * the validated structure of \`${typeName}\` used within the application.
- * 
+ *
  * @see {@link ${markdownLink}}
  `;
 }
 
 function annotateTypeDefinitions(
   _program: ts.Program,
-  _pluginConfig: PluginConfig,
+  pluginConfig: PluginConfig,
   extras?: TransformerExtras,
 ): ts.TransformerFactory<ts.SourceFile> {
+  const baseUrl = pluginConfig.baseUrl as string | undefined;
+
+  if (!baseUrl) {
+    throw new Error(
+      'zod2md-jsdocs: "baseUrl" option is required. ' +
+        'Please configure it in your tsconfig.json plugins section.',
+    );
+  }
   const tsLib = extras?.ts ?? tsInstance;
   return (context: ts.TransformationContext) => {
     const visitor = (node: ts.Node): ts.Node => {
       if (
         tsLib.isTypeAliasDeclaration(node) ||
         tsLib.isInterfaceDeclaration(node)
       ) {
-        const jsDocComment = generateJSDocComment(node.name.text);
+        const jsDocComment = generateJSDocComment(node.name.text, baseUrl);
         tsLib.addSyntheticLeadingComment(
           node,
           tsLib.SyntaxKind.MultiLineCommentTrivia,

packages/models/transformers/src/lib/transformers.ts renamed to tools/zod2md-jsdocs/src/lib/transformers.ts

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "module": "commonjs",
     "verbatimModuleSyntax": false

packages/models/transformers/tsconfig.json renamed to tools/zod2md-jsdocs/tsconfig.json

@@ -4,7 +4,8 @@
     "outDir": "./dist",
     "rootDir": "./",
     "module": "commonjs",
-    "types": ["node"]
+    "types": ["node"],
+    "esModuleInterop": true
   },
   "include": ["src/**/*.ts"]
 }