refactor: add zod2md-nx-plugin

Author: John Doe

nx.json

@@ -337,6 +337,7 @@
     "releaseTagPattern": "v{version}"
   },
   "plugins": [
+    "./tools/zod2md-nx-plugin/src/lib/plugin.js",
     {
       "plugin": "@push-based/nx-verdaccio",
       "options": {

packages/models/project.json

@@ -4,19 +4,6 @@
   "sourceRoot": "packages/models/src",
   "projectType": "library",
   "targets": {
-    "generate-docs": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": [
-          "zod2md --config {projectRoot}/zod2md.config.ts",
-          "prettier --write {projectRoot}/docs/models-reference.md"
-        ],
-        "parallel": false
-      },
-      "cache": true,
-      "inputs": ["production", "^production", "{projectRoot}/zod2md.config.ts"],
-      "outputs": ["{projectRoot}/docs/models-reference.md"]
-    },
     "build": {
       "dependsOn": [
         "^build",

tools/zod2md-nx-plugin/README.md

@@ -0,0 +1,40 @@
+# @code-pushup/zod2md-nx-plugin
+
+[![npm](https://img.shields.io/npm/v/%40code-pushup%2Futils.svg)](https://www.npmjs.com/package/@code-pushup/zod2md-nx-plugin)
+[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Futils)](https://npmtrends.com/@code-pushup/zod2md-nx-plugin)
+[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/utils)](https://www.npmjs.com/package/@code-pushup/zod2md-nx-plugin?activeTab=dependencies)
+
+Low-level **utilities** (helper functions, etc.) used by [Code PushUp CLI](../cli/README.md).
+
+## Setup
+
+If you've already installed another `@code-pushup/*` package, then you may have already installed `@code-pushup/zod2md-nx-plugin` indirectly.
+
+If not, you can always install it separately:
+
+```sh
+npm install --save-dev @code-pushup/zod2md-nx-plugin
+```
+
+```sh
+yarn add --dev @code-pushup/zod2md-nx-plugin
+```
+
+```sh
+pnpm add --save-dev @code-pushup/zod2md-nx-plugin
+```
+
+## Usage
+
+```ts
+import { executeProcess, readJsonFile, slugify } from '@code-pushup/zod2md-nx-plugin';
+
+await executeProcess({
+  command: 'npx',
+  args: ['eslint', '--format=json', '--output-file=output.json', '**/*.js'],
+});
+
+const data = await readJsonFile('output.json');
+
+const slug = slugify('Hello, world!'); // "hello-world"
+```

tools/zod2md-nx-plugin/eslint.config.js

@@ -0,0 +1,21 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(
+  ...baseConfig,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': ['error', { ignoredDependencies: [] }],
+    },
+  },
+);

tools/zod2md-nx-plugin/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@code-pushup/zod2md-nx-plugin",
+  "version": "0.0.0",
+  "license": "MIT",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/tools/zod2md-nx-plugin#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=17.0.0"
+  },
+  "dependencies": {
+    "@code-pushup/models": "0.92.0",
+    "ansis": "^3.3.0",
+    "build-md": "^0.4.2",
+    "bundle-require": "^5.1.0",
+    "esbuild": "^0.25.2",
+    "ora": "^9.0.0",
+    "semver": "^7.6.0",
+    "simple-git": "^3.20.0",
+    "string-width": "^8.1.0",
+    "wrap-ansi": "^9.0.2",
+    "zod": "^4.0.5"
+  },
+  "files": [
+    "src",
+    "!**/*.tsbuildinfo"
+  ]
+}

tools/zod2md-nx-plugin/project.json

@@ -0,0 +1,10 @@
+{
+  "name": "zod2md-nx-plugin",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "tools/zod2md-nx-plugin/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {}
+  },
+  "tags": ["scope:shared", "type:util", "publishable"]
+}

tools/zod2md-nx-plugin/src/lib/plugin.js

@@ -0,0 +1,48 @@
+import { dirname } from 'node:path';
+
+export const createNodesV2 = [
+  `**/zod2md.config.ts`,
+  async (zod2MdConfigurationFiles, createNodesOptions, context) => {
+    return Promise.all(
+      zod2MdConfigurationFiles.map(async zod2MdConfigurationFile => {
+        const projectRoot = dirname(zod2MdConfigurationFile);
+        const normalizedProjectRoot = projectRoot === '.' ? '' : projectRoot;
+        const result = {
+          projects: {
+            [normalizedProjectRoot]: {
+              targets: {
+                'generate-docs': {
+                  executor: 'nx:run-commands',
+                  options: {
+                    commands: [
+                      'zod2md --config {projectRoot}/zod2md.config.ts',
+                      'prettier --write {projectRoot}/docs/{projectName}-reference.md',
+                    ],
+                    parallel: false,
+                  },
+                  cache: true,
+                  inputs: [
+                    'production',
+                    '^production',
+                    '{projectRoot}/zod2md.config.ts',
+                  ],
+                  outputs: ['{projectRoot}/docs/{projectName}-reference.md'],
+                },
+              },
+            },
+          },
+        };
+
+        return [zod2MdConfigurationFile, result];
+      }),
+    );
+  },
+];
+
+// default export for nx.json#plugins
+const plugin = {
+  name: 'zod2md-nx-plugin',
+  createNodesV2,
+};
+
+export default plugin;

tsconfig.base.json

@@ -47,7 +47,8 @@
       "@code-pushup/typescript-plugin": [
         "packages/plugin-typescript/src/index.ts"
       ],
-      "@code-pushup/utils": ["packages/utils/src/index.ts"]
+      "@code-pushup/utils": ["packages/utils/src/index.ts"],
+      "@code-pushup/zod2md-nx-plugin": ["tools/zod2md-nx-plugin/src/index.ts"]
     }
   },
   "exclude": ["node_modules", "tmp"]